aws-sdk-quicksight 1.19.0 → 1.24.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-quicksight.rb +3 -1
- data/lib/aws-sdk-quicksight/client.rb +365 -53
- data/lib/aws-sdk-quicksight/client_api.rb +13 -0
- data/lib/aws-sdk-quicksight/errors.rb +2 -0
- data/lib/aws-sdk-quicksight/resource.rb +2 -0
- data/lib/aws-sdk-quicksight/types.rb +727 -55
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1791dc8197a1fb47a96cd30672e7f70f5f35dd0d48e1a4ac24b28843b7779fb4
|
4
|
+
data.tar.gz: c60c68a1021b39b137322ab458602c15bdb926ca718d21a308ebc4670abe00fb
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 00ca1f46cef7bfb77c778843ca31a51c3da2ebdf3671765d2c8f7a7f150d9d23db8f7a0c0f83d76015c0674cb9e7798c139c380bd6a36d474796b3b9a5faaa49
|
7
|
+
data.tar.gz: aed8f2150fab8893a26f4ae1b95a8effcd11bf5f139a5247703cf3b8b06c023e6ffad5b13a53c6550cbd426f392321e92fcb6aef3ef2fd968f494c491cf1bc2d
|
data/lib/aws-sdk-quicksight.rb
CHANGED
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -45,6 +47,6 @@ require_relative 'aws-sdk-quicksight/customizations'
|
|
45
47
|
# @service
|
46
48
|
module Aws::QuickSight
|
47
49
|
|
48
|
-
GEM_VERSION = '1.
|
50
|
+
GEM_VERSION = '1.24.0'
|
49
51
|
|
50
52
|
end
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -24,6 +26,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
|
24
26
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
27
30
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
28
31
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
29
32
|
|
@@ -69,6 +72,7 @@ module Aws::QuickSight
|
|
69
72
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
70
73
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
71
74
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
72
76
|
add_plugin(Aws::Plugins::SignatureV4)
|
73
77
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
74
78
|
|
@@ -161,7 +165,7 @@ module Aws::QuickSight
|
|
161
165
|
# @option options [String] :endpoint
|
162
166
|
# The client endpoint is normally constructed from the `:region`
|
163
167
|
# option. You should only configure an `:endpoint` when connecting
|
164
|
-
# to test endpoints. This should be a valid HTTP(S) URI.
|
168
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
165
169
|
#
|
166
170
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
167
171
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -176,7 +180,7 @@ module Aws::QuickSight
|
|
176
180
|
# requests fetching endpoints information. Defaults to 60 sec.
|
177
181
|
#
|
178
182
|
# @option options [Boolean] :endpoint_discovery (false)
|
179
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
183
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
180
184
|
#
|
181
185
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
182
186
|
# The log formatter.
|
@@ -373,9 +377,7 @@ module Aws::QuickSight
|
|
373
377
|
# @option params [Types::Parameters] :parameters
|
374
378
|
# A structure that contains the parameters of the dashboard. These are
|
375
379
|
# parameter overrides for a dashboard. A dashboard can have any type of
|
376
|
-
# parameters, and some parameters might accept multiple values.
|
377
|
-
# use the dashboard permissions structure described following to
|
378
|
-
# override two string parameters that accept multiple values.
|
380
|
+
# parameters, and some parameters might accept multiple values.
|
379
381
|
#
|
380
382
|
# @option params [Array<Types::ResourcePermission>] :permissions
|
381
383
|
# A structure that contains the permissions of the dashboard. You can
|
@@ -383,15 +385,19 @@ module Aws::QuickSight
|
|
383
385
|
# information.
|
384
386
|
#
|
385
387
|
# @option params [required, Types::DashboardSourceEntity] :source_entity
|
386
|
-
# The
|
387
|
-
#
|
388
|
-
#
|
389
|
-
#
|
390
|
-
#
|
391
|
-
#
|
392
|
-
#
|
393
|
-
#
|
394
|
-
# AWS
|
388
|
+
# The entity that you are using as a source when you create the
|
389
|
+
# dashboard. In `SourceEntity`, you specify the type of object you're
|
390
|
+
# using as source. You can only create a dashboard from a template, so
|
391
|
+
# you use a `SourceTemplate` entity. If you need to create a dashboard
|
392
|
+
# from an analysis, first convert the analysis to a template by using
|
393
|
+
# the CreateTemplate API operation. For `SourceTemplate`, specify the
|
394
|
+
# Amazon Resource Name (ARN) of the source template. The
|
395
|
+
# `SourceTemplate`ARN can contain any AWS Account and any
|
396
|
+
# QuickSight-supported AWS Region.
|
397
|
+
#
|
398
|
+
# Use the `DataSetReferences` entity within `SourceTemplate` to list the
|
399
|
+
# replacement datasets for the placeholders listed in the original. The
|
400
|
+
# schema in each dataset must match its placeholder.
|
395
401
|
#
|
396
402
|
# @option params [Array<Types::Tag>] :tags
|
397
403
|
# Contains a map of the key-value pairs for the resource tag or tags
|
@@ -415,9 +421,8 @@ module Aws::QuickSight
|
|
415
421
|
# option is `ENABLED` by default.
|
416
422
|
#
|
417
423
|
# * `VisibilityState` for `SheetControlsOption` - This visibility state
|
418
|
-
# can be either `COLLAPSED` or `EXPANDED`.
|
419
|
-
#
|
420
|
-
# default.
|
424
|
+
# can be either `COLLAPSED` or `EXPANDED`. This option is `COLLAPSED`
|
425
|
+
# by default.
|
421
426
|
#
|
422
427
|
# @return [Types::CreateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
423
428
|
#
|
@@ -853,7 +858,96 @@ module Aws::QuickSight
|
|
853
858
|
# credential_pair: {
|
854
859
|
# username: "Username", # required
|
855
860
|
# password: "Password", # required
|
861
|
+
# alternate_data_source_parameters: [
|
862
|
+
# {
|
863
|
+
# amazon_elasticsearch_parameters: {
|
864
|
+
# domain: "Domain", # required
|
865
|
+
# },
|
866
|
+
# athena_parameters: {
|
867
|
+
# work_group: "WorkGroup",
|
868
|
+
# },
|
869
|
+
# aurora_parameters: {
|
870
|
+
# host: "Host", # required
|
871
|
+
# port: 1, # required
|
872
|
+
# database: "Database", # required
|
873
|
+
# },
|
874
|
+
# aurora_postgre_sql_parameters: {
|
875
|
+
# host: "Host", # required
|
876
|
+
# port: 1, # required
|
877
|
+
# database: "Database", # required
|
878
|
+
# },
|
879
|
+
# aws_iot_analytics_parameters: {
|
880
|
+
# data_set_name: "DataSetName", # required
|
881
|
+
# },
|
882
|
+
# jira_parameters: {
|
883
|
+
# site_base_url: "SiteBaseUrl", # required
|
884
|
+
# },
|
885
|
+
# maria_db_parameters: {
|
886
|
+
# host: "Host", # required
|
887
|
+
# port: 1, # required
|
888
|
+
# database: "Database", # required
|
889
|
+
# },
|
890
|
+
# my_sql_parameters: {
|
891
|
+
# host: "Host", # required
|
892
|
+
# port: 1, # required
|
893
|
+
# database: "Database", # required
|
894
|
+
# },
|
895
|
+
# postgre_sql_parameters: {
|
896
|
+
# host: "Host", # required
|
897
|
+
# port: 1, # required
|
898
|
+
# database: "Database", # required
|
899
|
+
# },
|
900
|
+
# presto_parameters: {
|
901
|
+
# host: "Host", # required
|
902
|
+
# port: 1, # required
|
903
|
+
# catalog: "Catalog", # required
|
904
|
+
# },
|
905
|
+
# rds_parameters: {
|
906
|
+
# instance_id: "InstanceId", # required
|
907
|
+
# database: "Database", # required
|
908
|
+
# },
|
909
|
+
# redshift_parameters: {
|
910
|
+
# host: "Host",
|
911
|
+
# port: 1,
|
912
|
+
# database: "Database", # required
|
913
|
+
# cluster_id: "ClusterId",
|
914
|
+
# },
|
915
|
+
# s3_parameters: {
|
916
|
+
# manifest_file_location: { # required
|
917
|
+
# bucket: "S3Bucket", # required
|
918
|
+
# key: "S3Key", # required
|
919
|
+
# },
|
920
|
+
# },
|
921
|
+
# service_now_parameters: {
|
922
|
+
# site_base_url: "SiteBaseUrl", # required
|
923
|
+
# },
|
924
|
+
# snowflake_parameters: {
|
925
|
+
# host: "Host", # required
|
926
|
+
# database: "Database", # required
|
927
|
+
# warehouse: "Warehouse", # required
|
928
|
+
# },
|
929
|
+
# spark_parameters: {
|
930
|
+
# host: "Host", # required
|
931
|
+
# port: 1, # required
|
932
|
+
# },
|
933
|
+
# sql_server_parameters: {
|
934
|
+
# host: "Host", # required
|
935
|
+
# port: 1, # required
|
936
|
+
# database: "Database", # required
|
937
|
+
# },
|
938
|
+
# teradata_parameters: {
|
939
|
+
# host: "Host", # required
|
940
|
+
# port: 1, # required
|
941
|
+
# database: "Database", # required
|
942
|
+
# },
|
943
|
+
# twitter_parameters: {
|
944
|
+
# query: "Query", # required
|
945
|
+
# max_rows: 1, # required
|
946
|
+
# },
|
947
|
+
# },
|
948
|
+
# ],
|
856
949
|
# },
|
950
|
+
# copy_source_arn: "CopySourceArn",
|
857
951
|
# },
|
858
952
|
# permissions: [
|
859
953
|
# {
|
@@ -1083,7 +1177,7 @@ module Aws::QuickSight
|
|
1083
1177
|
#
|
1084
1178
|
#
|
1085
1179
|
#
|
1086
|
-
# [1]: https://aws.
|
1180
|
+
# [1]: https://aws.amazon.com/premiumsupport/knowledge-center/iam-ec2-resource-tags/
|
1087
1181
|
#
|
1088
1182
|
# @option params [required, String] :data_set_id
|
1089
1183
|
# The ID of the dataset used in the ingestion.
|
@@ -1154,10 +1248,19 @@ module Aws::QuickSight
|
|
1154
1248
|
# A list of resource permissions to be set on the template.
|
1155
1249
|
#
|
1156
1250
|
# @option params [required, Types::TemplateSourceEntity] :source_entity
|
1157
|
-
# The
|
1158
|
-
# template
|
1159
|
-
#
|
1160
|
-
#
|
1251
|
+
# The entity that you are using as a source when you create the
|
1252
|
+
# template. In `SourceEntity`, you specify the type of object you're
|
1253
|
+
# using as source: `SourceTemplate` for a template or `SourceAnalysis`
|
1254
|
+
# for an analysis. Both of these require an Amazon Resource Name (ARN).
|
1255
|
+
# For `SourceTemplate`, specify the ARN of the source template. For
|
1256
|
+
# `SourceAnalysis`, specify the ARN of the source analysis. The
|
1257
|
+
# `SourceTemplate` ARN can contain any AWS Account and any
|
1258
|
+
# QuickSight-supported AWS Region.
|
1259
|
+
#
|
1260
|
+
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
1261
|
+
# `SourceAnalysis` to list the replacement datasets for the placeholders
|
1262
|
+
# listed in the original. The schema in each dataset must match its
|
1263
|
+
# placeholder.
|
1161
1264
|
#
|
1162
1265
|
# @option params [Array<Types::Tag>] :tags
|
1163
1266
|
# Contains a map of the key-value pairs for the resource tag or tags
|
@@ -1586,10 +1689,10 @@ module Aws::QuickSight
|
|
1586
1689
|
# The ID for the template that the specified alias is for.
|
1587
1690
|
#
|
1588
1691
|
# @option params [required, String] :alias_name
|
1589
|
-
# The name for the template alias.
|
1590
|
-
# delete the version that the alias points to. You can specify the
|
1591
|
-
# latest version of the template by providing the
|
1592
|
-
# the `AliasName` parameter.
|
1692
|
+
# The name for the template alias. To delete a specific alias, you
|
1693
|
+
# delete the version that the alias points to. You can specify the alias
|
1694
|
+
# name, or specify the latest version of the template by providing the
|
1695
|
+
# keyword `$LATEST` in the `AliasName` parameter.
|
1593
1696
|
#
|
1594
1697
|
# @return [Types::DeleteTemplateAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1595
1698
|
#
|
@@ -1743,12 +1846,14 @@ module Aws::QuickSight
|
|
1743
1846
|
# resp.dashboard.name #=> String
|
1744
1847
|
# resp.dashboard.version.created_time #=> Time
|
1745
1848
|
# resp.dashboard.version.errors #=> Array
|
1746
|
-
# resp.dashboard.version.errors[0].type #=> String, one of "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"
|
1849
|
+
# 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"
|
1747
1850
|
# resp.dashboard.version.errors[0].message #=> String
|
1748
1851
|
# resp.dashboard.version.version_number #=> Integer
|
1749
1852
|
# resp.dashboard.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
1750
1853
|
# resp.dashboard.version.arn #=> String
|
1751
1854
|
# resp.dashboard.version.source_entity_arn #=> String
|
1855
|
+
# resp.dashboard.version.data_set_arns #=> Array
|
1856
|
+
# resp.dashboard.version.data_set_arns[0] #=> String
|
1752
1857
|
# resp.dashboard.version.description #=> String
|
1753
1858
|
# resp.dashboard.created_time #=> Time
|
1754
1859
|
# resp.dashboard.last_published_time #=> Time
|
@@ -2029,9 +2134,54 @@ module Aws::QuickSight
|
|
2029
2134
|
# resp.data_source.data_source_parameters.teradata_parameters.database #=> String
|
2030
2135
|
# resp.data_source.data_source_parameters.twitter_parameters.query #=> String
|
2031
2136
|
# resp.data_source.data_source_parameters.twitter_parameters.max_rows #=> Integer
|
2137
|
+
# resp.data_source.alternate_data_source_parameters #=> Array
|
2138
|
+
# resp.data_source.alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
|
2139
|
+
# resp.data_source.alternate_data_source_parameters[0].athena_parameters.work_group #=> String
|
2140
|
+
# resp.data_source.alternate_data_source_parameters[0].aurora_parameters.host #=> String
|
2141
|
+
# resp.data_source.alternate_data_source_parameters[0].aurora_parameters.port #=> Integer
|
2142
|
+
# resp.data_source.alternate_data_source_parameters[0].aurora_parameters.database #=> String
|
2143
|
+
# resp.data_source.alternate_data_source_parameters[0].aurora_postgre_sql_parameters.host #=> String
|
2144
|
+
# resp.data_source.alternate_data_source_parameters[0].aurora_postgre_sql_parameters.port #=> Integer
|
2145
|
+
# resp.data_source.alternate_data_source_parameters[0].aurora_postgre_sql_parameters.database #=> String
|
2146
|
+
# resp.data_source.alternate_data_source_parameters[0].aws_iot_analytics_parameters.data_set_name #=> String
|
2147
|
+
# resp.data_source.alternate_data_source_parameters[0].jira_parameters.site_base_url #=> String
|
2148
|
+
# resp.data_source.alternate_data_source_parameters[0].maria_db_parameters.host #=> String
|
2149
|
+
# resp.data_source.alternate_data_source_parameters[0].maria_db_parameters.port #=> Integer
|
2150
|
+
# resp.data_source.alternate_data_source_parameters[0].maria_db_parameters.database #=> String
|
2151
|
+
# resp.data_source.alternate_data_source_parameters[0].my_sql_parameters.host #=> String
|
2152
|
+
# resp.data_source.alternate_data_source_parameters[0].my_sql_parameters.port #=> Integer
|
2153
|
+
# resp.data_source.alternate_data_source_parameters[0].my_sql_parameters.database #=> String
|
2154
|
+
# resp.data_source.alternate_data_source_parameters[0].postgre_sql_parameters.host #=> String
|
2155
|
+
# resp.data_source.alternate_data_source_parameters[0].postgre_sql_parameters.port #=> Integer
|
2156
|
+
# resp.data_source.alternate_data_source_parameters[0].postgre_sql_parameters.database #=> String
|
2157
|
+
# resp.data_source.alternate_data_source_parameters[0].presto_parameters.host #=> String
|
2158
|
+
# resp.data_source.alternate_data_source_parameters[0].presto_parameters.port #=> Integer
|
2159
|
+
# resp.data_source.alternate_data_source_parameters[0].presto_parameters.catalog #=> String
|
2160
|
+
# resp.data_source.alternate_data_source_parameters[0].rds_parameters.instance_id #=> String
|
2161
|
+
# resp.data_source.alternate_data_source_parameters[0].rds_parameters.database #=> String
|
2162
|
+
# resp.data_source.alternate_data_source_parameters[0].redshift_parameters.host #=> String
|
2163
|
+
# resp.data_source.alternate_data_source_parameters[0].redshift_parameters.port #=> Integer
|
2164
|
+
# resp.data_source.alternate_data_source_parameters[0].redshift_parameters.database #=> String
|
2165
|
+
# resp.data_source.alternate_data_source_parameters[0].redshift_parameters.cluster_id #=> String
|
2166
|
+
# resp.data_source.alternate_data_source_parameters[0].s3_parameters.manifest_file_location.bucket #=> String
|
2167
|
+
# resp.data_source.alternate_data_source_parameters[0].s3_parameters.manifest_file_location.key #=> String
|
2168
|
+
# resp.data_source.alternate_data_source_parameters[0].service_now_parameters.site_base_url #=> String
|
2169
|
+
# resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.host #=> String
|
2170
|
+
# resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.database #=> String
|
2171
|
+
# resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.warehouse #=> String
|
2172
|
+
# resp.data_source.alternate_data_source_parameters[0].spark_parameters.host #=> String
|
2173
|
+
# resp.data_source.alternate_data_source_parameters[0].spark_parameters.port #=> Integer
|
2174
|
+
# resp.data_source.alternate_data_source_parameters[0].sql_server_parameters.host #=> String
|
2175
|
+
# resp.data_source.alternate_data_source_parameters[0].sql_server_parameters.port #=> Integer
|
2176
|
+
# resp.data_source.alternate_data_source_parameters[0].sql_server_parameters.database #=> String
|
2177
|
+
# resp.data_source.alternate_data_source_parameters[0].teradata_parameters.host #=> String
|
2178
|
+
# resp.data_source.alternate_data_source_parameters[0].teradata_parameters.port #=> Integer
|
2179
|
+
# resp.data_source.alternate_data_source_parameters[0].teradata_parameters.database #=> String
|
2180
|
+
# resp.data_source.alternate_data_source_parameters[0].twitter_parameters.query #=> String
|
2181
|
+
# resp.data_source.alternate_data_source_parameters[0].twitter_parameters.max_rows #=> Integer
|
2032
2182
|
# resp.data_source.vpc_connection_properties.vpc_connection_arn #=> String
|
2033
2183
|
# resp.data_source.ssl_properties.disable_ssl #=> Boolean
|
2034
|
-
# resp.data_source.error_info.type #=> String, one of "TIMEOUT", "ENGINE_VERSION_NOT_SUPPORTED", "UNKNOWN_HOST", "GENERIC_SQL_FAILURE", "CONFLICT", "UNKNOWN"
|
2184
|
+
# resp.data_source.error_info.type #=> String, one of "ACCESS_DENIED", "COPY_SOURCE_NOT_FOUND", "TIMEOUT", "ENGINE_VERSION_NOT_SUPPORTED", "UNKNOWN_HOST", "GENERIC_SQL_FAILURE", "CONFLICT", "UNKNOWN"
|
2035
2185
|
# resp.data_source.error_info.message #=> String
|
2036
2186
|
# resp.request_id #=> String
|
2037
2187
|
# resp.status #=> Integer
|
@@ -2278,7 +2428,7 @@ module Aws::QuickSight
|
|
2278
2428
|
# resp.template.name #=> String
|
2279
2429
|
# resp.template.version.created_time #=> Time
|
2280
2430
|
# resp.template.version.errors #=> Array
|
2281
|
-
# resp.template.version.errors[0].type #=> String, one of "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE"
|
2431
|
+
# resp.template.version.errors[0].type #=> String, one of "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE"
|
2282
2432
|
# resp.template.version.errors[0].message #=> String
|
2283
2433
|
# resp.template.version.version_number #=> Integer
|
2284
2434
|
# resp.template.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
@@ -2446,15 +2596,25 @@ module Aws::QuickSight
|
|
2446
2596
|
req.send_request(options)
|
2447
2597
|
end
|
2448
2598
|
|
2449
|
-
# Generates a
|
2450
|
-
#
|
2451
|
-
#
|
2452
|
-
# Dashboards][1] in the *Amazon QuickSight User Guide* or [Embedding
|
2453
|
-
# Amazon QuickSight Dashboards][2] in the *Amazon QuickSight API
|
2454
|
-
# Reference*.
|
2599
|
+
# Generates a URL and authorization code that you can embed in your web
|
2600
|
+
# server code. Before you use this command, make sure that you have
|
2601
|
+
# configured the dashboards and permissions.
|
2455
2602
|
#
|
2456
2603
|
# Currently, you can use `GetDashboardEmbedURL` only from the server,
|
2457
|
-
# not from the user
|
2604
|
+
# not from the user's browser. The following rules apply to the
|
2605
|
+
# combination of URL and authorization code:
|
2606
|
+
#
|
2607
|
+
# * They must be used together.
|
2608
|
+
#
|
2609
|
+
# * They can be used one time only.
|
2610
|
+
#
|
2611
|
+
# * They are valid for 5 minutes after you run this command.
|
2612
|
+
#
|
2613
|
+
# * The resulting user session is valid for 10 hours.
|
2614
|
+
#
|
2615
|
+
# For more information, see [Embedding Amazon QuickSight Dashboards][1]
|
2616
|
+
# in the *Amazon QuickSight User Guide* or [Embedding Amazon QuickSight
|
2617
|
+
# Dashboards][2] in the *Amazon QuickSight API Reference*.
|
2458
2618
|
#
|
2459
2619
|
#
|
2460
2620
|
#
|
@@ -2781,9 +2941,54 @@ module Aws::QuickSight
|
|
2781
2941
|
# resp.data_sources[0].data_source_parameters.teradata_parameters.database #=> String
|
2782
2942
|
# resp.data_sources[0].data_source_parameters.twitter_parameters.query #=> String
|
2783
2943
|
# resp.data_sources[0].data_source_parameters.twitter_parameters.max_rows #=> Integer
|
2944
|
+
# resp.data_sources[0].alternate_data_source_parameters #=> Array
|
2945
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
|
2946
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].athena_parameters.work_group #=> String
|
2947
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].aurora_parameters.host #=> String
|
2948
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].aurora_parameters.port #=> Integer
|
2949
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].aurora_parameters.database #=> String
|
2950
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].aurora_postgre_sql_parameters.host #=> String
|
2951
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].aurora_postgre_sql_parameters.port #=> Integer
|
2952
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].aurora_postgre_sql_parameters.database #=> String
|
2953
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].aws_iot_analytics_parameters.data_set_name #=> String
|
2954
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].jira_parameters.site_base_url #=> String
|
2955
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].maria_db_parameters.host #=> String
|
2956
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].maria_db_parameters.port #=> Integer
|
2957
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].maria_db_parameters.database #=> String
|
2958
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].my_sql_parameters.host #=> String
|
2959
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].my_sql_parameters.port #=> Integer
|
2960
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].my_sql_parameters.database #=> String
|
2961
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].postgre_sql_parameters.host #=> String
|
2962
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].postgre_sql_parameters.port #=> Integer
|
2963
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].postgre_sql_parameters.database #=> String
|
2964
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].presto_parameters.host #=> String
|
2965
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].presto_parameters.port #=> Integer
|
2966
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].presto_parameters.catalog #=> String
|
2967
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].rds_parameters.instance_id #=> String
|
2968
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].rds_parameters.database #=> String
|
2969
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.host #=> String
|
2970
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.port #=> Integer
|
2971
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.database #=> String
|
2972
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.cluster_id #=> String
|
2973
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].s3_parameters.manifest_file_location.bucket #=> String
|
2974
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].s3_parameters.manifest_file_location.key #=> String
|
2975
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].service_now_parameters.site_base_url #=> String
|
2976
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.host #=> String
|
2977
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.database #=> String
|
2978
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.warehouse #=> String
|
2979
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].spark_parameters.host #=> String
|
2980
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].spark_parameters.port #=> Integer
|
2981
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].sql_server_parameters.host #=> String
|
2982
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].sql_server_parameters.port #=> Integer
|
2983
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].sql_server_parameters.database #=> String
|
2984
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].teradata_parameters.host #=> String
|
2985
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].teradata_parameters.port #=> Integer
|
2986
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].teradata_parameters.database #=> String
|
2987
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].twitter_parameters.query #=> String
|
2988
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].twitter_parameters.max_rows #=> Integer
|
2784
2989
|
# resp.data_sources[0].vpc_connection_properties.vpc_connection_arn #=> String
|
2785
2990
|
# resp.data_sources[0].ssl_properties.disable_ssl #=> Boolean
|
2786
|
-
# resp.data_sources[0].error_info.type #=> String, one of "TIMEOUT", "ENGINE_VERSION_NOT_SUPPORTED", "UNKNOWN_HOST", "GENERIC_SQL_FAILURE", "CONFLICT", "UNKNOWN"
|
2991
|
+
# resp.data_sources[0].error_info.type #=> String, one of "ACCESS_DENIED", "COPY_SOURCE_NOT_FOUND", "TIMEOUT", "ENGINE_VERSION_NOT_SUPPORTED", "UNKNOWN_HOST", "GENERIC_SQL_FAILURE", "CONFLICT", "UNKNOWN"
|
2787
2992
|
# resp.data_sources[0].error_info.message #=> String
|
2788
2993
|
# resp.next_token #=> String
|
2789
2994
|
# resp.request_id #=> String
|
@@ -3430,7 +3635,7 @@ module Aws::QuickSight
|
|
3430
3635
|
#
|
3431
3636
|
#
|
3432
3637
|
#
|
3433
|
-
# [1]: https://
|
3638
|
+
# [1]: https://awscli.amazonaws.com/v2/documentation/api/latest/reference/sts/assume-role.html
|
3434
3639
|
#
|
3435
3640
|
# @option params [required, String] :aws_account_id
|
3436
3641
|
# The ID for the AWS account that the user is in. Currently, you use the
|
@@ -3493,7 +3698,7 @@ module Aws::QuickSight
|
|
3493
3698
|
#
|
3494
3699
|
# @option params [required, Array<Types::DashboardSearchFilter>] :filters
|
3495
3700
|
# The filters to apply to the search. Currently, you can search only by
|
3496
|
-
# user name
|
3701
|
+
# user name, for example, `"Filters": [ \{ "Name": "QUICKSIGHT_USER",
|
3497
3702
|
# "Operator": "StringEquals", "Value":
|
3498
3703
|
# "arn:aws:quicksight:us-east-1:1:user/default/UserName1" \} ]`
|
3499
3704
|
#
|
@@ -3662,15 +3867,24 @@ module Aws::QuickSight
|
|
3662
3867
|
# The display name of the dashboard.
|
3663
3868
|
#
|
3664
3869
|
# @option params [required, Types::DashboardSourceEntity] :source_entity
|
3665
|
-
# The
|
3666
|
-
# `
|
3667
|
-
#
|
3668
|
-
#
|
3669
|
-
#
|
3670
|
-
#
|
3870
|
+
# The entity that you are using as a source when you update the
|
3871
|
+
# dashboard. In `SourceEntity`, you specify the type of object you're
|
3872
|
+
# using as source. You can only update a dashboard from a template, so
|
3873
|
+
# you use a `SourceTemplate` entity. If you need to update a dashboard
|
3874
|
+
# from an analysis, first convert the analysis to a template by using
|
3875
|
+
# the CreateTemplate API operation. For `SourceTemplate`, specify the
|
3876
|
+
# Amazon Resource Name (ARN) of the source template. The
|
3877
|
+
# `SourceTemplate` ARN can contain any AWS Account and any
|
3878
|
+
# QuickSight-supported AWS Region.
|
3879
|
+
#
|
3880
|
+
# Use the `DataSetReferences` entity within `SourceTemplate` to list the
|
3881
|
+
# replacement datasets for the placeholders listed in the original. The
|
3882
|
+
# schema in each dataset must match its placeholder.
|
3671
3883
|
#
|
3672
3884
|
# @option params [Types::Parameters] :parameters
|
3673
|
-
# A structure that contains the parameters of the dashboard.
|
3885
|
+
# A structure that contains the parameters of the dashboard. These are
|
3886
|
+
# parameter overrides for a dashboard. A dashboard can have any type of
|
3887
|
+
# parameters, and some parameters might accept multiple values.
|
3674
3888
|
#
|
3675
3889
|
# @option params [String] :version_description
|
3676
3890
|
# A description for the first version of the dashboard being created.
|
@@ -3690,9 +3904,8 @@ module Aws::QuickSight
|
|
3690
3904
|
# option is `ENABLED` by default.
|
3691
3905
|
#
|
3692
3906
|
# * `VisibilityState` for `SheetControlsOption` - This visibility state
|
3693
|
-
# can be either `COLLAPSED` or `EXPANDED`.
|
3694
|
-
#
|
3695
|
-
# default.
|
3907
|
+
# can be either `COLLAPSED` or `EXPANDED`. This option is `COLLAPSED`
|
3908
|
+
# by default.
|
3696
3909
|
#
|
3697
3910
|
# @return [Types::UpdateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3698
3911
|
#
|
@@ -4247,7 +4460,96 @@ module Aws::QuickSight
|
|
4247
4460
|
# credential_pair: {
|
4248
4461
|
# username: "Username", # required
|
4249
4462
|
# password: "Password", # required
|
4463
|
+
# alternate_data_source_parameters: [
|
4464
|
+
# {
|
4465
|
+
# amazon_elasticsearch_parameters: {
|
4466
|
+
# domain: "Domain", # required
|
4467
|
+
# },
|
4468
|
+
# athena_parameters: {
|
4469
|
+
# work_group: "WorkGroup",
|
4470
|
+
# },
|
4471
|
+
# aurora_parameters: {
|
4472
|
+
# host: "Host", # required
|
4473
|
+
# port: 1, # required
|
4474
|
+
# database: "Database", # required
|
4475
|
+
# },
|
4476
|
+
# aurora_postgre_sql_parameters: {
|
4477
|
+
# host: "Host", # required
|
4478
|
+
# port: 1, # required
|
4479
|
+
# database: "Database", # required
|
4480
|
+
# },
|
4481
|
+
# aws_iot_analytics_parameters: {
|
4482
|
+
# data_set_name: "DataSetName", # required
|
4483
|
+
# },
|
4484
|
+
# jira_parameters: {
|
4485
|
+
# site_base_url: "SiteBaseUrl", # required
|
4486
|
+
# },
|
4487
|
+
# maria_db_parameters: {
|
4488
|
+
# host: "Host", # required
|
4489
|
+
# port: 1, # required
|
4490
|
+
# database: "Database", # required
|
4491
|
+
# },
|
4492
|
+
# my_sql_parameters: {
|
4493
|
+
# host: "Host", # required
|
4494
|
+
# port: 1, # required
|
4495
|
+
# database: "Database", # required
|
4496
|
+
# },
|
4497
|
+
# postgre_sql_parameters: {
|
4498
|
+
# host: "Host", # required
|
4499
|
+
# port: 1, # required
|
4500
|
+
# database: "Database", # required
|
4501
|
+
# },
|
4502
|
+
# presto_parameters: {
|
4503
|
+
# host: "Host", # required
|
4504
|
+
# port: 1, # required
|
4505
|
+
# catalog: "Catalog", # required
|
4506
|
+
# },
|
4507
|
+
# rds_parameters: {
|
4508
|
+
# instance_id: "InstanceId", # required
|
4509
|
+
# database: "Database", # required
|
4510
|
+
# },
|
4511
|
+
# redshift_parameters: {
|
4512
|
+
# host: "Host",
|
4513
|
+
# port: 1,
|
4514
|
+
# database: "Database", # required
|
4515
|
+
# cluster_id: "ClusterId",
|
4516
|
+
# },
|
4517
|
+
# s3_parameters: {
|
4518
|
+
# manifest_file_location: { # required
|
4519
|
+
# bucket: "S3Bucket", # required
|
4520
|
+
# key: "S3Key", # required
|
4521
|
+
# },
|
4522
|
+
# },
|
4523
|
+
# service_now_parameters: {
|
4524
|
+
# site_base_url: "SiteBaseUrl", # required
|
4525
|
+
# },
|
4526
|
+
# snowflake_parameters: {
|
4527
|
+
# host: "Host", # required
|
4528
|
+
# database: "Database", # required
|
4529
|
+
# warehouse: "Warehouse", # required
|
4530
|
+
# },
|
4531
|
+
# spark_parameters: {
|
4532
|
+
# host: "Host", # required
|
4533
|
+
# port: 1, # required
|
4534
|
+
# },
|
4535
|
+
# sql_server_parameters: {
|
4536
|
+
# host: "Host", # required
|
4537
|
+
# port: 1, # required
|
4538
|
+
# database: "Database", # required
|
4539
|
+
# },
|
4540
|
+
# teradata_parameters: {
|
4541
|
+
# host: "Host", # required
|
4542
|
+
# port: 1, # required
|
4543
|
+
# database: "Database", # required
|
4544
|
+
# },
|
4545
|
+
# twitter_parameters: {
|
4546
|
+
# query: "Query", # required
|
4547
|
+
# max_rows: 1, # required
|
4548
|
+
# },
|
4549
|
+
# },
|
4550
|
+
# ],
|
4250
4551
|
# },
|
4552
|
+
# copy_source_arn: "CopySourceArn",
|
4251
4553
|
# },
|
4252
4554
|
# vpc_connection_properties: {
|
4253
4555
|
# vpc_connection_arn: "Arn", # required
|
@@ -4471,9 +4773,19 @@ module Aws::QuickSight
|
|
4471
4773
|
# The ID for the template.
|
4472
4774
|
#
|
4473
4775
|
# @option params [required, Types::TemplateSourceEntity] :source_entity
|
4474
|
-
# The
|
4475
|
-
#
|
4476
|
-
#
|
4776
|
+
# The entity that you are using as a source when you update the
|
4777
|
+
# template. In `SourceEntity`, you specify the type of object you're
|
4778
|
+
# using as source: `SourceTemplate` for a template or `SourceAnalysis`
|
4779
|
+
# for an analysis. Both of these require an Amazon Resource Name (ARN).
|
4780
|
+
# For `SourceTemplate`, specify the ARN of the source template. For
|
4781
|
+
# `SourceAnalysis`, specify the ARN of the source analysis. The
|
4782
|
+
# `SourceTemplate` ARN can contain any AWS Account and any
|
4783
|
+
# QuickSight-supported AWS Region.
|
4784
|
+
#
|
4785
|
+
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
4786
|
+
# `SourceAnalysis` to list the replacement datasets for the placeholders
|
4787
|
+
# listed in the original. The schema in each dataset must match its
|
4788
|
+
# placeholder.
|
4477
4789
|
#
|
4478
4790
|
# @option params [String] :version_description
|
4479
4791
|
# A description of the current template version that is being updated.
|
@@ -4723,7 +5035,7 @@ module Aws::QuickSight
|
|
4723
5035
|
params: params,
|
4724
5036
|
config: config)
|
4725
5037
|
context[:gem_name] = 'aws-sdk-quicksight'
|
4726
|
-
context[:gem_version] = '1.
|
5038
|
+
context[:gem_version] = '1.24.0'
|
4727
5039
|
Seahorse::Client::Request.new(handlers, context)
|
4728
5040
|
end
|
4729
5041
|
|