aws-sdk-quicksight 1.71.0 → 1.72.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +11 -1
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight/client.rb +275 -342
- data/lib/aws-sdk-quicksight/client_api.rb +3371 -103
- data/lib/aws-sdk-quicksight/endpoints.rb +42 -0
- data/lib/aws-sdk-quicksight/plugins/endpoints.rb +6 -0
- data/lib/aws-sdk-quicksight/types.rb +20480 -11645
- data/lib/aws-sdk-quicksight.rb +1 -1
- metadata +2 -2
@@ -728,7 +728,7 @@ module Aws::QuickSight
|
|
728
728
|
#
|
729
729
|
# To specify no permissions, omit `Permissions`.
|
730
730
|
#
|
731
|
-
# @option params [
|
731
|
+
# @option params [Types::AnalysisSourceEntity] :source_entity
|
732
732
|
# A source entity to use for the analysis that you're creating. This
|
733
733
|
# metadata structure contains details that describe a source template
|
734
734
|
# and one or more datasets.
|
@@ -742,6 +742,12 @@ module Aws::QuickSight
|
|
742
742
|
# Contains a map of the key-value pairs for the resource tag or tags
|
743
743
|
# assigned to the analysis.
|
744
744
|
#
|
745
|
+
# @option params [Types::AnalysisDefinition] :definition
|
746
|
+
# The definition of an analysis.
|
747
|
+
#
|
748
|
+
# A definition is the data model of all features in a Dashboard,
|
749
|
+
# Template, or Analysis.
|
750
|
+
#
|
745
751
|
# @return [Types::CreateAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
746
752
|
#
|
747
753
|
# * {Types::CreateAnalysisResponse#arn #arn} => String
|
@@ -750,64 +756,6 @@ module Aws::QuickSight
|
|
750
756
|
# * {Types::CreateAnalysisResponse#status #status} => Integer
|
751
757
|
# * {Types::CreateAnalysisResponse#request_id #request_id} => String
|
752
758
|
#
|
753
|
-
# @example Request syntax with placeholder values
|
754
|
-
#
|
755
|
-
# resp = client.create_analysis({
|
756
|
-
# aws_account_id: "AwsAccountId", # required
|
757
|
-
# analysis_id: "RestrictiveResourceId", # required
|
758
|
-
# name: "AnalysisName", # required
|
759
|
-
# parameters: {
|
760
|
-
# string_parameters: [
|
761
|
-
# {
|
762
|
-
# name: "NonEmptyString", # required
|
763
|
-
# values: ["String"], # required
|
764
|
-
# },
|
765
|
-
# ],
|
766
|
-
# integer_parameters: [
|
767
|
-
# {
|
768
|
-
# name: "NonEmptyString", # required
|
769
|
-
# values: [1], # required
|
770
|
-
# },
|
771
|
-
# ],
|
772
|
-
# decimal_parameters: [
|
773
|
-
# {
|
774
|
-
# name: "NonEmptyString", # required
|
775
|
-
# values: [1.0], # required
|
776
|
-
# },
|
777
|
-
# ],
|
778
|
-
# date_time_parameters: [
|
779
|
-
# {
|
780
|
-
# name: "NonEmptyString", # required
|
781
|
-
# values: [Time.now], # required
|
782
|
-
# },
|
783
|
-
# ],
|
784
|
-
# },
|
785
|
-
# permissions: [
|
786
|
-
# {
|
787
|
-
# principal: "Principal", # required
|
788
|
-
# actions: ["String"], # required
|
789
|
-
# },
|
790
|
-
# ],
|
791
|
-
# source_entity: { # required
|
792
|
-
# source_template: {
|
793
|
-
# data_set_references: [ # required
|
794
|
-
# {
|
795
|
-
# data_set_placeholder: "NonEmptyString", # required
|
796
|
-
# data_set_arn: "Arn", # required
|
797
|
-
# },
|
798
|
-
# ],
|
799
|
-
# arn: "Arn", # required
|
800
|
-
# },
|
801
|
-
# },
|
802
|
-
# theme_arn: "Arn",
|
803
|
-
# tags: [
|
804
|
-
# {
|
805
|
-
# key: "TagKey", # required
|
806
|
-
# value: "TagValue", # required
|
807
|
-
# },
|
808
|
-
# ],
|
809
|
-
# })
|
810
|
-
#
|
811
759
|
# @example Response structure
|
812
760
|
#
|
813
761
|
# resp.arn #=> String
|
@@ -857,7 +805,7 @@ module Aws::QuickSight
|
|
857
805
|
#
|
858
806
|
# To specify no permissions, omit the permissions list.
|
859
807
|
#
|
860
|
-
# @option params [
|
808
|
+
# @option params [Types::DashboardSourceEntity] :source_entity
|
861
809
|
# The entity that you are using as a source when you create the
|
862
810
|
# dashboard. In `SourceEntity`, you specify the type of object you're
|
863
811
|
# using as source. You can only create a dashboard from a template, so
|
@@ -903,6 +851,12 @@ module Aws::QuickSight
|
|
903
851
|
# value that is used in the source entity. The theme ARN must exist in
|
904
852
|
# the same Amazon Web Services account where you create the dashboard.
|
905
853
|
#
|
854
|
+
# @option params [Types::DashboardVersionDefinition] :definition
|
855
|
+
# The definition of a dashboard.
|
856
|
+
#
|
857
|
+
# A definition is the data model of all features in a Dashboard,
|
858
|
+
# Template, or Analysis.
|
859
|
+
#
|
906
860
|
# @return [Types::CreateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
907
861
|
#
|
908
862
|
# * {Types::CreateDashboardResponse#arn #arn} => String
|
@@ -912,76 +866,6 @@ module Aws::QuickSight
|
|
912
866
|
# * {Types::CreateDashboardResponse#status #status} => Integer
|
913
867
|
# * {Types::CreateDashboardResponse#request_id #request_id} => String
|
914
868
|
#
|
915
|
-
# @example Request syntax with placeholder values
|
916
|
-
#
|
917
|
-
# resp = client.create_dashboard({
|
918
|
-
# aws_account_id: "AwsAccountId", # required
|
919
|
-
# dashboard_id: "RestrictiveResourceId", # required
|
920
|
-
# name: "DashboardName", # required
|
921
|
-
# parameters: {
|
922
|
-
# string_parameters: [
|
923
|
-
# {
|
924
|
-
# name: "NonEmptyString", # required
|
925
|
-
# values: ["String"], # required
|
926
|
-
# },
|
927
|
-
# ],
|
928
|
-
# integer_parameters: [
|
929
|
-
# {
|
930
|
-
# name: "NonEmptyString", # required
|
931
|
-
# values: [1], # required
|
932
|
-
# },
|
933
|
-
# ],
|
934
|
-
# decimal_parameters: [
|
935
|
-
# {
|
936
|
-
# name: "NonEmptyString", # required
|
937
|
-
# values: [1.0], # required
|
938
|
-
# },
|
939
|
-
# ],
|
940
|
-
# date_time_parameters: [
|
941
|
-
# {
|
942
|
-
# name: "NonEmptyString", # required
|
943
|
-
# values: [Time.now], # required
|
944
|
-
# },
|
945
|
-
# ],
|
946
|
-
# },
|
947
|
-
# permissions: [
|
948
|
-
# {
|
949
|
-
# principal: "Principal", # required
|
950
|
-
# actions: ["String"], # required
|
951
|
-
# },
|
952
|
-
# ],
|
953
|
-
# source_entity: { # required
|
954
|
-
# source_template: {
|
955
|
-
# data_set_references: [ # required
|
956
|
-
# {
|
957
|
-
# data_set_placeholder: "NonEmptyString", # required
|
958
|
-
# data_set_arn: "Arn", # required
|
959
|
-
# },
|
960
|
-
# ],
|
961
|
-
# arn: "Arn", # required
|
962
|
-
# },
|
963
|
-
# },
|
964
|
-
# tags: [
|
965
|
-
# {
|
966
|
-
# key: "TagKey", # required
|
967
|
-
# value: "TagValue", # required
|
968
|
-
# },
|
969
|
-
# ],
|
970
|
-
# version_description: "VersionDescription",
|
971
|
-
# dashboard_publish_options: {
|
972
|
-
# ad_hoc_filtering_option: {
|
973
|
-
# availability_status: "ENABLED", # accepts ENABLED, DISABLED
|
974
|
-
# },
|
975
|
-
# export_to_csv_option: {
|
976
|
-
# availability_status: "ENABLED", # accepts ENABLED, DISABLED
|
977
|
-
# },
|
978
|
-
# sheet_controls_option: {
|
979
|
-
# visibility_state: "EXPANDED", # accepts EXPANDED, COLLAPSED
|
980
|
-
# },
|
981
|
-
# },
|
982
|
-
# theme_arn: "Arn",
|
983
|
-
# })
|
984
|
-
#
|
985
869
|
# @example Response structure
|
986
870
|
#
|
987
871
|
# resp.arn #=> String
|
@@ -2033,7 +1917,7 @@ module Aws::QuickSight
|
|
2033
1917
|
# @option params [Array<Types::ResourcePermission>] :permissions
|
2034
1918
|
# A list of resource permissions to be set on the template.
|
2035
1919
|
#
|
2036
|
-
# @option params [
|
1920
|
+
# @option params [Types::TemplateSourceEntity] :source_entity
|
2037
1921
|
# The entity that you are using as a source when you create the
|
2038
1922
|
# template. In `SourceEntity`, you specify the type of object you're
|
2039
1923
|
# using as source: `SourceTemplate` for a template or `SourceAnalysis`
|
@@ -2059,6 +1943,12 @@ module Aws::QuickSight
|
|
2059
1943
|
# the template maintains a description of the version in the
|
2060
1944
|
# `VersionDescription` field.
|
2061
1945
|
#
|
1946
|
+
# @option params [Types::TemplateVersionDefinition] :definition
|
1947
|
+
# The definition of a template.
|
1948
|
+
#
|
1949
|
+
# A definition is the data model of all features in a Dashboard,
|
1950
|
+
# Template, or Analysis.
|
1951
|
+
#
|
2062
1952
|
# @return [Types::CreateTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2063
1953
|
#
|
2064
1954
|
# * {Types::CreateTemplateResponse#arn #arn} => String
|
@@ -2068,41 +1958,6 @@ module Aws::QuickSight
|
|
2068
1958
|
# * {Types::CreateTemplateResponse#status #status} => Integer
|
2069
1959
|
# * {Types::CreateTemplateResponse#request_id #request_id} => String
|
2070
1960
|
#
|
2071
|
-
# @example Request syntax with placeholder values
|
2072
|
-
#
|
2073
|
-
# resp = client.create_template({
|
2074
|
-
# aws_account_id: "AwsAccountId", # required
|
2075
|
-
# template_id: "RestrictiveResourceId", # required
|
2076
|
-
# name: "TemplateName",
|
2077
|
-
# permissions: [
|
2078
|
-
# {
|
2079
|
-
# principal: "Principal", # required
|
2080
|
-
# actions: ["String"], # required
|
2081
|
-
# },
|
2082
|
-
# ],
|
2083
|
-
# source_entity: { # required
|
2084
|
-
# source_analysis: {
|
2085
|
-
# arn: "Arn", # required
|
2086
|
-
# data_set_references: [ # required
|
2087
|
-
# {
|
2088
|
-
# data_set_placeholder: "NonEmptyString", # required
|
2089
|
-
# data_set_arn: "Arn", # required
|
2090
|
-
# },
|
2091
|
-
# ],
|
2092
|
-
# },
|
2093
|
-
# source_template: {
|
2094
|
-
# arn: "Arn", # required
|
2095
|
-
# },
|
2096
|
-
# },
|
2097
|
-
# tags: [
|
2098
|
-
# {
|
2099
|
-
# key: "TagKey", # required
|
2100
|
-
# value: "TagValue", # required
|
2101
|
-
# },
|
2102
|
-
# ],
|
2103
|
-
# version_description: "VersionDescription",
|
2104
|
-
# })
|
2105
|
-
#
|
2106
1961
|
# @example Response structure
|
2107
1962
|
#
|
2108
1963
|
# resp.arn #=> String
|
@@ -2148,7 +2003,7 @@ module Aws::QuickSight
|
|
2148
2003
|
#
|
2149
2004
|
# resp = client.create_template_alias({
|
2150
2005
|
# aws_account_id: "AwsAccountId", # required
|
2151
|
-
# template_id: "
|
2006
|
+
# template_id: "ShortRestrictiveResourceId", # required
|
2152
2007
|
# alias_name: "AliasName", # required
|
2153
2008
|
# template_version_number: 1, # required
|
2154
2009
|
# })
|
@@ -2226,9 +2081,9 @@ module Aws::QuickSight
|
|
2226
2081
|
#
|
2227
2082
|
# resp = client.create_theme({
|
2228
2083
|
# aws_account_id: "AwsAccountId", # required
|
2229
|
-
# theme_id: "
|
2084
|
+
# theme_id: "ShortRestrictiveResourceId", # required
|
2230
2085
|
# name: "ThemeName", # required
|
2231
|
-
# base_theme_id: "
|
2086
|
+
# base_theme_id: "ShortRestrictiveResourceId", # required
|
2232
2087
|
# version_description: "VersionDescription",
|
2233
2088
|
# configuration: { # required
|
2234
2089
|
# data_color_palette: {
|
@@ -2269,6 +2124,13 @@ module Aws::QuickSight
|
|
2269
2124
|
# },
|
2270
2125
|
# },
|
2271
2126
|
# },
|
2127
|
+
# typography: {
|
2128
|
+
# font_families: [
|
2129
|
+
# {
|
2130
|
+
# font_family: "String",
|
2131
|
+
# },
|
2132
|
+
# ],
|
2133
|
+
# },
|
2272
2134
|
# },
|
2273
2135
|
# permissions: [
|
2274
2136
|
# {
|
@@ -2329,7 +2191,7 @@ module Aws::QuickSight
|
|
2329
2191
|
#
|
2330
2192
|
# resp = client.create_theme_alias({
|
2331
2193
|
# aws_account_id: "AwsAccountId", # required
|
2332
|
-
# theme_id: "
|
2194
|
+
# theme_id: "ShortRestrictiveResourceId", # required
|
2333
2195
|
# alias_name: "AliasName", # required
|
2334
2196
|
# theme_version_number: 1, # required
|
2335
2197
|
# })
|
@@ -2476,7 +2338,7 @@ module Aws::QuickSight
|
|
2476
2338
|
#
|
2477
2339
|
# resp = client.delete_analysis({
|
2478
2340
|
# aws_account_id: "AwsAccountId", # required
|
2479
|
-
# analysis_id: "
|
2341
|
+
# analysis_id: "ShortRestrictiveResourceId", # required
|
2480
2342
|
# recovery_window_in_days: 1,
|
2481
2343
|
# force_delete_without_recovery: false,
|
2482
2344
|
# })
|
@@ -2522,7 +2384,7 @@ module Aws::QuickSight
|
|
2522
2384
|
#
|
2523
2385
|
# resp = client.delete_dashboard({
|
2524
2386
|
# aws_account_id: "AwsAccountId", # required
|
2525
|
-
# dashboard_id: "
|
2387
|
+
# dashboard_id: "ShortRestrictiveResourceId", # required
|
2526
2388
|
# version_number: 1,
|
2527
2389
|
# })
|
2528
2390
|
#
|
@@ -2895,7 +2757,7 @@ module Aws::QuickSight
|
|
2895
2757
|
#
|
2896
2758
|
# resp = client.delete_template({
|
2897
2759
|
# aws_account_id: "AwsAccountId", # required
|
2898
|
-
# template_id: "
|
2760
|
+
# template_id: "ShortRestrictiveResourceId", # required
|
2899
2761
|
# version_number: 1,
|
2900
2762
|
# })
|
2901
2763
|
#
|
@@ -2944,7 +2806,7 @@ module Aws::QuickSight
|
|
2944
2806
|
#
|
2945
2807
|
# resp = client.delete_template_alias({
|
2946
2808
|
# aws_account_id: "AwsAccountId", # required
|
2947
|
-
# template_id: "
|
2809
|
+
# template_id: "ShortRestrictiveResourceId", # required
|
2948
2810
|
# alias_name: "AliasName", # required
|
2949
2811
|
# })
|
2950
2812
|
#
|
@@ -2991,7 +2853,7 @@ module Aws::QuickSight
|
|
2991
2853
|
#
|
2992
2854
|
# resp = client.delete_theme({
|
2993
2855
|
# aws_account_id: "AwsAccountId", # required
|
2994
|
-
# theme_id: "
|
2856
|
+
# theme_id: "ShortRestrictiveResourceId", # required
|
2995
2857
|
# version_number: 1,
|
2996
2858
|
# })
|
2997
2859
|
#
|
@@ -3037,7 +2899,7 @@ module Aws::QuickSight
|
|
3037
2899
|
#
|
3038
2900
|
# resp = client.delete_theme_alias({
|
3039
2901
|
# aws_account_id: "AwsAccountId", # required
|
3040
|
-
# theme_id: "
|
2902
|
+
# theme_id: "ShortRestrictiveResourceId", # required
|
3041
2903
|
# alias_name: "AliasName", # required
|
3042
2904
|
# })
|
3043
2905
|
#
|
@@ -3354,7 +3216,7 @@ module Aws::QuickSight
|
|
3354
3216
|
#
|
3355
3217
|
# resp = client.describe_analysis({
|
3356
3218
|
# aws_account_id: "AwsAccountId", # required
|
3357
|
-
# analysis_id: "
|
3219
|
+
# analysis_id: "ShortRestrictiveResourceId", # required
|
3358
3220
|
# })
|
3359
3221
|
#
|
3360
3222
|
# @example Response structure
|
@@ -3366,6 +3228,8 @@ module Aws::QuickSight
|
|
3366
3228
|
# resp.analysis.errors #=> Array
|
3367
3229
|
# resp.analysis.errors[0].type #=> String, one of "ACCESS_DENIED", "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE", "PARAMETER_VALUE_INCOMPATIBLE", "PARAMETER_TYPE_INVALID", "PARAMETER_NOT_FOUND", "COLUMN_TYPE_MISMATCH", "COLUMN_GEOGRAPHIC_ROLE_MISMATCH", "COLUMN_REPLACEMENT_MISSING"
|
3368
3230
|
# resp.analysis.errors[0].message #=> String
|
3231
|
+
# resp.analysis.errors[0].violated_entities #=> Array
|
3232
|
+
# resp.analysis.errors[0].violated_entities[0].path #=> String
|
3369
3233
|
# resp.analysis.data_set_arns #=> Array
|
3370
3234
|
# resp.analysis.data_set_arns[0] #=> String
|
3371
3235
|
# resp.analysis.theme_arn #=> String
|
@@ -3386,6 +3250,55 @@ module Aws::QuickSight
|
|
3386
3250
|
req.send_request(options)
|
3387
3251
|
end
|
3388
3252
|
|
3253
|
+
# Provides a detailed description of the definition of an analysis.
|
3254
|
+
#
|
3255
|
+
# <note markdown="1"> If you do not need to know details about the content of an Analysis,
|
3256
|
+
# for instance if you are trying to check the status of a recently
|
3257
|
+
# created or updated Analysis, use the [ `DescribeAnalysis` ][1]
|
3258
|
+
# instead.
|
3259
|
+
#
|
3260
|
+
# </note>
|
3261
|
+
#
|
3262
|
+
#
|
3263
|
+
#
|
3264
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeAnalysis.html
|
3265
|
+
#
|
3266
|
+
# @option params [required, String] :aws_account_id
|
3267
|
+
# The ID of the Amazon Web Services account that contains the analysis.
|
3268
|
+
# You must be using the Amazon Web Services account that the analysis is
|
3269
|
+
# in.
|
3270
|
+
#
|
3271
|
+
# @option params [required, String] :analysis_id
|
3272
|
+
# The ID of the analysis that you're describing. The ID is part of the
|
3273
|
+
# URL of the analysis.
|
3274
|
+
#
|
3275
|
+
# @return [Types::DescribeAnalysisDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3276
|
+
#
|
3277
|
+
# * {Types::DescribeAnalysisDefinitionResponse#analysis_id #analysis_id} => String
|
3278
|
+
# * {Types::DescribeAnalysisDefinitionResponse#name #name} => String
|
3279
|
+
# * {Types::DescribeAnalysisDefinitionResponse#errors #errors} => Array<Types::AnalysisError>
|
3280
|
+
# * {Types::DescribeAnalysisDefinitionResponse#resource_status #resource_status} => String
|
3281
|
+
# * {Types::DescribeAnalysisDefinitionResponse#theme_arn #theme_arn} => String
|
3282
|
+
# * {Types::DescribeAnalysisDefinitionResponse#definition #definition} => Types::AnalysisDefinition
|
3283
|
+
# * {Types::DescribeAnalysisDefinitionResponse#status #status} => Integer
|
3284
|
+
# * {Types::DescribeAnalysisDefinitionResponse#request_id #request_id} => String
|
3285
|
+
#
|
3286
|
+
# @example Request syntax with placeholder values
|
3287
|
+
#
|
3288
|
+
# resp = client.describe_analysis_definition({
|
3289
|
+
# aws_account_id: "AwsAccountId", # required
|
3290
|
+
# analysis_id: "ShortRestrictiveResourceId", # required
|
3291
|
+
# })
|
3292
|
+
#
|
3293
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysisDefinition AWS API Documentation
|
3294
|
+
#
|
3295
|
+
# @overload describe_analysis_definition(params = {})
|
3296
|
+
# @param [Hash] params ({})
|
3297
|
+
def describe_analysis_definition(params = {}, options = {})
|
3298
|
+
req = build_request(:describe_analysis_definition, params)
|
3299
|
+
req.send_request(options)
|
3300
|
+
end
|
3301
|
+
|
3389
3302
|
# Provides the read and write permissions for an analysis.
|
3390
3303
|
#
|
3391
3304
|
# @option params [required, String] :aws_account_id
|
@@ -3409,7 +3322,7 @@ module Aws::QuickSight
|
|
3409
3322
|
#
|
3410
3323
|
# resp = client.describe_analysis_permissions({
|
3411
3324
|
# aws_account_id: "AwsAccountId", # required
|
3412
|
-
# analysis_id: "
|
3325
|
+
# analysis_id: "ShortRestrictiveResourceId", # required
|
3413
3326
|
# })
|
3414
3327
|
#
|
3415
3328
|
# @example Response structure
|
@@ -3458,7 +3371,7 @@ module Aws::QuickSight
|
|
3458
3371
|
#
|
3459
3372
|
# resp = client.describe_dashboard({
|
3460
3373
|
# aws_account_id: "AwsAccountId", # required
|
3461
|
-
# dashboard_id: "
|
3374
|
+
# dashboard_id: "ShortRestrictiveResourceId", # required
|
3462
3375
|
# version_number: 1,
|
3463
3376
|
# alias_name: "AliasName",
|
3464
3377
|
# })
|
@@ -3472,6 +3385,8 @@ module Aws::QuickSight
|
|
3472
3385
|
# resp.dashboard.version.errors #=> Array
|
3473
3386
|
# resp.dashboard.version.errors[0].type #=> String, one of "ACCESS_DENIED", "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE", "PARAMETER_VALUE_INCOMPATIBLE", "PARAMETER_TYPE_INVALID", "PARAMETER_NOT_FOUND", "COLUMN_TYPE_MISMATCH", "COLUMN_GEOGRAPHIC_ROLE_MISMATCH", "COLUMN_REPLACEMENT_MISSING"
|
3474
3387
|
# resp.dashboard.version.errors[0].message #=> String
|
3388
|
+
# resp.dashboard.version.errors[0].violated_entities #=> Array
|
3389
|
+
# resp.dashboard.version.errors[0].violated_entities[0].path #=> String
|
3475
3390
|
# resp.dashboard.version.version_number #=> Integer
|
3476
3391
|
# resp.dashboard.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
3477
3392
|
# resp.dashboard.version.arn #=> String
|
@@ -3498,6 +3413,62 @@ module Aws::QuickSight
|
|
3498
3413
|
req.send_request(options)
|
3499
3414
|
end
|
3500
3415
|
|
3416
|
+
# Provides a detailed description of the definition of a dashboard.
|
3417
|
+
#
|
3418
|
+
# <note markdown="1"> If you do not need to know details about the content of a dashboard,
|
3419
|
+
# for instance if you are trying to check the status of a recently
|
3420
|
+
# created or updated dashboard, use the [ `DescribeDashboard` ][1]
|
3421
|
+
# instead.
|
3422
|
+
#
|
3423
|
+
# </note>
|
3424
|
+
#
|
3425
|
+
#
|
3426
|
+
#
|
3427
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeDashboard.html
|
3428
|
+
#
|
3429
|
+
# @option params [required, String] :aws_account_id
|
3430
|
+
# The ID of the Amazon Web Services account that contains the dashboard
|
3431
|
+
# that you're describing.
|
3432
|
+
#
|
3433
|
+
# @option params [required, String] :dashboard_id
|
3434
|
+
# The ID for the dashboard.
|
3435
|
+
#
|
3436
|
+
# @option params [Integer] :version_number
|
3437
|
+
# The version number for the dashboard. If a version number isn't
|
3438
|
+
# passed, the latest published dashboard version is described.
|
3439
|
+
#
|
3440
|
+
# @option params [String] :alias_name
|
3441
|
+
# The alias name.
|
3442
|
+
#
|
3443
|
+
# @return [Types::DescribeDashboardDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3444
|
+
#
|
3445
|
+
# * {Types::DescribeDashboardDefinitionResponse#dashboard_id #dashboard_id} => String
|
3446
|
+
# * {Types::DescribeDashboardDefinitionResponse#errors #errors} => Array<Types::DashboardError>
|
3447
|
+
# * {Types::DescribeDashboardDefinitionResponse#name #name} => String
|
3448
|
+
# * {Types::DescribeDashboardDefinitionResponse#resource_status #resource_status} => String
|
3449
|
+
# * {Types::DescribeDashboardDefinitionResponse#theme_arn #theme_arn} => String
|
3450
|
+
# * {Types::DescribeDashboardDefinitionResponse#definition #definition} => Types::DashboardVersionDefinition
|
3451
|
+
# * {Types::DescribeDashboardDefinitionResponse#status #status} => Integer
|
3452
|
+
# * {Types::DescribeDashboardDefinitionResponse#request_id #request_id} => String
|
3453
|
+
#
|
3454
|
+
# @example Request syntax with placeholder values
|
3455
|
+
#
|
3456
|
+
# resp = client.describe_dashboard_definition({
|
3457
|
+
# aws_account_id: "AwsAccountId", # required
|
3458
|
+
# dashboard_id: "ShortRestrictiveResourceId", # required
|
3459
|
+
# version_number: 1,
|
3460
|
+
# alias_name: "AliasName",
|
3461
|
+
# })
|
3462
|
+
#
|
3463
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardDefinition AWS API Documentation
|
3464
|
+
#
|
3465
|
+
# @overload describe_dashboard_definition(params = {})
|
3466
|
+
# @param [Hash] params ({})
|
3467
|
+
def describe_dashboard_definition(params = {}, options = {})
|
3468
|
+
req = build_request(:describe_dashboard_definition, params)
|
3469
|
+
req.send_request(options)
|
3470
|
+
end
|
3471
|
+
|
3501
3472
|
# Describes read and write permissions for a dashboard.
|
3502
3473
|
#
|
3503
3474
|
# @option params [required, String] :aws_account_id
|
@@ -3520,7 +3491,7 @@ module Aws::QuickSight
|
|
3520
3491
|
#
|
3521
3492
|
# resp = client.describe_dashboard_permissions({
|
3522
3493
|
# aws_account_id: "AwsAccountId", # required
|
3523
|
-
# dashboard_id: "
|
3494
|
+
# dashboard_id: "ShortRestrictiveResourceId", # required
|
3524
3495
|
# })
|
3525
3496
|
#
|
3526
3497
|
# @example Response structure
|
@@ -4363,7 +4334,7 @@ module Aws::QuickSight
|
|
4363
4334
|
#
|
4364
4335
|
# resp = client.describe_template({
|
4365
4336
|
# aws_account_id: "AwsAccountId", # required
|
4366
|
-
# template_id: "
|
4337
|
+
# template_id: "ShortRestrictiveResourceId", # required
|
4367
4338
|
# version_number: 1,
|
4368
4339
|
# alias_name: "AliasName",
|
4369
4340
|
# })
|
@@ -4376,6 +4347,8 @@ module Aws::QuickSight
|
|
4376
4347
|
# resp.template.version.errors #=> Array
|
4377
4348
|
# resp.template.version.errors[0].type #=> String, one of "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE", "ACCESS_DENIED"
|
4378
4349
|
# resp.template.version.errors[0].message #=> String
|
4350
|
+
# resp.template.version.errors[0].violated_entities #=> Array
|
4351
|
+
# resp.template.version.errors[0].violated_entities[0].path #=> String
|
4379
4352
|
# resp.template.version.version_number #=> Integer
|
4380
4353
|
# resp.template.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
4381
4354
|
# resp.template.version.data_set_configurations #=> Array
|
@@ -4435,7 +4408,7 @@ module Aws::QuickSight
|
|
4435
4408
|
#
|
4436
4409
|
# resp = client.describe_template_alias({
|
4437
4410
|
# aws_account_id: "AwsAccountId", # required
|
4438
|
-
# template_id: "
|
4411
|
+
# template_id: "ShortRestrictiveResourceId", # required
|
4439
4412
|
# alias_name: "AliasName", # required
|
4440
4413
|
# })
|
4441
4414
|
#
|
@@ -4456,6 +4429,66 @@ module Aws::QuickSight
|
|
4456
4429
|
req.send_request(options)
|
4457
4430
|
end
|
4458
4431
|
|
4432
|
+
# Provides a detailed description of the definition of a template.
|
4433
|
+
#
|
4434
|
+
# <note markdown="1"> If you do not need to know details about the content of a template,
|
4435
|
+
# for instance if you are trying to check the status of a recently
|
4436
|
+
# created or updated template, use the [ `DescribeTemplate` ][1]
|
4437
|
+
# instead.
|
4438
|
+
#
|
4439
|
+
# </note>
|
4440
|
+
#
|
4441
|
+
#
|
4442
|
+
#
|
4443
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeTemplate.html
|
4444
|
+
#
|
4445
|
+
# @option params [required, String] :aws_account_id
|
4446
|
+
# The ID of the Amazon Web Services account that contains the template.
|
4447
|
+
# You must be using the Amazon Web Services account that the template is
|
4448
|
+
# in.
|
4449
|
+
#
|
4450
|
+
# @option params [required, String] :template_id
|
4451
|
+
# The ID of the template that you're describing.
|
4452
|
+
#
|
4453
|
+
# @option params [Integer] :version_number
|
4454
|
+
# The version number of the template.
|
4455
|
+
#
|
4456
|
+
# @option params [String] :alias_name
|
4457
|
+
# The alias of the template that you want to describe. If you name a
|
4458
|
+
# specific alias, you describe the version that the alias points to. You
|
4459
|
+
# can specify the latest version of the template by providing the
|
4460
|
+
# keyword `$LATEST` in the `AliasName` parameter. The keyword
|
4461
|
+
# `$PUBLISHED` doesn't apply to templates.
|
4462
|
+
#
|
4463
|
+
# @return [Types::DescribeTemplateDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4464
|
+
#
|
4465
|
+
# * {Types::DescribeTemplateDefinitionResponse#name #name} => String
|
4466
|
+
# * {Types::DescribeTemplateDefinitionResponse#template_id #template_id} => String
|
4467
|
+
# * {Types::DescribeTemplateDefinitionResponse#errors #errors} => Array<Types::TemplateError>
|
4468
|
+
# * {Types::DescribeTemplateDefinitionResponse#resource_status #resource_status} => String
|
4469
|
+
# * {Types::DescribeTemplateDefinitionResponse#theme_arn #theme_arn} => String
|
4470
|
+
# * {Types::DescribeTemplateDefinitionResponse#definition #definition} => Types::TemplateVersionDefinition
|
4471
|
+
# * {Types::DescribeTemplateDefinitionResponse#status #status} => Integer
|
4472
|
+
# * {Types::DescribeTemplateDefinitionResponse#request_id #request_id} => String
|
4473
|
+
#
|
4474
|
+
# @example Request syntax with placeholder values
|
4475
|
+
#
|
4476
|
+
# resp = client.describe_template_definition({
|
4477
|
+
# aws_account_id: "AwsAccountId", # required
|
4478
|
+
# template_id: "ShortRestrictiveResourceId", # required
|
4479
|
+
# version_number: 1,
|
4480
|
+
# alias_name: "AliasName",
|
4481
|
+
# })
|
4482
|
+
#
|
4483
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTemplateDefinition AWS API Documentation
|
4484
|
+
#
|
4485
|
+
# @overload describe_template_definition(params = {})
|
4486
|
+
# @param [Hash] params ({})
|
4487
|
+
def describe_template_definition(params = {}, options = {})
|
4488
|
+
req = build_request(:describe_template_definition, params)
|
4489
|
+
req.send_request(options)
|
4490
|
+
end
|
4491
|
+
|
4459
4492
|
# Describes read and write permissions on a template.
|
4460
4493
|
#
|
4461
4494
|
# @option params [required, String] :aws_account_id
|
@@ -4477,7 +4510,7 @@ module Aws::QuickSight
|
|
4477
4510
|
#
|
4478
4511
|
# resp = client.describe_template_permissions({
|
4479
4512
|
# aws_account_id: "AwsAccountId", # required
|
4480
|
-
# template_id: "
|
4513
|
+
# template_id: "ShortRestrictiveResourceId", # required
|
4481
4514
|
# })
|
4482
4515
|
#
|
4483
4516
|
# @example Response structure
|
@@ -4531,7 +4564,7 @@ module Aws::QuickSight
|
|
4531
4564
|
#
|
4532
4565
|
# resp = client.describe_theme({
|
4533
4566
|
# aws_account_id: "AwsAndAccountId", # required
|
4534
|
-
# theme_id: "
|
4567
|
+
# theme_id: "ShortRestrictiveResourceId", # required
|
4535
4568
|
# version_number: 1,
|
4536
4569
|
# alias_name: "AliasName",
|
4537
4570
|
# })
|
@@ -4570,6 +4603,8 @@ module Aws::QuickSight
|
|
4570
4603
|
# resp.theme.version.configuration.sheet.tile.border.show #=> Boolean
|
4571
4604
|
# resp.theme.version.configuration.sheet.tile_layout.gutter.show #=> Boolean
|
4572
4605
|
# resp.theme.version.configuration.sheet.tile_layout.margin.show #=> Boolean
|
4606
|
+
# resp.theme.version.configuration.typography.font_families #=> Array
|
4607
|
+
# resp.theme.version.configuration.typography.font_families[0].font_family #=> String
|
4573
4608
|
# resp.theme.version.errors #=> Array
|
4574
4609
|
# resp.theme.version.errors[0].type #=> String, one of "INTERNAL_FAILURE"
|
4575
4610
|
# resp.theme.version.errors[0].message #=> String
|
@@ -4611,7 +4646,7 @@ module Aws::QuickSight
|
|
4611
4646
|
#
|
4612
4647
|
# resp = client.describe_theme_alias({
|
4613
4648
|
# aws_account_id: "AwsAccountId", # required
|
4614
|
-
# theme_id: "
|
4649
|
+
# theme_id: "ShortRestrictiveResourceId", # required
|
4615
4650
|
# alias_name: "AliasName", # required
|
4616
4651
|
# })
|
4617
4652
|
#
|
@@ -4653,7 +4688,7 @@ module Aws::QuickSight
|
|
4653
4688
|
#
|
4654
4689
|
# resp = client.describe_theme_permissions({
|
4655
4690
|
# aws_account_id: "AwsAccountId", # required
|
4656
|
-
# theme_id: "
|
4691
|
+
# theme_id: "ShortRestrictiveResourceId", # required
|
4657
4692
|
# })
|
4658
4693
|
#
|
4659
4694
|
# @example Response structure
|
@@ -4832,13 +4867,13 @@ module Aws::QuickSight
|
|
4832
4867
|
# authorized_resource_arns: ["Arn"], # required
|
4833
4868
|
# experience_configuration: { # required
|
4834
4869
|
# dashboard: {
|
4835
|
-
# initial_dashboard_id: "
|
4870
|
+
# initial_dashboard_id: "ShortRestrictiveResourceId", # required
|
4836
4871
|
# },
|
4837
4872
|
# dashboard_visual: {
|
4838
4873
|
# initial_dashboard_visual_id: { # required
|
4839
|
-
# dashboard_id: "
|
4840
|
-
# sheet_id: "
|
4841
|
-
# visual_id: "
|
4874
|
+
# dashboard_id: "ShortRestrictiveResourceId", # required
|
4875
|
+
# sheet_id: "ShortRestrictiveResourceId", # required
|
4876
|
+
# visual_id: "ShortRestrictiveResourceId", # required
|
4842
4877
|
# },
|
4843
4878
|
# },
|
4844
4879
|
# q_search_bar: {
|
@@ -4940,7 +4975,7 @@ module Aws::QuickSight
|
|
4940
4975
|
# user_arn: "Arn", # required
|
4941
4976
|
# experience_configuration: { # required
|
4942
4977
|
# dashboard: {
|
4943
|
-
# initial_dashboard_id: "
|
4978
|
+
# initial_dashboard_id: "ShortRestrictiveResourceId", # required
|
4944
4979
|
# },
|
4945
4980
|
# quick_sight_console: {
|
4946
4981
|
# initial_path: "EntryPath",
|
@@ -4950,9 +4985,9 @@ module Aws::QuickSight
|
|
4950
4985
|
# },
|
4951
4986
|
# dashboard_visual: {
|
4952
4987
|
# initial_dashboard_visual_id: { # required
|
4953
|
-
# dashboard_id: "
|
4954
|
-
# sheet_id: "
|
4955
|
-
# visual_id: "
|
4988
|
+
# dashboard_id: "ShortRestrictiveResourceId", # required
|
4989
|
+
# sheet_id: "ShortRestrictiveResourceId", # required
|
4990
|
+
# visual_id: "ShortRestrictiveResourceId", # required
|
4956
4991
|
# },
|
4957
4992
|
# },
|
4958
4993
|
# },
|
@@ -5082,7 +5117,7 @@ module Aws::QuickSight
|
|
5082
5117
|
#
|
5083
5118
|
# resp = client.get_dashboard_embed_url({
|
5084
5119
|
# aws_account_id: "AwsAccountId", # required
|
5085
|
-
# dashboard_id: "
|
5120
|
+
# dashboard_id: "ShortRestrictiveResourceId", # required
|
5086
5121
|
# identity_type: "IAM", # required, accepts IAM, QUICKSIGHT, ANONYMOUS
|
5087
5122
|
# session_lifetime_in_minutes: 1,
|
5088
5123
|
# undo_redo_disabled: false,
|
@@ -5090,7 +5125,7 @@ module Aws::QuickSight
|
|
5090
5125
|
# state_persistence_enabled: false,
|
5091
5126
|
# user_arn: "Arn",
|
5092
5127
|
# namespace: "Namespace",
|
5093
|
-
# additional_dashboard_ids: ["
|
5128
|
+
# additional_dashboard_ids: ["ShortRestrictiveResourceId"],
|
5094
5129
|
# })
|
5095
5130
|
#
|
5096
5131
|
# @example Response structure
|
@@ -5283,7 +5318,7 @@ module Aws::QuickSight
|
|
5283
5318
|
#
|
5284
5319
|
# resp = client.list_dashboard_versions({
|
5285
5320
|
# aws_account_id: "AwsAccountId", # required
|
5286
|
-
# dashboard_id: "
|
5321
|
+
# dashboard_id: "ShortRestrictiveResourceId", # required
|
5287
5322
|
# next_token: "String",
|
5288
5323
|
# max_results: 1,
|
5289
5324
|
# })
|
@@ -6094,7 +6129,7 @@ module Aws::QuickSight
|
|
6094
6129
|
#
|
6095
6130
|
# resp = client.list_template_aliases({
|
6096
6131
|
# aws_account_id: "AwsAccountId", # required
|
6097
|
-
# template_id: "
|
6132
|
+
# template_id: "ShortRestrictiveResourceId", # required
|
6098
6133
|
# next_token: "String",
|
6099
6134
|
# max_results: 1,
|
6100
6135
|
# })
|
@@ -6148,7 +6183,7 @@ module Aws::QuickSight
|
|
6148
6183
|
#
|
6149
6184
|
# resp = client.list_template_versions({
|
6150
6185
|
# aws_account_id: "AwsAccountId", # required
|
6151
|
-
# template_id: "
|
6186
|
+
# template_id: "ShortRestrictiveResourceId", # required
|
6152
6187
|
# next_token: "String",
|
6153
6188
|
# max_results: 1,
|
6154
6189
|
# })
|
@@ -6253,7 +6288,7 @@ module Aws::QuickSight
|
|
6253
6288
|
#
|
6254
6289
|
# resp = client.list_theme_aliases({
|
6255
6290
|
# aws_account_id: "AwsAccountId", # required
|
6256
|
-
# theme_id: "
|
6291
|
+
# theme_id: "ShortRestrictiveResourceId", # required
|
6257
6292
|
# next_token: "String",
|
6258
6293
|
# max_results: 1,
|
6259
6294
|
# })
|
@@ -6307,7 +6342,7 @@ module Aws::QuickSight
|
|
6307
6342
|
#
|
6308
6343
|
# resp = client.list_theme_versions({
|
6309
6344
|
# aws_account_id: "AwsAccountId", # required
|
6310
|
-
# theme_id: "
|
6345
|
+
# theme_id: "ShortRestrictiveResourceId", # required
|
6311
6346
|
# next_token: "String",
|
6312
6347
|
# max_results: 1,
|
6313
6348
|
# })
|
@@ -6702,7 +6737,7 @@ module Aws::QuickSight
|
|
6702
6737
|
#
|
6703
6738
|
# resp = client.restore_analysis({
|
6704
6739
|
# aws_account_id: "AwsAccountId", # required
|
6705
|
-
# analysis_id: "
|
6740
|
+
# analysis_id: "ShortRestrictiveResourceId", # required
|
6706
6741
|
# })
|
6707
6742
|
#
|
6708
6743
|
# @example Response structure
|
@@ -7348,7 +7383,7 @@ module Aws::QuickSight
|
|
7348
7383
|
# analysis can have any parameter type, and some parameters might accept
|
7349
7384
|
# multiple values.
|
7350
7385
|
#
|
7351
|
-
# @option params [
|
7386
|
+
# @option params [Types::AnalysisSourceEntity] :source_entity
|
7352
7387
|
# A source entity to use for the analysis that you're updating. This
|
7353
7388
|
# metadata structure contains details that describe a source template
|
7354
7389
|
# and one or more datasets.
|
@@ -7358,6 +7393,12 @@ module Aws::QuickSight
|
|
7358
7393
|
# that you're creating. To see the theme in the Amazon QuickSight
|
7359
7394
|
# console, make sure that you have access to it.
|
7360
7395
|
#
|
7396
|
+
# @option params [Types::AnalysisDefinition] :definition
|
7397
|
+
# The definition of an analysis.
|
7398
|
+
#
|
7399
|
+
# A definition is the data model of all features in a Dashboard,
|
7400
|
+
# Template, or Analysis.
|
7401
|
+
#
|
7361
7402
|
# @return [Types::UpdateAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7362
7403
|
#
|
7363
7404
|
# * {Types::UpdateAnalysisResponse#arn #arn} => String
|
@@ -7366,52 +7407,6 @@ module Aws::QuickSight
|
|
7366
7407
|
# * {Types::UpdateAnalysisResponse#status #status} => Integer
|
7367
7408
|
# * {Types::UpdateAnalysisResponse#request_id #request_id} => String
|
7368
7409
|
#
|
7369
|
-
# @example Request syntax with placeholder values
|
7370
|
-
#
|
7371
|
-
# resp = client.update_analysis({
|
7372
|
-
# aws_account_id: "AwsAccountId", # required
|
7373
|
-
# analysis_id: "RestrictiveResourceId", # required
|
7374
|
-
# name: "AnalysisName", # required
|
7375
|
-
# parameters: {
|
7376
|
-
# string_parameters: [
|
7377
|
-
# {
|
7378
|
-
# name: "NonEmptyString", # required
|
7379
|
-
# values: ["String"], # required
|
7380
|
-
# },
|
7381
|
-
# ],
|
7382
|
-
# integer_parameters: [
|
7383
|
-
# {
|
7384
|
-
# name: "NonEmptyString", # required
|
7385
|
-
# values: [1], # required
|
7386
|
-
# },
|
7387
|
-
# ],
|
7388
|
-
# decimal_parameters: [
|
7389
|
-
# {
|
7390
|
-
# name: "NonEmptyString", # required
|
7391
|
-
# values: [1.0], # required
|
7392
|
-
# },
|
7393
|
-
# ],
|
7394
|
-
# date_time_parameters: [
|
7395
|
-
# {
|
7396
|
-
# name: "NonEmptyString", # required
|
7397
|
-
# values: [Time.now], # required
|
7398
|
-
# },
|
7399
|
-
# ],
|
7400
|
-
# },
|
7401
|
-
# source_entity: { # required
|
7402
|
-
# source_template: {
|
7403
|
-
# data_set_references: [ # required
|
7404
|
-
# {
|
7405
|
-
# data_set_placeholder: "NonEmptyString", # required
|
7406
|
-
# data_set_arn: "Arn", # required
|
7407
|
-
# },
|
7408
|
-
# ],
|
7409
|
-
# arn: "Arn", # required
|
7410
|
-
# },
|
7411
|
-
# },
|
7412
|
-
# theme_arn: "Arn",
|
7413
|
-
# })
|
7414
|
-
#
|
7415
7410
|
# @example Response structure
|
7416
7411
|
#
|
7417
7412
|
# resp.arn #=> String
|
@@ -7460,7 +7455,7 @@ module Aws::QuickSight
|
|
7460
7455
|
#
|
7461
7456
|
# resp = client.update_analysis_permissions({
|
7462
7457
|
# aws_account_id: "AwsAccountId", # required
|
7463
|
-
# analysis_id: "
|
7458
|
+
# analysis_id: "ShortRestrictiveResourceId", # required
|
7464
7459
|
# grant_permissions: [
|
7465
7460
|
# {
|
7466
7461
|
# principal: "Principal", # required
|
@@ -7514,7 +7509,7 @@ module Aws::QuickSight
|
|
7514
7509
|
# @option params [required, String] :name
|
7515
7510
|
# The display name of the dashboard.
|
7516
7511
|
#
|
7517
|
-
# @option params [
|
7512
|
+
# @option params [Types::DashboardSourceEntity] :source_entity
|
7518
7513
|
# The entity that you are using as a source when you update the
|
7519
7514
|
# dashboard. In `SourceEntity`, you specify the type of object you're
|
7520
7515
|
# using as source. You can only update a dashboard from a template, so
|
@@ -7562,6 +7557,12 @@ module Aws::QuickSight
|
|
7562
7557
|
# must exist in the same Amazon Web Services account where you create
|
7563
7558
|
# the dashboard.
|
7564
7559
|
#
|
7560
|
+
# @option params [Types::DashboardVersionDefinition] :definition
|
7561
|
+
# The definition of a dashboard.
|
7562
|
+
#
|
7563
|
+
# A definition is the data model of all features in a Dashboard,
|
7564
|
+
# Template, or Analysis.
|
7565
|
+
#
|
7565
7566
|
# @return [Types::UpdateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7566
7567
|
#
|
7567
7568
|
# * {Types::UpdateDashboardResponse#arn #arn} => String
|
@@ -7571,64 +7572,6 @@ module Aws::QuickSight
|
|
7571
7572
|
# * {Types::UpdateDashboardResponse#status #status} => Integer
|
7572
7573
|
# * {Types::UpdateDashboardResponse#request_id #request_id} => String
|
7573
7574
|
#
|
7574
|
-
# @example Request syntax with placeholder values
|
7575
|
-
#
|
7576
|
-
# resp = client.update_dashboard({
|
7577
|
-
# aws_account_id: "AwsAccountId", # required
|
7578
|
-
# dashboard_id: "RestrictiveResourceId", # required
|
7579
|
-
# name: "DashboardName", # required
|
7580
|
-
# source_entity: { # required
|
7581
|
-
# source_template: {
|
7582
|
-
# data_set_references: [ # required
|
7583
|
-
# {
|
7584
|
-
# data_set_placeholder: "NonEmptyString", # required
|
7585
|
-
# data_set_arn: "Arn", # required
|
7586
|
-
# },
|
7587
|
-
# ],
|
7588
|
-
# arn: "Arn", # required
|
7589
|
-
# },
|
7590
|
-
# },
|
7591
|
-
# parameters: {
|
7592
|
-
# string_parameters: [
|
7593
|
-
# {
|
7594
|
-
# name: "NonEmptyString", # required
|
7595
|
-
# values: ["String"], # required
|
7596
|
-
# },
|
7597
|
-
# ],
|
7598
|
-
# integer_parameters: [
|
7599
|
-
# {
|
7600
|
-
# name: "NonEmptyString", # required
|
7601
|
-
# values: [1], # required
|
7602
|
-
# },
|
7603
|
-
# ],
|
7604
|
-
# decimal_parameters: [
|
7605
|
-
# {
|
7606
|
-
# name: "NonEmptyString", # required
|
7607
|
-
# values: [1.0], # required
|
7608
|
-
# },
|
7609
|
-
# ],
|
7610
|
-
# date_time_parameters: [
|
7611
|
-
# {
|
7612
|
-
# name: "NonEmptyString", # required
|
7613
|
-
# values: [Time.now], # required
|
7614
|
-
# },
|
7615
|
-
# ],
|
7616
|
-
# },
|
7617
|
-
# version_description: "VersionDescription",
|
7618
|
-
# dashboard_publish_options: {
|
7619
|
-
# ad_hoc_filtering_option: {
|
7620
|
-
# availability_status: "ENABLED", # accepts ENABLED, DISABLED
|
7621
|
-
# },
|
7622
|
-
# export_to_csv_option: {
|
7623
|
-
# availability_status: "ENABLED", # accepts ENABLED, DISABLED
|
7624
|
-
# },
|
7625
|
-
# sheet_controls_option: {
|
7626
|
-
# visibility_state: "EXPANDED", # accepts EXPANDED, COLLAPSED
|
7627
|
-
# },
|
7628
|
-
# },
|
7629
|
-
# theme_arn: "Arn",
|
7630
|
-
# })
|
7631
|
-
#
|
7632
7575
|
# @example Response structure
|
7633
7576
|
#
|
7634
7577
|
# resp.arn #=> String
|
@@ -7681,7 +7624,7 @@ module Aws::QuickSight
|
|
7681
7624
|
#
|
7682
7625
|
# resp = client.update_dashboard_permissions({
|
7683
7626
|
# aws_account_id: "AwsAccountId", # required
|
7684
|
-
# dashboard_id: "
|
7627
|
+
# dashboard_id: "ShortRestrictiveResourceId", # required
|
7685
7628
|
# grant_permissions: [
|
7686
7629
|
# {
|
7687
7630
|
# principal: "Principal", # required
|
@@ -7755,7 +7698,7 @@ module Aws::QuickSight
|
|
7755
7698
|
#
|
7756
7699
|
# resp = client.update_dashboard_published_version({
|
7757
7700
|
# aws_account_id: "AwsAccountId", # required
|
7758
|
-
# dashboard_id: "
|
7701
|
+
# dashboard_id: "ShortRestrictiveResourceId", # required
|
7759
7702
|
# version_number: 1, # required
|
7760
7703
|
# })
|
7761
7704
|
#
|
@@ -8753,7 +8696,7 @@ module Aws::QuickSight
|
|
8753
8696
|
# @option params [required, String] :template_id
|
8754
8697
|
# The ID for the template.
|
8755
8698
|
#
|
8756
|
-
# @option params [
|
8699
|
+
# @option params [Types::TemplateSourceEntity] :source_entity
|
8757
8700
|
# The entity that you are using as a source when you update the
|
8758
8701
|
# template. In `SourceEntity`, you specify the type of object you're
|
8759
8702
|
# using as source: `SourceTemplate` for a template or `SourceAnalysis`
|
@@ -8777,6 +8720,12 @@ module Aws::QuickSight
|
|
8777
8720
|
# @option params [String] :name
|
8778
8721
|
# The name for the template.
|
8779
8722
|
#
|
8723
|
+
# @option params [Types::TemplateVersionDefinition] :definition
|
8724
|
+
# The definition of a template.
|
8725
|
+
#
|
8726
|
+
# A definition is the data model of all features in a Dashboard,
|
8727
|
+
# Template, or Analysis.
|
8728
|
+
#
|
8780
8729
|
# @return [Types::UpdateTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8781
8730
|
#
|
8782
8731
|
# * {Types::UpdateTemplateResponse#template_id #template_id} => String
|
@@ -8786,29 +8735,6 @@ module Aws::QuickSight
|
|
8786
8735
|
# * {Types::UpdateTemplateResponse#status #status} => Integer
|
8787
8736
|
# * {Types::UpdateTemplateResponse#request_id #request_id} => String
|
8788
8737
|
#
|
8789
|
-
# @example Request syntax with placeholder values
|
8790
|
-
#
|
8791
|
-
# resp = client.update_template({
|
8792
|
-
# aws_account_id: "AwsAccountId", # required
|
8793
|
-
# template_id: "RestrictiveResourceId", # required
|
8794
|
-
# source_entity: { # required
|
8795
|
-
# source_analysis: {
|
8796
|
-
# arn: "Arn", # required
|
8797
|
-
# data_set_references: [ # required
|
8798
|
-
# {
|
8799
|
-
# data_set_placeholder: "NonEmptyString", # required
|
8800
|
-
# data_set_arn: "Arn", # required
|
8801
|
-
# },
|
8802
|
-
# ],
|
8803
|
-
# },
|
8804
|
-
# source_template: {
|
8805
|
-
# arn: "Arn", # required
|
8806
|
-
# },
|
8807
|
-
# },
|
8808
|
-
# version_description: "VersionDescription",
|
8809
|
-
# name: "TemplateName",
|
8810
|
-
# })
|
8811
|
-
#
|
8812
8738
|
# @example Response structure
|
8813
8739
|
#
|
8814
8740
|
# resp.template_id #=> String
|
@@ -8856,7 +8782,7 @@ module Aws::QuickSight
|
|
8856
8782
|
#
|
8857
8783
|
# resp = client.update_template_alias({
|
8858
8784
|
# aws_account_id: "AwsAccountId", # required
|
8859
|
-
# template_id: "
|
8785
|
+
# template_id: "ShortRestrictiveResourceId", # required
|
8860
8786
|
# alias_name: "AliasName", # required
|
8861
8787
|
# template_version_number: 1, # required
|
8862
8788
|
# })
|
@@ -8904,7 +8830,7 @@ module Aws::QuickSight
|
|
8904
8830
|
#
|
8905
8831
|
# resp = client.update_template_permissions({
|
8906
8832
|
# aws_account_id: "AwsAccountId", # required
|
8907
|
-
# template_id: "
|
8833
|
+
# template_id: "ShortRestrictiveResourceId", # required
|
8908
8834
|
# grant_permissions: [
|
8909
8835
|
# {
|
8910
8836
|
# principal: "Principal", # required
|
@@ -8978,9 +8904,9 @@ module Aws::QuickSight
|
|
8978
8904
|
#
|
8979
8905
|
# resp = client.update_theme({
|
8980
8906
|
# aws_account_id: "AwsAccountId", # required
|
8981
|
-
# theme_id: "
|
8907
|
+
# theme_id: "ShortRestrictiveResourceId", # required
|
8982
8908
|
# name: "ThemeName",
|
8983
|
-
# base_theme_id: "
|
8909
|
+
# base_theme_id: "ShortRestrictiveResourceId", # required
|
8984
8910
|
# version_description: "VersionDescription",
|
8985
8911
|
# configuration: {
|
8986
8912
|
# data_color_palette: {
|
@@ -9021,6 +8947,13 @@ module Aws::QuickSight
|
|
9021
8947
|
# },
|
9022
8948
|
# },
|
9023
8949
|
# },
|
8950
|
+
# typography: {
|
8951
|
+
# font_families: [
|
8952
|
+
# {
|
8953
|
+
# font_family: "String",
|
8954
|
+
# },
|
8955
|
+
# ],
|
8956
|
+
# },
|
9024
8957
|
# },
|
9025
8958
|
# })
|
9026
8959
|
#
|
@@ -9067,7 +9000,7 @@ module Aws::QuickSight
|
|
9067
9000
|
#
|
9068
9001
|
# resp = client.update_theme_alias({
|
9069
9002
|
# aws_account_id: "AwsAccountId", # required
|
9070
|
-
# theme_id: "
|
9003
|
+
# theme_id: "ShortRestrictiveResourceId", # required
|
9071
9004
|
# alias_name: "AliasName", # required
|
9072
9005
|
# theme_version_number: 1, # required
|
9073
9006
|
# })
|
@@ -9157,7 +9090,7 @@ module Aws::QuickSight
|
|
9157
9090
|
#
|
9158
9091
|
# resp = client.update_theme_permissions({
|
9159
9092
|
# aws_account_id: "AwsAccountId", # required
|
9160
|
-
# theme_id: "
|
9093
|
+
# theme_id: "ShortRestrictiveResourceId", # required
|
9161
9094
|
# grant_permissions: [
|
9162
9095
|
# {
|
9163
9096
|
# principal: "Principal", # required
|
@@ -9346,7 +9279,7 @@ module Aws::QuickSight
|
|
9346
9279
|
params: params,
|
9347
9280
|
config: config)
|
9348
9281
|
context[:gem_name] = 'aws-sdk-quicksight'
|
9349
|
-
context[:gem_version] = '1.
|
9282
|
+
context[:gem_version] = '1.72.1'
|
9350
9283
|
Seahorse::Client::Request.new(handlers, context)
|
9351
9284
|
end
|
9352
9285
|
|