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
@@ -201,6 +201,27 @@ module Aws::QuickSight
|
|
201
201
|
include Aws::Structure
|
202
202
|
end
|
203
203
|
|
204
|
+
# The display options for tile borders for visuals.
|
205
|
+
#
|
206
|
+
# @note When making an API call, you may pass BorderStyle
|
207
|
+
# data as a hash:
|
208
|
+
#
|
209
|
+
# {
|
210
|
+
# show: false,
|
211
|
+
# }
|
212
|
+
#
|
213
|
+
# @!attribute [rw] show
|
214
|
+
# The option to enable display of borders for visuals.
|
215
|
+
# @return [Boolean]
|
216
|
+
#
|
217
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/BorderStyle AWS API Documentation
|
218
|
+
#
|
219
|
+
class BorderStyle < Struct.new(
|
220
|
+
:show)
|
221
|
+
SENSITIVE = []
|
222
|
+
include Aws::Structure
|
223
|
+
end
|
224
|
+
|
204
225
|
# A calculated column for a dataset.
|
205
226
|
#
|
206
227
|
# @note When making an API call, you may pass CalculatedColumn
|
@@ -570,6 +591,7 @@ module Aws::QuickSight
|
|
570
591
|
# visibility_state: "EXPANDED", # accepts EXPANDED, COLLAPSED
|
571
592
|
# },
|
572
593
|
# },
|
594
|
+
# theme_arn: "Arn",
|
573
595
|
# }
|
574
596
|
#
|
575
597
|
# @!attribute [rw] aws_account_id
|
@@ -585,8 +607,8 @@ module Aws::QuickSight
|
|
585
607
|
# @return [String]
|
586
608
|
#
|
587
609
|
# @!attribute [rw] parameters
|
588
|
-
#
|
589
|
-
#
|
610
|
+
# The parameters for the creation of the dashboard, which you want to
|
611
|
+
# use to override the default settings. A dashboard can have any type
|
590
612
|
# of parameters, and some parameters might accept multiple values.
|
591
613
|
# @return [Types::Parameters]
|
592
614
|
#
|
@@ -640,6 +662,13 @@ module Aws::QuickSight
|
|
640
662
|
# `COLLAPSED` by default.
|
641
663
|
# @return [Types::DashboardPublishOptions]
|
642
664
|
#
|
665
|
+
# @!attribute [rw] theme_arn
|
666
|
+
# The Amazon Resource Name (ARN) of the theme that is being used for
|
667
|
+
# this dashboard. If you add a value for this field, it overrides the
|
668
|
+
# value that is used in the source entity. The theme ARN must exist in
|
669
|
+
# the same AWS account where you create the dashboard.
|
670
|
+
# @return [String]
|
671
|
+
#
|
643
672
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateDashboardRequest AWS API Documentation
|
644
673
|
#
|
645
674
|
class CreateDashboardRequest < Struct.new(
|
@@ -651,13 +680,14 @@ module Aws::QuickSight
|
|
651
680
|
:source_entity,
|
652
681
|
:tags,
|
653
682
|
:version_description,
|
654
|
-
:dashboard_publish_options
|
683
|
+
:dashboard_publish_options,
|
684
|
+
:theme_arn)
|
655
685
|
SENSITIVE = []
|
656
686
|
include Aws::Structure
|
657
687
|
end
|
658
688
|
|
659
689
|
# @!attribute [rw] arn
|
660
|
-
# The
|
690
|
+
# The ARN of the dashboard.
|
661
691
|
# @return [String]
|
662
692
|
#
|
663
693
|
# @!attribute [rw] version_arn
|
@@ -1738,6 +1768,224 @@ module Aws::QuickSight
|
|
1738
1768
|
include Aws::Structure
|
1739
1769
|
end
|
1740
1770
|
|
1771
|
+
# @note When making an API call, you may pass CreateThemeAliasRequest
|
1772
|
+
# data as a hash:
|
1773
|
+
#
|
1774
|
+
# {
|
1775
|
+
# aws_account_id: "AwsAccountId", # required
|
1776
|
+
# theme_id: "RestrictiveResourceId", # required
|
1777
|
+
# alias_name: "AliasName", # required
|
1778
|
+
# theme_version_number: 1, # required
|
1779
|
+
# }
|
1780
|
+
#
|
1781
|
+
# @!attribute [rw] aws_account_id
|
1782
|
+
# The ID of the AWS account that contains the theme for the new theme
|
1783
|
+
# alias.
|
1784
|
+
# @return [String]
|
1785
|
+
#
|
1786
|
+
# @!attribute [rw] theme_id
|
1787
|
+
# An ID for the theme alias.
|
1788
|
+
# @return [String]
|
1789
|
+
#
|
1790
|
+
# @!attribute [rw] alias_name
|
1791
|
+
# The name that you want to give to the theme alias that you are
|
1792
|
+
# creating. The alias name can't begin with a `$`. Alias names that
|
1793
|
+
# start with `$` are reserved by Amazon QuickSight.
|
1794
|
+
# @return [String]
|
1795
|
+
#
|
1796
|
+
# @!attribute [rw] theme_version_number
|
1797
|
+
# The version number of the theme.
|
1798
|
+
# @return [Integer]
|
1799
|
+
#
|
1800
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateThemeAliasRequest AWS API Documentation
|
1801
|
+
#
|
1802
|
+
class CreateThemeAliasRequest < Struct.new(
|
1803
|
+
:aws_account_id,
|
1804
|
+
:theme_id,
|
1805
|
+
:alias_name,
|
1806
|
+
:theme_version_number)
|
1807
|
+
SENSITIVE = []
|
1808
|
+
include Aws::Structure
|
1809
|
+
end
|
1810
|
+
|
1811
|
+
# @!attribute [rw] theme_alias
|
1812
|
+
# Information about the theme alias.
|
1813
|
+
# @return [Types::ThemeAlias]
|
1814
|
+
#
|
1815
|
+
# @!attribute [rw] status
|
1816
|
+
# The HTTP status of the request.
|
1817
|
+
# @return [Integer]
|
1818
|
+
#
|
1819
|
+
# @!attribute [rw] request_id
|
1820
|
+
# The AWS request ID for this operation.
|
1821
|
+
# @return [String]
|
1822
|
+
#
|
1823
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateThemeAliasResponse AWS API Documentation
|
1824
|
+
#
|
1825
|
+
class CreateThemeAliasResponse < Struct.new(
|
1826
|
+
:theme_alias,
|
1827
|
+
:status,
|
1828
|
+
:request_id)
|
1829
|
+
SENSITIVE = []
|
1830
|
+
include Aws::Structure
|
1831
|
+
end
|
1832
|
+
|
1833
|
+
# @note When making an API call, you may pass CreateThemeRequest
|
1834
|
+
# data as a hash:
|
1835
|
+
#
|
1836
|
+
# {
|
1837
|
+
# aws_account_id: "AwsAccountId", # required
|
1838
|
+
# theme_id: "RestrictiveResourceId", # required
|
1839
|
+
# name: "ThemeName", # required
|
1840
|
+
# base_theme_id: "RestrictiveResourceId", # required
|
1841
|
+
# version_description: "VersionDescription",
|
1842
|
+
# configuration: { # required
|
1843
|
+
# data_color_palette: {
|
1844
|
+
# colors: ["HexColor"],
|
1845
|
+
# min_max_gradient: ["HexColor"],
|
1846
|
+
# empty_fill_color: "HexColor",
|
1847
|
+
# },
|
1848
|
+
# ui_color_palette: {
|
1849
|
+
# primary_foreground: "HexColor",
|
1850
|
+
# primary_background: "HexColor",
|
1851
|
+
# secondary_foreground: "HexColor",
|
1852
|
+
# secondary_background: "HexColor",
|
1853
|
+
# accent: "HexColor",
|
1854
|
+
# accent_foreground: "HexColor",
|
1855
|
+
# danger: "HexColor",
|
1856
|
+
# danger_foreground: "HexColor",
|
1857
|
+
# warning: "HexColor",
|
1858
|
+
# warning_foreground: "HexColor",
|
1859
|
+
# success: "HexColor",
|
1860
|
+
# success_foreground: "HexColor",
|
1861
|
+
# dimension: "HexColor",
|
1862
|
+
# dimension_foreground: "HexColor",
|
1863
|
+
# measure: "HexColor",
|
1864
|
+
# measure_foreground: "HexColor",
|
1865
|
+
# },
|
1866
|
+
# sheet: {
|
1867
|
+
# tile: {
|
1868
|
+
# border: {
|
1869
|
+
# show: false,
|
1870
|
+
# },
|
1871
|
+
# },
|
1872
|
+
# tile_layout: {
|
1873
|
+
# gutter: {
|
1874
|
+
# show: false,
|
1875
|
+
# },
|
1876
|
+
# margin: {
|
1877
|
+
# show: false,
|
1878
|
+
# },
|
1879
|
+
# },
|
1880
|
+
# },
|
1881
|
+
# },
|
1882
|
+
# permissions: [
|
1883
|
+
# {
|
1884
|
+
# principal: "Principal", # required
|
1885
|
+
# actions: ["String"], # required
|
1886
|
+
# },
|
1887
|
+
# ],
|
1888
|
+
# tags: [
|
1889
|
+
# {
|
1890
|
+
# key: "TagKey", # required
|
1891
|
+
# value: "TagValue", # required
|
1892
|
+
# },
|
1893
|
+
# ],
|
1894
|
+
# }
|
1895
|
+
#
|
1896
|
+
# @!attribute [rw] aws_account_id
|
1897
|
+
# The ID of the AWS account where you want to store the new theme.
|
1898
|
+
# @return [String]
|
1899
|
+
#
|
1900
|
+
# @!attribute [rw] theme_id
|
1901
|
+
# An ID for the theme that you want to create. The theme ID is unique
|
1902
|
+
# per AWS Region in each AWS account.
|
1903
|
+
# @return [String]
|
1904
|
+
#
|
1905
|
+
# @!attribute [rw] name
|
1906
|
+
# A display name for the theme.
|
1907
|
+
# @return [String]
|
1908
|
+
#
|
1909
|
+
# @!attribute [rw] base_theme_id
|
1910
|
+
# The ID of the theme that a custom theme will inherit from. All
|
1911
|
+
# themes inherit from one of the starting themes defined by Amazon
|
1912
|
+
# QuickSight. For a list of the starting themes, use `ListThemes` or
|
1913
|
+
# choose **Themes** from within a QuickSight analysis.
|
1914
|
+
# @return [String]
|
1915
|
+
#
|
1916
|
+
# @!attribute [rw] version_description
|
1917
|
+
# A description of the first version of the theme that you're
|
1918
|
+
# creating. Every time `UpdateTheme` is called, a new version is
|
1919
|
+
# created. Each version of the theme has a description of the version
|
1920
|
+
# in the `VersionDescription` field.
|
1921
|
+
# @return [String]
|
1922
|
+
#
|
1923
|
+
# @!attribute [rw] configuration
|
1924
|
+
# The theme configuration, which contains the theme display
|
1925
|
+
# properties.
|
1926
|
+
# @return [Types::ThemeConfiguration]
|
1927
|
+
#
|
1928
|
+
# @!attribute [rw] permissions
|
1929
|
+
# A valid grouping of resource permissions to apply to the new theme.
|
1930
|
+
# @return [Array<Types::ResourcePermission>]
|
1931
|
+
#
|
1932
|
+
# @!attribute [rw] tags
|
1933
|
+
# A map of the key-value pairs for the resource tag or tags that you
|
1934
|
+
# want to add to the resource.
|
1935
|
+
# @return [Array<Types::Tag>]
|
1936
|
+
#
|
1937
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateThemeRequest AWS API Documentation
|
1938
|
+
#
|
1939
|
+
class CreateThemeRequest < Struct.new(
|
1940
|
+
:aws_account_id,
|
1941
|
+
:theme_id,
|
1942
|
+
:name,
|
1943
|
+
:base_theme_id,
|
1944
|
+
:version_description,
|
1945
|
+
:configuration,
|
1946
|
+
:permissions,
|
1947
|
+
:tags)
|
1948
|
+
SENSITIVE = []
|
1949
|
+
include Aws::Structure
|
1950
|
+
end
|
1951
|
+
|
1952
|
+
# @!attribute [rw] arn
|
1953
|
+
# The Amazon Resource Name (ARN) for the theme.
|
1954
|
+
# @return [String]
|
1955
|
+
#
|
1956
|
+
# @!attribute [rw] version_arn
|
1957
|
+
# The Amazon Resource Name (ARN) for the new theme.
|
1958
|
+
# @return [String]
|
1959
|
+
#
|
1960
|
+
# @!attribute [rw] theme_id
|
1961
|
+
# The ID of the theme.
|
1962
|
+
# @return [String]
|
1963
|
+
#
|
1964
|
+
# @!attribute [rw] creation_status
|
1965
|
+
# The theme creation status.
|
1966
|
+
# @return [String]
|
1967
|
+
#
|
1968
|
+
# @!attribute [rw] status
|
1969
|
+
# The HTTP status of the request.
|
1970
|
+
# @return [Integer]
|
1971
|
+
#
|
1972
|
+
# @!attribute [rw] request_id
|
1973
|
+
# The AWS request ID for this operation.
|
1974
|
+
# @return [String]
|
1975
|
+
#
|
1976
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateThemeResponse AWS API Documentation
|
1977
|
+
#
|
1978
|
+
class CreateThemeResponse < Struct.new(
|
1979
|
+
:arn,
|
1980
|
+
:version_arn,
|
1981
|
+
:theme_id,
|
1982
|
+
:creation_status,
|
1983
|
+
:status,
|
1984
|
+
:request_id)
|
1985
|
+
SENSITIVE = []
|
1986
|
+
include Aws::Structure
|
1987
|
+
end
|
1988
|
+
|
1741
1989
|
# The combination of user name and password that are used as
|
1742
1990
|
# credentials.
|
1743
1991
|
#
|
@@ -2245,6 +2493,43 @@ module Aws::QuickSight
|
|
2245
2493
|
include Aws::Structure
|
2246
2494
|
end
|
2247
2495
|
|
2496
|
+
# The theme colors that are used for data colors in charts. The colors
|
2497
|
+
# description is a hexidecimal color code that consists of six
|
2498
|
+
# alphanumerical characters, prefixed with `#`, for example #37BFF5.
|
2499
|
+
#
|
2500
|
+
# @note When making an API call, you may pass DataColorPalette
|
2501
|
+
# data as a hash:
|
2502
|
+
#
|
2503
|
+
# {
|
2504
|
+
# colors: ["HexColor"],
|
2505
|
+
# min_max_gradient: ["HexColor"],
|
2506
|
+
# empty_fill_color: "HexColor",
|
2507
|
+
# }
|
2508
|
+
#
|
2509
|
+
# @!attribute [rw] colors
|
2510
|
+
# The hexadecimal codes for the colors.
|
2511
|
+
# @return [Array<String>]
|
2512
|
+
#
|
2513
|
+
# @!attribute [rw] min_max_gradient
|
2514
|
+
# The minimum and maximum hexadecimal codes that describe a color
|
2515
|
+
# gradient.
|
2516
|
+
# @return [Array<String>]
|
2517
|
+
#
|
2518
|
+
# @!attribute [rw] empty_fill_color
|
2519
|
+
# The hexadecimal code of a color that applies to charts where a lack
|
2520
|
+
# of data is highlighted.
|
2521
|
+
# @return [String]
|
2522
|
+
#
|
2523
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataColorPalette AWS API Documentation
|
2524
|
+
#
|
2525
|
+
class DataColorPalette < Struct.new(
|
2526
|
+
:colors,
|
2527
|
+
:min_max_gradient,
|
2528
|
+
:empty_fill_color)
|
2529
|
+
SENSITIVE = []
|
2530
|
+
include Aws::Structure
|
2531
|
+
end
|
2532
|
+
|
2248
2533
|
# Dataset.
|
2249
2534
|
#
|
2250
2535
|
# @!attribute [rw] arn
|
@@ -3363,6 +3648,132 @@ module Aws::QuickSight
|
|
3363
3648
|
include Aws::Structure
|
3364
3649
|
end
|
3365
3650
|
|
3651
|
+
# @note When making an API call, you may pass DeleteThemeAliasRequest
|
3652
|
+
# data as a hash:
|
3653
|
+
#
|
3654
|
+
# {
|
3655
|
+
# aws_account_id: "AwsAccountId", # required
|
3656
|
+
# theme_id: "RestrictiveResourceId", # required
|
3657
|
+
# alias_name: "AliasName", # required
|
3658
|
+
# }
|
3659
|
+
#
|
3660
|
+
# @!attribute [rw] aws_account_id
|
3661
|
+
# The ID of the AWS account that contains the theme alias to delete.
|
3662
|
+
# @return [String]
|
3663
|
+
#
|
3664
|
+
# @!attribute [rw] theme_id
|
3665
|
+
# The ID for the theme that the specified alias is for.
|
3666
|
+
# @return [String]
|
3667
|
+
#
|
3668
|
+
# @!attribute [rw] alias_name
|
3669
|
+
# The unique name for the theme alias to delete.
|
3670
|
+
# @return [String]
|
3671
|
+
#
|
3672
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteThemeAliasRequest AWS API Documentation
|
3673
|
+
#
|
3674
|
+
class DeleteThemeAliasRequest < Struct.new(
|
3675
|
+
:aws_account_id,
|
3676
|
+
:theme_id,
|
3677
|
+
:alias_name)
|
3678
|
+
SENSITIVE = []
|
3679
|
+
include Aws::Structure
|
3680
|
+
end
|
3681
|
+
|
3682
|
+
# @!attribute [rw] alias_name
|
3683
|
+
# The name for the theme alias.
|
3684
|
+
# @return [String]
|
3685
|
+
#
|
3686
|
+
# @!attribute [rw] arn
|
3687
|
+
# The Amazon Resource Name (ARN) of the theme resource using the
|
3688
|
+
# deleted alias.
|
3689
|
+
# @return [String]
|
3690
|
+
#
|
3691
|
+
# @!attribute [rw] request_id
|
3692
|
+
# The AWS request ID for this operation.
|
3693
|
+
# @return [String]
|
3694
|
+
#
|
3695
|
+
# @!attribute [rw] status
|
3696
|
+
# The HTTP status of the request.
|
3697
|
+
# @return [Integer]
|
3698
|
+
#
|
3699
|
+
# @!attribute [rw] theme_id
|
3700
|
+
# An ID for the theme associated with the deletion.
|
3701
|
+
# @return [String]
|
3702
|
+
#
|
3703
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteThemeAliasResponse AWS API Documentation
|
3704
|
+
#
|
3705
|
+
class DeleteThemeAliasResponse < Struct.new(
|
3706
|
+
:alias_name,
|
3707
|
+
:arn,
|
3708
|
+
:request_id,
|
3709
|
+
:status,
|
3710
|
+
:theme_id)
|
3711
|
+
SENSITIVE = []
|
3712
|
+
include Aws::Structure
|
3713
|
+
end
|
3714
|
+
|
3715
|
+
# @note When making an API call, you may pass DeleteThemeRequest
|
3716
|
+
# data as a hash:
|
3717
|
+
#
|
3718
|
+
# {
|
3719
|
+
# aws_account_id: "AwsAccountId", # required
|
3720
|
+
# theme_id: "RestrictiveResourceId", # required
|
3721
|
+
# version_number: 1,
|
3722
|
+
# }
|
3723
|
+
#
|
3724
|
+
# @!attribute [rw] aws_account_id
|
3725
|
+
# The ID of the AWS account that contains the theme that you're
|
3726
|
+
# deleting.
|
3727
|
+
# @return [String]
|
3728
|
+
#
|
3729
|
+
# @!attribute [rw] theme_id
|
3730
|
+
# An ID for the theme that you want to delete.
|
3731
|
+
# @return [String]
|
3732
|
+
#
|
3733
|
+
# @!attribute [rw] version_number
|
3734
|
+
# The version of the theme that you want to delete.
|
3735
|
+
#
|
3736
|
+
# **Note:** If you don't provide a version number, you're using this
|
3737
|
+
# call to `DeleteTheme` to delete all versions of the theme.
|
3738
|
+
# @return [Integer]
|
3739
|
+
#
|
3740
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteThemeRequest AWS API Documentation
|
3741
|
+
#
|
3742
|
+
class DeleteThemeRequest < Struct.new(
|
3743
|
+
:aws_account_id,
|
3744
|
+
:theme_id,
|
3745
|
+
:version_number)
|
3746
|
+
SENSITIVE = []
|
3747
|
+
include Aws::Structure
|
3748
|
+
end
|
3749
|
+
|
3750
|
+
# @!attribute [rw] arn
|
3751
|
+
# The Amazon Resource Name (ARN) of the resource.
|
3752
|
+
# @return [String]
|
3753
|
+
#
|
3754
|
+
# @!attribute [rw] request_id
|
3755
|
+
# The AWS request ID for this operation.
|
3756
|
+
# @return [String]
|
3757
|
+
#
|
3758
|
+
# @!attribute [rw] status
|
3759
|
+
# The HTTP status of the request.
|
3760
|
+
# @return [Integer]
|
3761
|
+
#
|
3762
|
+
# @!attribute [rw] theme_id
|
3763
|
+
# An ID for the theme.
|
3764
|
+
# @return [String]
|
3765
|
+
#
|
3766
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteThemeResponse AWS API Documentation
|
3767
|
+
#
|
3768
|
+
class DeleteThemeResponse < Struct.new(
|
3769
|
+
:arn,
|
3770
|
+
:request_id,
|
3771
|
+
:status,
|
3772
|
+
:theme_id)
|
3773
|
+
SENSITIVE = []
|
3774
|
+
include Aws::Structure
|
3775
|
+
end
|
3776
|
+
|
3366
3777
|
# @note When making an API call, you may pass DeleteUserByPrincipalIdRequest
|
3367
3778
|
# data as a hash:
|
3368
3779
|
#
|
@@ -4126,15 +4537,197 @@ module Aws::QuickSight
|
|
4126
4537
|
# The HTTP status of the request.
|
4127
4538
|
# @return [Integer]
|
4128
4539
|
#
|
4129
|
-
#
|
4540
|
+
# @!attribute [rw] request_id
|
4541
|
+
# @return [String]
|
4542
|
+
#
|
4543
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTemplateResponse AWS API Documentation
|
4130
4544
|
#
|
4131
4545
|
class DescribeTemplateResponse < Struct.new(
|
4132
4546
|
:template,
|
4547
|
+
:status,
|
4548
|
+
:request_id)
|
4549
|
+
SENSITIVE = []
|
4550
|
+
include Aws::Structure
|
4551
|
+
end
|
4552
|
+
|
4553
|
+
# @note When making an API call, you may pass DescribeThemeAliasRequest
|
4554
|
+
# data as a hash:
|
4555
|
+
#
|
4556
|
+
# {
|
4557
|
+
# aws_account_id: "AwsAccountId", # required
|
4558
|
+
# theme_id: "RestrictiveResourceId", # required
|
4559
|
+
# alias_name: "AliasName", # required
|
4560
|
+
# }
|
4561
|
+
#
|
4562
|
+
# @!attribute [rw] aws_account_id
|
4563
|
+
# The ID of the AWS account that contains the theme alias that you're
|
4564
|
+
# describing.
|
4565
|
+
# @return [String]
|
4566
|
+
#
|
4567
|
+
# @!attribute [rw] theme_id
|
4568
|
+
# The ID for the theme.
|
4569
|
+
# @return [String]
|
4570
|
+
#
|
4571
|
+
# @!attribute [rw] alias_name
|
4572
|
+
# The name of the theme alias that you want to describe.
|
4573
|
+
# @return [String]
|
4574
|
+
#
|
4575
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeThemeAliasRequest AWS API Documentation
|
4576
|
+
#
|
4577
|
+
class DescribeThemeAliasRequest < Struct.new(
|
4578
|
+
:aws_account_id,
|
4579
|
+
:theme_id,
|
4580
|
+
:alias_name)
|
4581
|
+
SENSITIVE = []
|
4582
|
+
include Aws::Structure
|
4583
|
+
end
|
4584
|
+
|
4585
|
+
# @!attribute [rw] theme_alias
|
4586
|
+
# Information about the theme alias.
|
4587
|
+
# @return [Types::ThemeAlias]
|
4588
|
+
#
|
4589
|
+
# @!attribute [rw] status
|
4590
|
+
# The HTTP status of the request.
|
4591
|
+
# @return [Integer]
|
4592
|
+
#
|
4593
|
+
# @!attribute [rw] request_id
|
4594
|
+
# The AWS request ID for this operation.
|
4595
|
+
# @return [String]
|
4596
|
+
#
|
4597
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeThemeAliasResponse AWS API Documentation
|
4598
|
+
#
|
4599
|
+
class DescribeThemeAliasResponse < Struct.new(
|
4600
|
+
:theme_alias,
|
4601
|
+
:status,
|
4602
|
+
:request_id)
|
4603
|
+
SENSITIVE = []
|
4604
|
+
include Aws::Structure
|
4605
|
+
end
|
4606
|
+
|
4607
|
+
# @note When making an API call, you may pass DescribeThemePermissionsRequest
|
4608
|
+
# data as a hash:
|
4609
|
+
#
|
4610
|
+
# {
|
4611
|
+
# aws_account_id: "AwsAccountId", # required
|
4612
|
+
# theme_id: "RestrictiveResourceId", # required
|
4613
|
+
# }
|
4614
|
+
#
|
4615
|
+
# @!attribute [rw] aws_account_id
|
4616
|
+
# The ID of the AWS account that contains the theme that you're
|
4617
|
+
# describing.
|
4618
|
+
# @return [String]
|
4619
|
+
#
|
4620
|
+
# @!attribute [rw] theme_id
|
4621
|
+
# The ID for the theme that you want to describe permissions for.
|
4622
|
+
# @return [String]
|
4623
|
+
#
|
4624
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeThemePermissionsRequest AWS API Documentation
|
4625
|
+
#
|
4626
|
+
class DescribeThemePermissionsRequest < Struct.new(
|
4627
|
+
:aws_account_id,
|
4628
|
+
:theme_id)
|
4629
|
+
SENSITIVE = []
|
4630
|
+
include Aws::Structure
|
4631
|
+
end
|
4632
|
+
|
4633
|
+
# @!attribute [rw] theme_id
|
4634
|
+
# The ID for the theme.
|
4635
|
+
# @return [String]
|
4636
|
+
#
|
4637
|
+
# @!attribute [rw] theme_arn
|
4638
|
+
# The Amazon Resource Name (ARN) of the theme.
|
4639
|
+
# @return [String]
|
4640
|
+
#
|
4641
|
+
# @!attribute [rw] permissions
|
4642
|
+
# A list of resource permissions set on the theme.
|
4643
|
+
# @return [Array<Types::ResourcePermission>]
|
4644
|
+
#
|
4645
|
+
# @!attribute [rw] request_id
|
4646
|
+
# The AWS request ID for this operation.
|
4647
|
+
# @return [String]
|
4648
|
+
#
|
4649
|
+
# @!attribute [rw] status
|
4650
|
+
# The HTTP status of the request.
|
4651
|
+
# @return [Integer]
|
4652
|
+
#
|
4653
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeThemePermissionsResponse AWS API Documentation
|
4654
|
+
#
|
4655
|
+
class DescribeThemePermissionsResponse < Struct.new(
|
4656
|
+
:theme_id,
|
4657
|
+
:theme_arn,
|
4658
|
+
:permissions,
|
4659
|
+
:request_id,
|
4133
4660
|
:status)
|
4134
4661
|
SENSITIVE = []
|
4135
4662
|
include Aws::Structure
|
4136
4663
|
end
|
4137
4664
|
|
4665
|
+
# @note When making an API call, you may pass DescribeThemeRequest
|
4666
|
+
# data as a hash:
|
4667
|
+
#
|
4668
|
+
# {
|
4669
|
+
# aws_account_id: "AwsAndAccountId", # required
|
4670
|
+
# theme_id: "RestrictiveResourceId", # required
|
4671
|
+
# version_number: 1,
|
4672
|
+
# alias_name: "AliasName",
|
4673
|
+
# }
|
4674
|
+
#
|
4675
|
+
# @!attribute [rw] aws_account_id
|
4676
|
+
# The ID of the AWS account that contains the theme that you're
|
4677
|
+
# describing.
|
4678
|
+
# @return [String]
|
4679
|
+
#
|
4680
|
+
# @!attribute [rw] theme_id
|
4681
|
+
# The ID for the theme.
|
4682
|
+
# @return [String]
|
4683
|
+
#
|
4684
|
+
# @!attribute [rw] version_number
|
4685
|
+
# The version number for the version to describe. If a `VersionNumber`
|
4686
|
+
# parameter value isn't provided, the latest version of the theme is
|
4687
|
+
# described.
|
4688
|
+
# @return [Integer]
|
4689
|
+
#
|
4690
|
+
# @!attribute [rw] alias_name
|
4691
|
+
# The alias of the theme that you want to describe. If you name a
|
4692
|
+
# specific alias, you describe the version that the alias points to.
|
4693
|
+
# You can specify the latest version of the theme by providing the
|
4694
|
+
# keyword `$LATEST` in the `AliasName` parameter. The keyword
|
4695
|
+
# `$PUBLISHED` doesn't apply to themes.
|
4696
|
+
# @return [String]
|
4697
|
+
#
|
4698
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeThemeRequest AWS API Documentation
|
4699
|
+
#
|
4700
|
+
class DescribeThemeRequest < Struct.new(
|
4701
|
+
:aws_account_id,
|
4702
|
+
:theme_id,
|
4703
|
+
:version_number,
|
4704
|
+
:alias_name)
|
4705
|
+
SENSITIVE = []
|
4706
|
+
include Aws::Structure
|
4707
|
+
end
|
4708
|
+
|
4709
|
+
# @!attribute [rw] theme
|
4710
|
+
# The information about the theme that you are describing.
|
4711
|
+
# @return [Types::Theme]
|
4712
|
+
#
|
4713
|
+
# @!attribute [rw] status
|
4714
|
+
# The HTTP status of the request.
|
4715
|
+
# @return [Integer]
|
4716
|
+
#
|
4717
|
+
# @!attribute [rw] request_id
|
4718
|
+
# The AWS request ID for this operation.
|
4719
|
+
# @return [String]
|
4720
|
+
#
|
4721
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeThemeResponse AWS API Documentation
|
4722
|
+
#
|
4723
|
+
class DescribeThemeResponse < Struct.new(
|
4724
|
+
:theme,
|
4725
|
+
:status,
|
4726
|
+
:request_id)
|
4727
|
+
SENSITIVE = []
|
4728
|
+
include Aws::Structure
|
4729
|
+
end
|
4730
|
+
|
4138
4731
|
# @note When making an API call, you may pass DescribeUserRequest
|
4139
4732
|
# data as a hash:
|
4140
4733
|
#
|
@@ -4452,7 +5045,29 @@ module Aws::QuickSight
|
|
4452
5045
|
include Aws::Structure
|
4453
5046
|
end
|
4454
5047
|
|
4455
|
-
#
|
5048
|
+
# The display options for gutter spacing between tiles on a sheet.
|
5049
|
+
#
|
5050
|
+
# @note When making an API call, you may pass GutterStyle
|
5051
|
+
# data as a hash:
|
5052
|
+
#
|
5053
|
+
# {
|
5054
|
+
# show: false,
|
5055
|
+
# }
|
5056
|
+
#
|
5057
|
+
# @!attribute [rw] show
|
5058
|
+
# This Boolean value controls whether to display a gutter space
|
5059
|
+
# between sheet tiles.
|
5060
|
+
# @return [Boolean]
|
5061
|
+
#
|
5062
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GutterStyle AWS API Documentation
|
5063
|
+
#
|
5064
|
+
class GutterStyle < Struct.new(
|
5065
|
+
:show)
|
5066
|
+
SENSITIVE = []
|
5067
|
+
include Aws::Structure
|
5068
|
+
end
|
5069
|
+
|
5070
|
+
# An AWS Identity and Access Management (IAM) policy assignment.
|
4456
5071
|
#
|
4457
5072
|
# @!attribute [rw] aws_account_id
|
4458
5073
|
# The AWS account ID.
|
@@ -5623,171 +6238,382 @@ module Aws::QuickSight
|
|
5623
6238
|
include Aws::Structure
|
5624
6239
|
end
|
5625
6240
|
|
5626
|
-
# @note When making an API call, you may pass
|
6241
|
+
# @note When making an API call, you may pass ListThemeAliasesRequest
|
5627
6242
|
# data as a hash:
|
5628
6243
|
#
|
5629
6244
|
# {
|
5630
|
-
# user_name: "UserName", # required
|
5631
6245
|
# aws_account_id: "AwsAccountId", # required
|
5632
|
-
#
|
6246
|
+
# theme_id: "RestrictiveResourceId", # required
|
5633
6247
|
# next_token: "String",
|
5634
6248
|
# max_results: 1,
|
5635
6249
|
# }
|
5636
6250
|
#
|
5637
|
-
# @!attribute [rw] user_name
|
5638
|
-
# The Amazon QuickSight user name that you want to list group
|
5639
|
-
# memberships for.
|
5640
|
-
# @return [String]
|
5641
|
-
#
|
5642
6251
|
# @!attribute [rw] aws_account_id
|
5643
|
-
# The
|
5644
|
-
#
|
6252
|
+
# The ID of the AWS account that contains the theme aliases that
|
6253
|
+
# you're listing.
|
5645
6254
|
# @return [String]
|
5646
6255
|
#
|
5647
|
-
# @!attribute [rw]
|
5648
|
-
# The
|
6256
|
+
# @!attribute [rw] theme_id
|
6257
|
+
# The ID for the theme.
|
5649
6258
|
# @return [String]
|
5650
6259
|
#
|
5651
6260
|
# @!attribute [rw] next_token
|
5652
|
-
#
|
6261
|
+
# The token for the next set of results, or null if there are no more
|
6262
|
+
# results.
|
5653
6263
|
# @return [String]
|
5654
6264
|
#
|
5655
6265
|
# @!attribute [rw] max_results
|
5656
|
-
# The maximum number of results to
|
6266
|
+
# The maximum number of results to be returned per request.
|
5657
6267
|
# @return [Integer]
|
5658
6268
|
#
|
5659
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
6269
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListThemeAliasesRequest AWS API Documentation
|
5660
6270
|
#
|
5661
|
-
class
|
5662
|
-
:user_name,
|
6271
|
+
class ListThemeAliasesRequest < Struct.new(
|
5663
6272
|
:aws_account_id,
|
5664
|
-
:
|
6273
|
+
:theme_id,
|
5665
6274
|
:next_token,
|
5666
6275
|
:max_results)
|
5667
6276
|
SENSITIVE = []
|
5668
6277
|
include Aws::Structure
|
5669
6278
|
end
|
5670
6279
|
|
5671
|
-
# @!attribute [rw]
|
5672
|
-
#
|
5673
|
-
# @return [Array<Types::
|
6280
|
+
# @!attribute [rw] theme_alias_list
|
6281
|
+
# A structure containing the list of the theme's aliases.
|
6282
|
+
# @return [Array<Types::ThemeAlias>]
|
5674
6283
|
#
|
5675
|
-
# @!attribute [rw]
|
5676
|
-
#
|
5677
|
-
# @return [
|
6284
|
+
# @!attribute [rw] status
|
6285
|
+
# The HTTP status of the request.
|
6286
|
+
# @return [Integer]
|
5678
6287
|
#
|
5679
6288
|
# @!attribute [rw] request_id
|
5680
6289
|
# The AWS request ID for this operation.
|
5681
6290
|
# @return [String]
|
5682
6291
|
#
|
5683
|
-
# @!attribute [rw]
|
5684
|
-
# The
|
5685
|
-
#
|
6292
|
+
# @!attribute [rw] next_token
|
6293
|
+
# The token for the next set of results, or null if there are no more
|
6294
|
+
# results.
|
6295
|
+
# @return [String]
|
5686
6296
|
#
|
5687
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
6297
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListThemeAliasesResponse AWS API Documentation
|
5688
6298
|
#
|
5689
|
-
class
|
5690
|
-
:
|
5691
|
-
:
|
6299
|
+
class ListThemeAliasesResponse < Struct.new(
|
6300
|
+
:theme_alias_list,
|
6301
|
+
:status,
|
5692
6302
|
:request_id,
|
5693
|
-
:
|
6303
|
+
:next_token)
|
5694
6304
|
SENSITIVE = []
|
5695
6305
|
include Aws::Structure
|
5696
6306
|
end
|
5697
6307
|
|
5698
|
-
# @note When making an API call, you may pass
|
6308
|
+
# @note When making an API call, you may pass ListThemeVersionsRequest
|
5699
6309
|
# data as a hash:
|
5700
6310
|
#
|
5701
6311
|
# {
|
5702
6312
|
# aws_account_id: "AwsAccountId", # required
|
6313
|
+
# theme_id: "RestrictiveResourceId", # required
|
5703
6314
|
# next_token: "String",
|
5704
6315
|
# max_results: 1,
|
5705
|
-
# namespace: "Namespace", # required
|
5706
6316
|
# }
|
5707
6317
|
#
|
5708
6318
|
# @!attribute [rw] aws_account_id
|
5709
|
-
# The ID
|
5710
|
-
#
|
5711
|
-
#
|
6319
|
+
# The ID of the AWS account that contains the themes that you're
|
6320
|
+
# listing.
|
6321
|
+
# @return [String]
|
6322
|
+
#
|
6323
|
+
# @!attribute [rw] theme_id
|
6324
|
+
# The ID for the theme.
|
5712
6325
|
# @return [String]
|
5713
6326
|
#
|
5714
6327
|
# @!attribute [rw] next_token
|
5715
|
-
#
|
6328
|
+
# The token for the next set of results, or null if there are no more
|
6329
|
+
# results.
|
5716
6330
|
# @return [String]
|
5717
6331
|
#
|
5718
6332
|
# @!attribute [rw] max_results
|
5719
|
-
# The maximum number of results to
|
6333
|
+
# The maximum number of results to be returned per request.
|
5720
6334
|
# @return [Integer]
|
5721
6335
|
#
|
5722
|
-
#
|
5723
|
-
# The namespace. Currently, you should set this to `default`.
|
5724
|
-
# @return [String]
|
5725
|
-
#
|
5726
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListUsersRequest AWS API Documentation
|
6336
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListThemeVersionsRequest AWS API Documentation
|
5727
6337
|
#
|
5728
|
-
class
|
6338
|
+
class ListThemeVersionsRequest < Struct.new(
|
5729
6339
|
:aws_account_id,
|
6340
|
+
:theme_id,
|
5730
6341
|
:next_token,
|
5731
|
-
:max_results
|
5732
|
-
:namespace)
|
6342
|
+
:max_results)
|
5733
6343
|
SENSITIVE = []
|
5734
6344
|
include Aws::Structure
|
5735
6345
|
end
|
5736
6346
|
|
5737
|
-
# @!attribute [rw]
|
5738
|
-
#
|
5739
|
-
#
|
6347
|
+
# @!attribute [rw] theme_version_summary_list
|
6348
|
+
# A structure containing a list of all the versions of the specified
|
6349
|
+
# theme.
|
6350
|
+
# @return [Array<Types::ThemeVersionSummary>]
|
5740
6351
|
#
|
5741
6352
|
# @!attribute [rw] next_token
|
5742
|
-
#
|
5743
|
-
#
|
5744
|
-
#
|
5745
|
-
# @!attribute [rw] request_id
|
5746
|
-
# The AWS request ID for this operation.
|
6353
|
+
# The token for the next set of results, or null if there are no more
|
6354
|
+
# results.
|
5747
6355
|
# @return [String]
|
5748
6356
|
#
|
5749
6357
|
# @!attribute [rw] status
|
5750
6358
|
# The HTTP status of the request.
|
5751
6359
|
# @return [Integer]
|
5752
6360
|
#
|
5753
|
-
#
|
6361
|
+
# @!attribute [rw] request_id
|
6362
|
+
# The AWS request ID for this operation.
|
6363
|
+
# @return [String]
|
5754
6364
|
#
|
5755
|
-
|
5756
|
-
|
6365
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListThemeVersionsResponse AWS API Documentation
|
6366
|
+
#
|
6367
|
+
class ListThemeVersionsResponse < Struct.new(
|
6368
|
+
:theme_version_summary_list,
|
5757
6369
|
:next_token,
|
5758
|
-
:
|
5759
|
-
:
|
6370
|
+
:status,
|
6371
|
+
:request_id)
|
5760
6372
|
SENSITIVE = []
|
5761
6373
|
include Aws::Structure
|
5762
6374
|
end
|
5763
6375
|
|
5764
|
-
#
|
5765
|
-
# operate on. A logical table has a source, which can be either a
|
5766
|
-
# physical table or result of a join. When a logical table points to a
|
5767
|
-
# physical table, the logical table acts as a mutable copy of that
|
5768
|
-
# physical table through transform operations.
|
5769
|
-
#
|
5770
|
-
# @note When making an API call, you may pass LogicalTable
|
6376
|
+
# @note When making an API call, you may pass ListThemesRequest
|
5771
6377
|
# data as a hash:
|
5772
6378
|
#
|
5773
6379
|
# {
|
5774
|
-
#
|
5775
|
-
#
|
5776
|
-
#
|
5777
|
-
#
|
5778
|
-
#
|
5779
|
-
#
|
5780
|
-
#
|
5781
|
-
#
|
5782
|
-
#
|
5783
|
-
#
|
5784
|
-
#
|
5785
|
-
#
|
5786
|
-
#
|
5787
|
-
#
|
5788
|
-
#
|
5789
|
-
#
|
5790
|
-
#
|
6380
|
+
# aws_account_id: "AwsAccountId", # required
|
6381
|
+
# next_token: "String",
|
6382
|
+
# max_results: 1,
|
6383
|
+
# type: "QUICKSIGHT", # accepts QUICKSIGHT, CUSTOM, ALL
|
6384
|
+
# }
|
6385
|
+
#
|
6386
|
+
# @!attribute [rw] aws_account_id
|
6387
|
+
# The ID of the AWS account that contains the themes that you're
|
6388
|
+
# listing.
|
6389
|
+
# @return [String]
|
6390
|
+
#
|
6391
|
+
# @!attribute [rw] next_token
|
6392
|
+
# The token for the next set of results, or null if there are no more
|
6393
|
+
# results.
|
6394
|
+
# @return [String]
|
6395
|
+
#
|
6396
|
+
# @!attribute [rw] max_results
|
6397
|
+
# The maximum number of results to be returned per request.
|
6398
|
+
# @return [Integer]
|
6399
|
+
#
|
6400
|
+
# @!attribute [rw] type
|
6401
|
+
# The type of themes that you want to list. Valid options include the
|
6402
|
+
# following:
|
6403
|
+
#
|
6404
|
+
# * `ALL (default)`- Display all existing themes.
|
6405
|
+
#
|
6406
|
+
# * `CUSTOM` - Display only the themes created by people using Amazon
|
6407
|
+
# QuickSight.
|
6408
|
+
#
|
6409
|
+
# * `QUICKSIGHT` - Display only the starting themes defined by
|
6410
|
+
# QuickSight.
|
6411
|
+
# @return [String]
|
6412
|
+
#
|
6413
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListThemesRequest AWS API Documentation
|
6414
|
+
#
|
6415
|
+
class ListThemesRequest < Struct.new(
|
6416
|
+
:aws_account_id,
|
6417
|
+
:next_token,
|
6418
|
+
:max_results,
|
6419
|
+
:type)
|
6420
|
+
SENSITIVE = []
|
6421
|
+
include Aws::Structure
|
6422
|
+
end
|
6423
|
+
|
6424
|
+
# @!attribute [rw] theme_summary_list
|
6425
|
+
# Information about the themes in the list.
|
6426
|
+
# @return [Array<Types::ThemeSummary>]
|
6427
|
+
#
|
6428
|
+
# @!attribute [rw] next_token
|
6429
|
+
# The token for the next set of results, or null if there are no more
|
6430
|
+
# results.
|
6431
|
+
# @return [String]
|
6432
|
+
#
|
6433
|
+
# @!attribute [rw] status
|
6434
|
+
# The HTTP status of the request.
|
6435
|
+
# @return [Integer]
|
6436
|
+
#
|
6437
|
+
# @!attribute [rw] request_id
|
6438
|
+
# The AWS request ID for this operation.
|
6439
|
+
# @return [String]
|
6440
|
+
#
|
6441
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListThemesResponse AWS API Documentation
|
6442
|
+
#
|
6443
|
+
class ListThemesResponse < Struct.new(
|
6444
|
+
:theme_summary_list,
|
6445
|
+
:next_token,
|
6446
|
+
:status,
|
6447
|
+
:request_id)
|
6448
|
+
SENSITIVE = []
|
6449
|
+
include Aws::Structure
|
6450
|
+
end
|
6451
|
+
|
6452
|
+
# @note When making an API call, you may pass ListUserGroupsRequest
|
6453
|
+
# data as a hash:
|
6454
|
+
#
|
6455
|
+
# {
|
6456
|
+
# user_name: "UserName", # required
|
6457
|
+
# aws_account_id: "AwsAccountId", # required
|
6458
|
+
# namespace: "Namespace", # required
|
6459
|
+
# next_token: "String",
|
6460
|
+
# max_results: 1,
|
6461
|
+
# }
|
6462
|
+
#
|
6463
|
+
# @!attribute [rw] user_name
|
6464
|
+
# The Amazon QuickSight user name that you want to list group
|
6465
|
+
# memberships for.
|
6466
|
+
# @return [String]
|
6467
|
+
#
|
6468
|
+
# @!attribute [rw] aws_account_id
|
6469
|
+
# The AWS account ID that the user is in. Currently, you use the ID
|
6470
|
+
# for the AWS account that contains your Amazon QuickSight account.
|
6471
|
+
# @return [String]
|
6472
|
+
#
|
6473
|
+
# @!attribute [rw] namespace
|
6474
|
+
# The namespace. Currently, you should set this to `default`.
|
6475
|
+
# @return [String]
|
6476
|
+
#
|
6477
|
+
# @!attribute [rw] next_token
|
6478
|
+
# A pagination token that can be used in a subsequent request.
|
6479
|
+
# @return [String]
|
6480
|
+
#
|
6481
|
+
# @!attribute [rw] max_results
|
6482
|
+
# The maximum number of results to return from this request.
|
6483
|
+
# @return [Integer]
|
6484
|
+
#
|
6485
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListUserGroupsRequest AWS API Documentation
|
6486
|
+
#
|
6487
|
+
class ListUserGroupsRequest < Struct.new(
|
6488
|
+
:user_name,
|
6489
|
+
:aws_account_id,
|
6490
|
+
:namespace,
|
6491
|
+
:next_token,
|
6492
|
+
:max_results)
|
6493
|
+
SENSITIVE = []
|
6494
|
+
include Aws::Structure
|
6495
|
+
end
|
6496
|
+
|
6497
|
+
# @!attribute [rw] group_list
|
6498
|
+
# The list of groups the user is a member of.
|
6499
|
+
# @return [Array<Types::Group>]
|
6500
|
+
#
|
6501
|
+
# @!attribute [rw] next_token
|
6502
|
+
# A pagination token that can be used in a subsequent request.
|
6503
|
+
# @return [String]
|
6504
|
+
#
|
6505
|
+
# @!attribute [rw] request_id
|
6506
|
+
# The AWS request ID for this operation.
|
6507
|
+
# @return [String]
|
6508
|
+
#
|
6509
|
+
# @!attribute [rw] status
|
6510
|
+
# The HTTP status of the request.
|
6511
|
+
# @return [Integer]
|
6512
|
+
#
|
6513
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListUserGroupsResponse AWS API Documentation
|
6514
|
+
#
|
6515
|
+
class ListUserGroupsResponse < Struct.new(
|
6516
|
+
:group_list,
|
6517
|
+
:next_token,
|
6518
|
+
:request_id,
|
6519
|
+
:status)
|
6520
|
+
SENSITIVE = []
|
6521
|
+
include Aws::Structure
|
6522
|
+
end
|
6523
|
+
|
6524
|
+
# @note When making an API call, you may pass ListUsersRequest
|
6525
|
+
# data as a hash:
|
6526
|
+
#
|
6527
|
+
# {
|
6528
|
+
# aws_account_id: "AwsAccountId", # required
|
6529
|
+
# next_token: "String",
|
6530
|
+
# max_results: 1,
|
6531
|
+
# namespace: "Namespace", # required
|
6532
|
+
# }
|
6533
|
+
#
|
6534
|
+
# @!attribute [rw] aws_account_id
|
6535
|
+
# The ID for the AWS account that the user is in. Currently, you use
|
6536
|
+
# the ID for the AWS account that contains your Amazon QuickSight
|
6537
|
+
# account.
|
6538
|
+
# @return [String]
|
6539
|
+
#
|
6540
|
+
# @!attribute [rw] next_token
|
6541
|
+
# A pagination token that can be used in a subsequent request.
|
6542
|
+
# @return [String]
|
6543
|
+
#
|
6544
|
+
# @!attribute [rw] max_results
|
6545
|
+
# The maximum number of results to return from this request.
|
6546
|
+
# @return [Integer]
|
6547
|
+
#
|
6548
|
+
# @!attribute [rw] namespace
|
6549
|
+
# The namespace. Currently, you should set this to `default`.
|
6550
|
+
# @return [String]
|
6551
|
+
#
|
6552
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListUsersRequest AWS API Documentation
|
6553
|
+
#
|
6554
|
+
class ListUsersRequest < Struct.new(
|
6555
|
+
:aws_account_id,
|
6556
|
+
:next_token,
|
6557
|
+
:max_results,
|
6558
|
+
:namespace)
|
6559
|
+
SENSITIVE = []
|
6560
|
+
include Aws::Structure
|
6561
|
+
end
|
6562
|
+
|
6563
|
+
# @!attribute [rw] user_list
|
6564
|
+
# The list of users.
|
6565
|
+
# @return [Array<Types::User>]
|
6566
|
+
#
|
6567
|
+
# @!attribute [rw] next_token
|
6568
|
+
# A pagination token that can be used in a subsequent request.
|
6569
|
+
# @return [String]
|
6570
|
+
#
|
6571
|
+
# @!attribute [rw] request_id
|
6572
|
+
# The AWS request ID for this operation.
|
6573
|
+
# @return [String]
|
6574
|
+
#
|
6575
|
+
# @!attribute [rw] status
|
6576
|
+
# The HTTP status of the request.
|
6577
|
+
# @return [Integer]
|
6578
|
+
#
|
6579
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListUsersResponse AWS API Documentation
|
6580
|
+
#
|
6581
|
+
class ListUsersResponse < Struct.new(
|
6582
|
+
:user_list,
|
6583
|
+
:next_token,
|
6584
|
+
:request_id,
|
6585
|
+
:status)
|
6586
|
+
SENSITIVE = []
|
6587
|
+
include Aws::Structure
|
6588
|
+
end
|
6589
|
+
|
6590
|
+
# A *logical table* is a unit that joins and that data transformations
|
6591
|
+
# operate on. A logical table has a source, which can be either a
|
6592
|
+
# physical table or result of a join. When a logical table points to a
|
6593
|
+
# physical table, the logical table acts as a mutable copy of that
|
6594
|
+
# physical table through transform operations.
|
6595
|
+
#
|
6596
|
+
# @note When making an API call, you may pass LogicalTable
|
6597
|
+
# data as a hash:
|
6598
|
+
#
|
6599
|
+
# {
|
6600
|
+
# alias: "LogicalTableAlias", # required
|
6601
|
+
# data_transforms: [
|
6602
|
+
# {
|
6603
|
+
# project_operation: {
|
6604
|
+
# projected_columns: ["String"], # required
|
6605
|
+
# },
|
6606
|
+
# filter_operation: {
|
6607
|
+
# condition_expression: "Expression", # required
|
6608
|
+
# },
|
6609
|
+
# create_columns_operation: {
|
6610
|
+
# columns: [ # required
|
6611
|
+
# {
|
6612
|
+
# column_name: "ColumnName", # required
|
6613
|
+
# column_id: "ColumnId", # required
|
6614
|
+
# expression: "Expression", # required
|
6615
|
+
# },
|
6616
|
+
# ],
|
5791
6617
|
# },
|
5792
6618
|
# rename_column_operation: {
|
5793
6619
|
# column_name: "ColumnName", # required
|
@@ -5902,6 +6728,27 @@ module Aws::QuickSight
|
|
5902
6728
|
include Aws::Structure
|
5903
6729
|
end
|
5904
6730
|
|
6731
|
+
# The display options for margins around the outside edge of sheets.
|
6732
|
+
#
|
6733
|
+
# @note When making an API call, you may pass MarginStyle
|
6734
|
+
# data as a hash:
|
6735
|
+
#
|
6736
|
+
# {
|
6737
|
+
# show: false,
|
6738
|
+
# }
|
6739
|
+
#
|
6740
|
+
# @!attribute [rw] show
|
6741
|
+
# This Boolean value controls whether to display sheet margins.
|
6742
|
+
# @return [Boolean]
|
6743
|
+
#
|
6744
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/MarginStyle AWS API Documentation
|
6745
|
+
#
|
6746
|
+
class MarginStyle < Struct.new(
|
6747
|
+
:show)
|
6748
|
+
SENSITIVE = []
|
6749
|
+
include Aws::Structure
|
6750
|
+
end
|
6751
|
+
|
5905
6752
|
# MariaDB parameters.
|
5906
6753
|
#
|
5907
6754
|
# @note When making an API call, you may pass MariaDbParameters
|
@@ -6588,10 +7435,15 @@ module Aws::QuickSight
|
|
6588
7435
|
# }
|
6589
7436
|
#
|
6590
7437
|
# @!attribute [rw] principal
|
6591
|
-
# The Amazon Resource Name (ARN) of
|
6592
|
-
#
|
6593
|
-
#
|
6594
|
-
#
|
7438
|
+
# The Amazon Resource Name (ARN) of the principal. This can be one of
|
7439
|
+
# the following:
|
7440
|
+
#
|
7441
|
+
# * The ARN of an Amazon QuickSight user, group, or namespace. (This
|
7442
|
+
# is most common.)
|
7443
|
+
#
|
7444
|
+
# * The ARN of an AWS account root: This is an IAM ARN rather than a
|
7445
|
+
# QuickSight ARN. Use this option only to share resources
|
7446
|
+
# (templates) across AWS accounts. (This is less common.)
|
6595
7447
|
# @return [String]
|
6596
7448
|
#
|
6597
7449
|
# @!attribute [rw] actions
|
@@ -6884,6 +7736,44 @@ module Aws::QuickSight
|
|
6884
7736
|
include Aws::Structure
|
6885
7737
|
end
|
6886
7738
|
|
7739
|
+
# The theme display options for sheets.
|
7740
|
+
#
|
7741
|
+
# @note When making an API call, you may pass SheetStyle
|
7742
|
+
# data as a hash:
|
7743
|
+
#
|
7744
|
+
# {
|
7745
|
+
# tile: {
|
7746
|
+
# border: {
|
7747
|
+
# show: false,
|
7748
|
+
# },
|
7749
|
+
# },
|
7750
|
+
# tile_layout: {
|
7751
|
+
# gutter: {
|
7752
|
+
# show: false,
|
7753
|
+
# },
|
7754
|
+
# margin: {
|
7755
|
+
# show: false,
|
7756
|
+
# },
|
7757
|
+
# },
|
7758
|
+
# }
|
7759
|
+
#
|
7760
|
+
# @!attribute [rw] tile
|
7761
|
+
# The display options for tiles.
|
7762
|
+
# @return [Types::TileStyle]
|
7763
|
+
#
|
7764
|
+
# @!attribute [rw] tile_layout
|
7765
|
+
# The layout options for tiles.
|
7766
|
+
# @return [Types::TileLayoutStyle]
|
7767
|
+
#
|
7768
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SheetStyle AWS API Documentation
|
7769
|
+
#
|
7770
|
+
class SheetStyle < Struct.new(
|
7771
|
+
:tile,
|
7772
|
+
:tile_layout)
|
7773
|
+
SENSITIVE = []
|
7774
|
+
include Aws::Structure
|
7775
|
+
end
|
7776
|
+
|
6887
7777
|
# Snowflake parameters.
|
6888
7778
|
#
|
6889
7779
|
# @note When making an API call, you may pass SnowflakeParameters
|
@@ -7478,8 +8368,290 @@ module Aws::QuickSight
|
|
7478
8368
|
include Aws::Structure
|
7479
8369
|
end
|
7480
8370
|
|
7481
|
-
#
|
7482
|
-
#
|
8371
|
+
# @!attribute [rw] arn
|
8372
|
+
# The Amazon Resource Name (ARN) of the theme.
|
8373
|
+
# @return [String]
|
8374
|
+
#
|
8375
|
+
# @!attribute [rw] name
|
8376
|
+
# The name that the user gives to the theme.
|
8377
|
+
# @return [String]
|
8378
|
+
#
|
8379
|
+
# @!attribute [rw] theme_id
|
8380
|
+
# The identifier that the user gives to the theme.
|
8381
|
+
# @return [String]
|
8382
|
+
#
|
8383
|
+
# @!attribute [rw] version
|
8384
|
+
# A version of a theme.
|
8385
|
+
# @return [Types::ThemeVersion]
|
8386
|
+
#
|
8387
|
+
# @!attribute [rw] created_time
|
8388
|
+
# The date and time that the theme was created.
|
8389
|
+
# @return [Time]
|
8390
|
+
#
|
8391
|
+
# @!attribute [rw] last_updated_time
|
8392
|
+
# The date and time that the theme was last updated.
|
8393
|
+
# @return [Time]
|
8394
|
+
#
|
8395
|
+
# @!attribute [rw] type
|
8396
|
+
# The type of theme, based on how it was created. Valid values
|
8397
|
+
# include: `QUICKSIGHT` and `CUSTOM`.
|
8398
|
+
# @return [String]
|
8399
|
+
#
|
8400
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Theme AWS API Documentation
|
8401
|
+
#
|
8402
|
+
class Theme < Struct.new(
|
8403
|
+
:arn,
|
8404
|
+
:name,
|
8405
|
+
:theme_id,
|
8406
|
+
:version,
|
8407
|
+
:created_time,
|
8408
|
+
:last_updated_time,
|
8409
|
+
:type)
|
8410
|
+
SENSITIVE = []
|
8411
|
+
include Aws::Structure
|
8412
|
+
end
|
8413
|
+
|
8414
|
+
# An alias for a theme.
|
8415
|
+
#
|
8416
|
+
# @!attribute [rw] arn
|
8417
|
+
# The Amazon Resource Name (ARN) of the theme alias.
|
8418
|
+
# @return [String]
|
8419
|
+
#
|
8420
|
+
# @!attribute [rw] alias_name
|
8421
|
+
# The display name of the theme alias.
|
8422
|
+
# @return [String]
|
8423
|
+
#
|
8424
|
+
# @!attribute [rw] theme_version_number
|
8425
|
+
# The version number of the theme alias.
|
8426
|
+
# @return [Integer]
|
8427
|
+
#
|
8428
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ThemeAlias AWS API Documentation
|
8429
|
+
#
|
8430
|
+
class ThemeAlias < Struct.new(
|
8431
|
+
:arn,
|
8432
|
+
:alias_name,
|
8433
|
+
:theme_version_number)
|
8434
|
+
SENSITIVE = []
|
8435
|
+
include Aws::Structure
|
8436
|
+
end
|
8437
|
+
|
8438
|
+
# The theme configuration. This configuration contains all of the
|
8439
|
+
# display properties for a theme.
|
8440
|
+
#
|
8441
|
+
# @note When making an API call, you may pass ThemeConfiguration
|
8442
|
+
# data as a hash:
|
8443
|
+
#
|
8444
|
+
# {
|
8445
|
+
# data_color_palette: {
|
8446
|
+
# colors: ["HexColor"],
|
8447
|
+
# min_max_gradient: ["HexColor"],
|
8448
|
+
# empty_fill_color: "HexColor",
|
8449
|
+
# },
|
8450
|
+
# ui_color_palette: {
|
8451
|
+
# primary_foreground: "HexColor",
|
8452
|
+
# primary_background: "HexColor",
|
8453
|
+
# secondary_foreground: "HexColor",
|
8454
|
+
# secondary_background: "HexColor",
|
8455
|
+
# accent: "HexColor",
|
8456
|
+
# accent_foreground: "HexColor",
|
8457
|
+
# danger: "HexColor",
|
8458
|
+
# danger_foreground: "HexColor",
|
8459
|
+
# warning: "HexColor",
|
8460
|
+
# warning_foreground: "HexColor",
|
8461
|
+
# success: "HexColor",
|
8462
|
+
# success_foreground: "HexColor",
|
8463
|
+
# dimension: "HexColor",
|
8464
|
+
# dimension_foreground: "HexColor",
|
8465
|
+
# measure: "HexColor",
|
8466
|
+
# measure_foreground: "HexColor",
|
8467
|
+
# },
|
8468
|
+
# sheet: {
|
8469
|
+
# tile: {
|
8470
|
+
# border: {
|
8471
|
+
# show: false,
|
8472
|
+
# },
|
8473
|
+
# },
|
8474
|
+
# tile_layout: {
|
8475
|
+
# gutter: {
|
8476
|
+
# show: false,
|
8477
|
+
# },
|
8478
|
+
# margin: {
|
8479
|
+
# show: false,
|
8480
|
+
# },
|
8481
|
+
# },
|
8482
|
+
# },
|
8483
|
+
# }
|
8484
|
+
#
|
8485
|
+
# @!attribute [rw] data_color_palette
|
8486
|
+
# Color properties that apply to chart data colors.
|
8487
|
+
# @return [Types::DataColorPalette]
|
8488
|
+
#
|
8489
|
+
# @!attribute [rw] ui_color_palette
|
8490
|
+
# Color properties that apply to the UI and to charts, excluding the
|
8491
|
+
# colors that apply to data.
|
8492
|
+
# @return [Types::UIColorPalette]
|
8493
|
+
#
|
8494
|
+
# @!attribute [rw] sheet
|
8495
|
+
# Display options related to sheets.
|
8496
|
+
# @return [Types::SheetStyle]
|
8497
|
+
#
|
8498
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ThemeConfiguration AWS API Documentation
|
8499
|
+
#
|
8500
|
+
class ThemeConfiguration < Struct.new(
|
8501
|
+
:data_color_palette,
|
8502
|
+
:ui_color_palette,
|
8503
|
+
:sheet)
|
8504
|
+
SENSITIVE = []
|
8505
|
+
include Aws::Structure
|
8506
|
+
end
|
8507
|
+
|
8508
|
+
# Theme error.
|
8509
|
+
#
|
8510
|
+
# @!attribute [rw] type
|
8511
|
+
# The type of error.
|
8512
|
+
# @return [String]
|
8513
|
+
#
|
8514
|
+
# @!attribute [rw] message
|
8515
|
+
# The error message.
|
8516
|
+
# @return [String]
|
8517
|
+
#
|
8518
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ThemeError AWS API Documentation
|
8519
|
+
#
|
8520
|
+
class ThemeError < Struct.new(
|
8521
|
+
:type,
|
8522
|
+
:message)
|
8523
|
+
SENSITIVE = []
|
8524
|
+
include Aws::Structure
|
8525
|
+
end
|
8526
|
+
|
8527
|
+
# The theme summary.
|
8528
|
+
#
|
8529
|
+
# @!attribute [rw] arn
|
8530
|
+
# The Amazon Resource Name (ARN) of the resource.
|
8531
|
+
# @return [String]
|
8532
|
+
#
|
8533
|
+
# @!attribute [rw] name
|
8534
|
+
# the display name for the theme.
|
8535
|
+
# @return [String]
|
8536
|
+
#
|
8537
|
+
# @!attribute [rw] theme_id
|
8538
|
+
# The ID of the theme. This ID is unique per AWS Region for each AWS
|
8539
|
+
# account.
|
8540
|
+
# @return [String]
|
8541
|
+
#
|
8542
|
+
# @!attribute [rw] latest_version_number
|
8543
|
+
# The latest version number for the theme.
|
8544
|
+
# @return [Integer]
|
8545
|
+
#
|
8546
|
+
# @!attribute [rw] created_time
|
8547
|
+
# The date and time that this theme was created.
|
8548
|
+
# @return [Time]
|
8549
|
+
#
|
8550
|
+
# @!attribute [rw] last_updated_time
|
8551
|
+
# The last date and time that this theme was updated.
|
8552
|
+
# @return [Time]
|
8553
|
+
#
|
8554
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ThemeSummary AWS API Documentation
|
8555
|
+
#
|
8556
|
+
class ThemeSummary < Struct.new(
|
8557
|
+
:arn,
|
8558
|
+
:name,
|
8559
|
+
:theme_id,
|
8560
|
+
:latest_version_number,
|
8561
|
+
:created_time,
|
8562
|
+
:last_updated_time)
|
8563
|
+
SENSITIVE = []
|
8564
|
+
include Aws::Structure
|
8565
|
+
end
|
8566
|
+
|
8567
|
+
# A version of a theme.
|
8568
|
+
#
|
8569
|
+
# @!attribute [rw] version_number
|
8570
|
+
# The version number of the theme.
|
8571
|
+
# @return [Integer]
|
8572
|
+
#
|
8573
|
+
# @!attribute [rw] arn
|
8574
|
+
# The Amazon Resource Name (ARN) of the resource.
|
8575
|
+
# @return [String]
|
8576
|
+
#
|
8577
|
+
# @!attribute [rw] description
|
8578
|
+
# The description of the theme.
|
8579
|
+
# @return [String]
|
8580
|
+
#
|
8581
|
+
# @!attribute [rw] base_theme_id
|
8582
|
+
# The Amazon QuickSight-defined ID of the theme that a custom theme
|
8583
|
+
# inherits from. All themes initially inherit from a default
|
8584
|
+
# QuickSight theme.
|
8585
|
+
# @return [String]
|
8586
|
+
#
|
8587
|
+
# @!attribute [rw] created_time
|
8588
|
+
# The date and time that this theme version was created.
|
8589
|
+
# @return [Time]
|
8590
|
+
#
|
8591
|
+
# @!attribute [rw] configuration
|
8592
|
+
# The theme configuration, which contains all the theme display
|
8593
|
+
# properties.
|
8594
|
+
# @return [Types::ThemeConfiguration]
|
8595
|
+
#
|
8596
|
+
# @!attribute [rw] errors
|
8597
|
+
# Errors associated with the theme.
|
8598
|
+
# @return [Array<Types::ThemeError>]
|
8599
|
+
#
|
8600
|
+
# @!attribute [rw] status
|
8601
|
+
# The status of the theme version.
|
8602
|
+
# @return [String]
|
8603
|
+
#
|
8604
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ThemeVersion AWS API Documentation
|
8605
|
+
#
|
8606
|
+
class ThemeVersion < Struct.new(
|
8607
|
+
:version_number,
|
8608
|
+
:arn,
|
8609
|
+
:description,
|
8610
|
+
:base_theme_id,
|
8611
|
+
:created_time,
|
8612
|
+
:configuration,
|
8613
|
+
:errors,
|
8614
|
+
:status)
|
8615
|
+
SENSITIVE = []
|
8616
|
+
include Aws::Structure
|
8617
|
+
end
|
8618
|
+
|
8619
|
+
# The theme version.
|
8620
|
+
#
|
8621
|
+
# @!attribute [rw] version_number
|
8622
|
+
# The version number of the theme version.
|
8623
|
+
# @return [Integer]
|
8624
|
+
#
|
8625
|
+
# @!attribute [rw] arn
|
8626
|
+
# The Amazon Resource Name (ARN) of the theme version.
|
8627
|
+
# @return [String]
|
8628
|
+
#
|
8629
|
+
# @!attribute [rw] description
|
8630
|
+
# The description of the theme version.
|
8631
|
+
# @return [String]
|
8632
|
+
#
|
8633
|
+
# @!attribute [rw] created_time
|
8634
|
+
# The date and time that this theme version was created.
|
8635
|
+
# @return [Time]
|
8636
|
+
#
|
8637
|
+
# @!attribute [rw] status
|
8638
|
+
# The status of the theme version.
|
8639
|
+
# @return [String]
|
8640
|
+
#
|
8641
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ThemeVersionSummary AWS API Documentation
|
8642
|
+
#
|
8643
|
+
class ThemeVersionSummary < Struct.new(
|
8644
|
+
:version_number,
|
8645
|
+
:arn,
|
8646
|
+
:description,
|
8647
|
+
:created_time,
|
8648
|
+
:status)
|
8649
|
+
SENSITIVE = []
|
8650
|
+
include Aws::Structure
|
8651
|
+
end
|
8652
|
+
|
8653
|
+
# Access is throttled.
|
8654
|
+
#
|
7483
8655
|
# @!attribute [rw] message
|
7484
8656
|
# @return [String]
|
7485
8657
|
#
|
@@ -7496,6 +8668,60 @@ module Aws::QuickSight
|
|
7496
8668
|
include Aws::Structure
|
7497
8669
|
end
|
7498
8670
|
|
8671
|
+
# The display options for the layout of tiles on a sheet.
|
8672
|
+
#
|
8673
|
+
# @note When making an API call, you may pass TileLayoutStyle
|
8674
|
+
# data as a hash:
|
8675
|
+
#
|
8676
|
+
# {
|
8677
|
+
# gutter: {
|
8678
|
+
# show: false,
|
8679
|
+
# },
|
8680
|
+
# margin: {
|
8681
|
+
# show: false,
|
8682
|
+
# },
|
8683
|
+
# }
|
8684
|
+
#
|
8685
|
+
# @!attribute [rw] gutter
|
8686
|
+
# The gutter settings that apply between tiles.
|
8687
|
+
# @return [Types::GutterStyle]
|
8688
|
+
#
|
8689
|
+
# @!attribute [rw] margin
|
8690
|
+
# The margin settings that apply around the outside edge of sheets.
|
8691
|
+
# @return [Types::MarginStyle]
|
8692
|
+
#
|
8693
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TileLayoutStyle AWS API Documentation
|
8694
|
+
#
|
8695
|
+
class TileLayoutStyle < Struct.new(
|
8696
|
+
:gutter,
|
8697
|
+
:margin)
|
8698
|
+
SENSITIVE = []
|
8699
|
+
include Aws::Structure
|
8700
|
+
end
|
8701
|
+
|
8702
|
+
# Display options related to tiles on a sheet.
|
8703
|
+
#
|
8704
|
+
# @note When making an API call, you may pass TileStyle
|
8705
|
+
# data as a hash:
|
8706
|
+
#
|
8707
|
+
# {
|
8708
|
+
# border: {
|
8709
|
+
# show: false,
|
8710
|
+
# },
|
8711
|
+
# }
|
8712
|
+
#
|
8713
|
+
# @!attribute [rw] border
|
8714
|
+
# The border around a tile.
|
8715
|
+
# @return [Types::BorderStyle]
|
8716
|
+
#
|
8717
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TileStyle AWS API Documentation
|
8718
|
+
#
|
8719
|
+
class TileStyle < Struct.new(
|
8720
|
+
:border)
|
8721
|
+
SENSITIVE = []
|
8722
|
+
include Aws::Structure
|
8723
|
+
end
|
8724
|
+
|
7499
8725
|
# A data transformation on a logical table. This is a variant type
|
7500
8726
|
# structure. For this structure to be valid, only one of the attributes
|
7501
8727
|
# can be non-null.
|
@@ -7604,6 +8830,139 @@ module Aws::QuickSight
|
|
7604
8830
|
include Aws::Structure
|
7605
8831
|
end
|
7606
8832
|
|
8833
|
+
# The theme colors that apply to UI and to charts, excluding data
|
8834
|
+
# colors. The colors description is a hexidecimal color code that
|
8835
|
+
# consists of six alphanumerical characters, prefixed with `#`, for
|
8836
|
+
# example #37BFF5. For more information, see [Using Themes in Amazon
|
8837
|
+
# QuickSight][1] in the *Amazon QuickSight User Guide.*
|
8838
|
+
#
|
8839
|
+
#
|
8840
|
+
#
|
8841
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html
|
8842
|
+
#
|
8843
|
+
# @note When making an API call, you may pass UIColorPalette
|
8844
|
+
# data as a hash:
|
8845
|
+
#
|
8846
|
+
# {
|
8847
|
+
# primary_foreground: "HexColor",
|
8848
|
+
# primary_background: "HexColor",
|
8849
|
+
# secondary_foreground: "HexColor",
|
8850
|
+
# secondary_background: "HexColor",
|
8851
|
+
# accent: "HexColor",
|
8852
|
+
# accent_foreground: "HexColor",
|
8853
|
+
# danger: "HexColor",
|
8854
|
+
# danger_foreground: "HexColor",
|
8855
|
+
# warning: "HexColor",
|
8856
|
+
# warning_foreground: "HexColor",
|
8857
|
+
# success: "HexColor",
|
8858
|
+
# success_foreground: "HexColor",
|
8859
|
+
# dimension: "HexColor",
|
8860
|
+
# dimension_foreground: "HexColor",
|
8861
|
+
# measure: "HexColor",
|
8862
|
+
# measure_foreground: "HexColor",
|
8863
|
+
# }
|
8864
|
+
#
|
8865
|
+
# @!attribute [rw] primary_foreground
|
8866
|
+
# The color of text and other foreground elements that appear over the
|
8867
|
+
# primary background regions, such as grid lines, borders, table
|
8868
|
+
# banding, icons, and so on.
|
8869
|
+
# @return [String]
|
8870
|
+
#
|
8871
|
+
# @!attribute [rw] primary_background
|
8872
|
+
# The background color that applies to visuals and other high emphasis
|
8873
|
+
# UI.
|
8874
|
+
# @return [String]
|
8875
|
+
#
|
8876
|
+
# @!attribute [rw] secondary_foreground
|
8877
|
+
# The foreground color that applies to any sheet title, sheet control
|
8878
|
+
# text, or UI that appears over the secondary background.
|
8879
|
+
# @return [String]
|
8880
|
+
#
|
8881
|
+
# @!attribute [rw] secondary_background
|
8882
|
+
# The background color that applies to the sheet background and sheet
|
8883
|
+
# controls.
|
8884
|
+
# @return [String]
|
8885
|
+
#
|
8886
|
+
# @!attribute [rw] accent
|
8887
|
+
# This color is that applies to selected states and buttons.
|
8888
|
+
# @return [String]
|
8889
|
+
#
|
8890
|
+
# @!attribute [rw] accent_foreground
|
8891
|
+
# The foreground color that applies to any text or other elements that
|
8892
|
+
# appear over the accent color.
|
8893
|
+
# @return [String]
|
8894
|
+
#
|
8895
|
+
# @!attribute [rw] danger
|
8896
|
+
# The color that applies to error messages.
|
8897
|
+
# @return [String]
|
8898
|
+
#
|
8899
|
+
# @!attribute [rw] danger_foreground
|
8900
|
+
# The foreground color that applies to any text or other elements that
|
8901
|
+
# appear over the error color.
|
8902
|
+
# @return [String]
|
8903
|
+
#
|
8904
|
+
# @!attribute [rw] warning
|
8905
|
+
# This color that applies to warning and informational messages.
|
8906
|
+
# @return [String]
|
8907
|
+
#
|
8908
|
+
# @!attribute [rw] warning_foreground
|
8909
|
+
# The foreground color that applies to any text or other elements that
|
8910
|
+
# appear over the warning color.
|
8911
|
+
# @return [String]
|
8912
|
+
#
|
8913
|
+
# @!attribute [rw] success
|
8914
|
+
# The color that applies to success messages, for example the check
|
8915
|
+
# mark for a successful download.
|
8916
|
+
# @return [String]
|
8917
|
+
#
|
8918
|
+
# @!attribute [rw] success_foreground
|
8919
|
+
# The foreground color that applies to any text or other elements that
|
8920
|
+
# appear over the success color.
|
8921
|
+
# @return [String]
|
8922
|
+
#
|
8923
|
+
# @!attribute [rw] dimension
|
8924
|
+
# The color that applies to the names of fields that are identified as
|
8925
|
+
# dimensions.
|
8926
|
+
# @return [String]
|
8927
|
+
#
|
8928
|
+
# @!attribute [rw] dimension_foreground
|
8929
|
+
# The foreground color that applies to any text or other elements that
|
8930
|
+
# appear over the dimension color.
|
8931
|
+
# @return [String]
|
8932
|
+
#
|
8933
|
+
# @!attribute [rw] measure
|
8934
|
+
# The color that applies to the names of fields that are identified as
|
8935
|
+
# measures.
|
8936
|
+
# @return [String]
|
8937
|
+
#
|
8938
|
+
# @!attribute [rw] measure_foreground
|
8939
|
+
# The foreground color that applies to any text or other elements that
|
8940
|
+
# appear over the measure color.
|
8941
|
+
# @return [String]
|
8942
|
+
#
|
8943
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UIColorPalette AWS API Documentation
|
8944
|
+
#
|
8945
|
+
class UIColorPalette < Struct.new(
|
8946
|
+
:primary_foreground,
|
8947
|
+
:primary_background,
|
8948
|
+
:secondary_foreground,
|
8949
|
+
:secondary_background,
|
8950
|
+
:accent,
|
8951
|
+
:accent_foreground,
|
8952
|
+
:danger,
|
8953
|
+
:danger_foreground,
|
8954
|
+
:warning,
|
8955
|
+
:warning_foreground,
|
8956
|
+
:success,
|
8957
|
+
:success_foreground,
|
8958
|
+
:dimension,
|
8959
|
+
:dimension_foreground,
|
8960
|
+
:measure,
|
8961
|
+
:measure_foreground)
|
8962
|
+
SENSITIVE = []
|
8963
|
+
include Aws::Structure
|
8964
|
+
end
|
8965
|
+
|
7607
8966
|
# This error indicates that you are calling an operation on an Amazon
|
7608
8967
|
# QuickSight subscription where the edition doesn't include support for
|
7609
8968
|
# that operation. Amazon QuickSight currently has Standard Edition and
|
@@ -7865,6 +9224,7 @@ module Aws::QuickSight
|
|
7865
9224
|
# visibility_state: "EXPANDED", # accepts EXPANDED, COLLAPSED
|
7866
9225
|
# },
|
7867
9226
|
# },
|
9227
|
+
# theme_arn: "Arn",
|
7868
9228
|
# }
|
7869
9229
|
#
|
7870
9230
|
# @!attribute [rw] aws_account_id
|
@@ -7925,6 +9285,13 @@ module Aws::QuickSight
|
|
7925
9285
|
# `COLLAPSED` by default.
|
7926
9286
|
# @return [Types::DashboardPublishOptions]
|
7927
9287
|
#
|
9288
|
+
# @!attribute [rw] theme_arn
|
9289
|
+
# The Amazon Resource Name (ARN) of the theme that is being used for
|
9290
|
+
# this dashboard. If you add a value for this field, it overrides the
|
9291
|
+
# value that was originally associated with the entity. The theme ARN
|
9292
|
+
# must exist in the same AWS account where you create the dashboard.
|
9293
|
+
# @return [String]
|
9294
|
+
#
|
7928
9295
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDashboardRequest AWS API Documentation
|
7929
9296
|
#
|
7930
9297
|
class UpdateDashboardRequest < Struct.new(
|
@@ -7934,7 +9301,8 @@ module Aws::QuickSight
|
|
7934
9301
|
:source_entity,
|
7935
9302
|
:parameters,
|
7936
9303
|
:version_description,
|
7937
|
-
:dashboard_publish_options
|
9304
|
+
:dashboard_publish_options,
|
9305
|
+
:theme_arn)
|
7938
9306
|
SENSITIVE = []
|
7939
9307
|
include Aws::Structure
|
7940
9308
|
end
|
@@ -9044,6 +10412,277 @@ module Aws::QuickSight
|
|
9044
10412
|
include Aws::Structure
|
9045
10413
|
end
|
9046
10414
|
|
10415
|
+
# @note When making an API call, you may pass UpdateThemeAliasRequest
|
10416
|
+
# data as a hash:
|
10417
|
+
#
|
10418
|
+
# {
|
10419
|
+
# aws_account_id: "AwsAccountId", # required
|
10420
|
+
# theme_id: "RestrictiveResourceId", # required
|
10421
|
+
# alias_name: "AliasName", # required
|
10422
|
+
# theme_version_number: 1, # required
|
10423
|
+
# }
|
10424
|
+
#
|
10425
|
+
# @!attribute [rw] aws_account_id
|
10426
|
+
# The ID of the AWS account that contains the theme alias that you're
|
10427
|
+
# updating.
|
10428
|
+
# @return [String]
|
10429
|
+
#
|
10430
|
+
# @!attribute [rw] theme_id
|
10431
|
+
# The ID for the theme.
|
10432
|
+
# @return [String]
|
10433
|
+
#
|
10434
|
+
# @!attribute [rw] alias_name
|
10435
|
+
# The name of the theme alias that you want to update.
|
10436
|
+
# @return [String]
|
10437
|
+
#
|
10438
|
+
# @!attribute [rw] theme_version_number
|
10439
|
+
# The version number of the theme that the alias should reference.
|
10440
|
+
# @return [Integer]
|
10441
|
+
#
|
10442
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateThemeAliasRequest AWS API Documentation
|
10443
|
+
#
|
10444
|
+
class UpdateThemeAliasRequest < Struct.new(
|
10445
|
+
:aws_account_id,
|
10446
|
+
:theme_id,
|
10447
|
+
:alias_name,
|
10448
|
+
:theme_version_number)
|
10449
|
+
SENSITIVE = []
|
10450
|
+
include Aws::Structure
|
10451
|
+
end
|
10452
|
+
|
10453
|
+
# @!attribute [rw] theme_alias
|
10454
|
+
# Information about the theme alias.
|
10455
|
+
# @return [Types::ThemeAlias]
|
10456
|
+
#
|
10457
|
+
# @!attribute [rw] status
|
10458
|
+
# The HTTP status of the request.
|
10459
|
+
# @return [Integer]
|
10460
|
+
#
|
10461
|
+
# @!attribute [rw] request_id
|
10462
|
+
# The AWS request ID for this operation.
|
10463
|
+
# @return [String]
|
10464
|
+
#
|
10465
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateThemeAliasResponse AWS API Documentation
|
10466
|
+
#
|
10467
|
+
class UpdateThemeAliasResponse < Struct.new(
|
10468
|
+
:theme_alias,
|
10469
|
+
:status,
|
10470
|
+
:request_id)
|
10471
|
+
SENSITIVE = []
|
10472
|
+
include Aws::Structure
|
10473
|
+
end
|
10474
|
+
|
10475
|
+
# @note When making an API call, you may pass UpdateThemePermissionsRequest
|
10476
|
+
# data as a hash:
|
10477
|
+
#
|
10478
|
+
# {
|
10479
|
+
# aws_account_id: "AwsAccountId", # required
|
10480
|
+
# theme_id: "RestrictiveResourceId", # required
|
10481
|
+
# grant_permissions: [
|
10482
|
+
# {
|
10483
|
+
# principal: "Principal", # required
|
10484
|
+
# actions: ["String"], # required
|
10485
|
+
# },
|
10486
|
+
# ],
|
10487
|
+
# revoke_permissions: [
|
10488
|
+
# {
|
10489
|
+
# principal: "Principal", # required
|
10490
|
+
# actions: ["String"], # required
|
10491
|
+
# },
|
10492
|
+
# ],
|
10493
|
+
# }
|
10494
|
+
#
|
10495
|
+
# @!attribute [rw] aws_account_id
|
10496
|
+
# The ID of the AWS account that contains the theme.
|
10497
|
+
# @return [String]
|
10498
|
+
#
|
10499
|
+
# @!attribute [rw] theme_id
|
10500
|
+
# The ID for the theme.
|
10501
|
+
# @return [String]
|
10502
|
+
#
|
10503
|
+
# @!attribute [rw] grant_permissions
|
10504
|
+
# A list of resource permissions to be granted for the theme.
|
10505
|
+
# @return [Array<Types::ResourcePermission>]
|
10506
|
+
#
|
10507
|
+
# @!attribute [rw] revoke_permissions
|
10508
|
+
# A list of resource permissions to be revoked from the theme.
|
10509
|
+
# @return [Array<Types::ResourcePermission>]
|
10510
|
+
#
|
10511
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateThemePermissionsRequest AWS API Documentation
|
10512
|
+
#
|
10513
|
+
class UpdateThemePermissionsRequest < Struct.new(
|
10514
|
+
:aws_account_id,
|
10515
|
+
:theme_id,
|
10516
|
+
:grant_permissions,
|
10517
|
+
:revoke_permissions)
|
10518
|
+
SENSITIVE = []
|
10519
|
+
include Aws::Structure
|
10520
|
+
end
|
10521
|
+
|
10522
|
+
# @!attribute [rw] theme_id
|
10523
|
+
# The ID for the theme.
|
10524
|
+
# @return [String]
|
10525
|
+
#
|
10526
|
+
# @!attribute [rw] theme_arn
|
10527
|
+
# The Amazon Resource Name (ARN) of the theme.
|
10528
|
+
# @return [String]
|
10529
|
+
#
|
10530
|
+
# @!attribute [rw] permissions
|
10531
|
+
# The resulting list of resource permissions for the theme.
|
10532
|
+
# @return [Array<Types::ResourcePermission>]
|
10533
|
+
#
|
10534
|
+
# @!attribute [rw] request_id
|
10535
|
+
# The AWS request ID for this operation.
|
10536
|
+
# @return [String]
|
10537
|
+
#
|
10538
|
+
# @!attribute [rw] status
|
10539
|
+
# The HTTP status of the request.
|
10540
|
+
# @return [Integer]
|
10541
|
+
#
|
10542
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateThemePermissionsResponse AWS API Documentation
|
10543
|
+
#
|
10544
|
+
class UpdateThemePermissionsResponse < Struct.new(
|
10545
|
+
:theme_id,
|
10546
|
+
:theme_arn,
|
10547
|
+
:permissions,
|
10548
|
+
:request_id,
|
10549
|
+
:status)
|
10550
|
+
SENSITIVE = []
|
10551
|
+
include Aws::Structure
|
10552
|
+
end
|
10553
|
+
|
10554
|
+
# @note When making an API call, you may pass UpdateThemeRequest
|
10555
|
+
# data as a hash:
|
10556
|
+
#
|
10557
|
+
# {
|
10558
|
+
# aws_account_id: "AwsAccountId", # required
|
10559
|
+
# theme_id: "RestrictiveResourceId", # required
|
10560
|
+
# name: "ThemeName",
|
10561
|
+
# base_theme_id: "RestrictiveResourceId", # required
|
10562
|
+
# version_description: "VersionDescription",
|
10563
|
+
# configuration: {
|
10564
|
+
# data_color_palette: {
|
10565
|
+
# colors: ["HexColor"],
|
10566
|
+
# min_max_gradient: ["HexColor"],
|
10567
|
+
# empty_fill_color: "HexColor",
|
10568
|
+
# },
|
10569
|
+
# ui_color_palette: {
|
10570
|
+
# primary_foreground: "HexColor",
|
10571
|
+
# primary_background: "HexColor",
|
10572
|
+
# secondary_foreground: "HexColor",
|
10573
|
+
# secondary_background: "HexColor",
|
10574
|
+
# accent: "HexColor",
|
10575
|
+
# accent_foreground: "HexColor",
|
10576
|
+
# danger: "HexColor",
|
10577
|
+
# danger_foreground: "HexColor",
|
10578
|
+
# warning: "HexColor",
|
10579
|
+
# warning_foreground: "HexColor",
|
10580
|
+
# success: "HexColor",
|
10581
|
+
# success_foreground: "HexColor",
|
10582
|
+
# dimension: "HexColor",
|
10583
|
+
# dimension_foreground: "HexColor",
|
10584
|
+
# measure: "HexColor",
|
10585
|
+
# measure_foreground: "HexColor",
|
10586
|
+
# },
|
10587
|
+
# sheet: {
|
10588
|
+
# tile: {
|
10589
|
+
# border: {
|
10590
|
+
# show: false,
|
10591
|
+
# },
|
10592
|
+
# },
|
10593
|
+
# tile_layout: {
|
10594
|
+
# gutter: {
|
10595
|
+
# show: false,
|
10596
|
+
# },
|
10597
|
+
# margin: {
|
10598
|
+
# show: false,
|
10599
|
+
# },
|
10600
|
+
# },
|
10601
|
+
# },
|
10602
|
+
# },
|
10603
|
+
# }
|
10604
|
+
#
|
10605
|
+
# @!attribute [rw] aws_account_id
|
10606
|
+
# The ID of the AWS account that contains the theme that you're
|
10607
|
+
# updating.
|
10608
|
+
# @return [String]
|
10609
|
+
#
|
10610
|
+
# @!attribute [rw] theme_id
|
10611
|
+
# The ID for the theme.
|
10612
|
+
# @return [String]
|
10613
|
+
#
|
10614
|
+
# @!attribute [rw] name
|
10615
|
+
# The name for the theme.
|
10616
|
+
# @return [String]
|
10617
|
+
#
|
10618
|
+
# @!attribute [rw] base_theme_id
|
10619
|
+
# The theme ID, defined by Amazon QuickSight, that a custom theme
|
10620
|
+
# inherits from. All themes initially inherit from a default
|
10621
|
+
# QuickSight theme.
|
10622
|
+
# @return [String]
|
10623
|
+
#
|
10624
|
+
# @!attribute [rw] version_description
|
10625
|
+
# A description of the theme version that you're updating Every time
|
10626
|
+
# that you call `UpdateTheme`, you create a new version of the theme.
|
10627
|
+
# Each version of the theme maintains a description of the version in
|
10628
|
+
# `VersionDescription`.
|
10629
|
+
# @return [String]
|
10630
|
+
#
|
10631
|
+
# @!attribute [rw] configuration
|
10632
|
+
# The theme configuration, which contains the theme display
|
10633
|
+
# properties.
|
10634
|
+
# @return [Types::ThemeConfiguration]
|
10635
|
+
#
|
10636
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateThemeRequest AWS API Documentation
|
10637
|
+
#
|
10638
|
+
class UpdateThemeRequest < Struct.new(
|
10639
|
+
:aws_account_id,
|
10640
|
+
:theme_id,
|
10641
|
+
:name,
|
10642
|
+
:base_theme_id,
|
10643
|
+
:version_description,
|
10644
|
+
:configuration)
|
10645
|
+
SENSITIVE = []
|
10646
|
+
include Aws::Structure
|
10647
|
+
end
|
10648
|
+
|
10649
|
+
# @!attribute [rw] theme_id
|
10650
|
+
# The ID for the theme.
|
10651
|
+
# @return [String]
|
10652
|
+
#
|
10653
|
+
# @!attribute [rw] arn
|
10654
|
+
# The Amazon Resource Name (ARN) for the theme.
|
10655
|
+
# @return [String]
|
10656
|
+
#
|
10657
|
+
# @!attribute [rw] version_arn
|
10658
|
+
# The Amazon Resource Name (ARN) for the new version of the theme.
|
10659
|
+
# @return [String]
|
10660
|
+
#
|
10661
|
+
# @!attribute [rw] creation_status
|
10662
|
+
# The creation status of the theme.
|
10663
|
+
# @return [String]
|
10664
|
+
#
|
10665
|
+
# @!attribute [rw] status
|
10666
|
+
# The HTTP status of the request.
|
10667
|
+
# @return [Integer]
|
10668
|
+
#
|
10669
|
+
# @!attribute [rw] request_id
|
10670
|
+
# The AWS request ID for this operation.
|
10671
|
+
# @return [String]
|
10672
|
+
#
|
10673
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateThemeResponse AWS API Documentation
|
10674
|
+
#
|
10675
|
+
class UpdateThemeResponse < Struct.new(
|
10676
|
+
:theme_id,
|
10677
|
+
:arn,
|
10678
|
+
:version_arn,
|
10679
|
+
:creation_status,
|
10680
|
+
:status,
|
10681
|
+
:request_id)
|
10682
|
+
SENSITIVE = []
|
10683
|
+
include Aws::Structure
|
10684
|
+
end
|
10685
|
+
|
9047
10686
|
# @note When making an API call, you may pass UpdateUserRequest
|
9048
10687
|
# data as a hash:
|
9049
10688
|
#
|