aws-sdk-quicksight 1.20.0 → 1.25.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 +1245 -51
- data/lib/aws-sdk-quicksight/client_api.rb +523 -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 +2423 -117
- 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: 73ec87a9d50b097049e6c8d8db9fe235405b7c155906e924d2d394d6dda9e599
|
4
|
+
data.tar.gz: e77307603a389ee14d809fef1d7390b6b8a083d2046f44709e9ab23e410cc846
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 70bff9cd8f5c2d7c3341694a868e2770894ba593aed271b9d9c1fd79a2f1d215107e4ad3173d9c6a28cf3a3c7b029a9d06cbee465b7a3bcdffce33d8486027fa
|
7
|
+
data.tar.gz: ddc03901ed4669c282032f949203a48c79b0307c79e7481083c9a4fb27cf4e2d310ccb1ec6fccc74ec96f2a3e55374e28645224377e4ad1af80ddb4b802203ea
|
data/lib/aws-sdk-quicksight.rb
CHANGED
@@ -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.25.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.
|
@@ -371,11 +375,9 @@ module Aws::QuickSight
|
|
371
375
|
# The display name of the dashboard.
|
372
376
|
#
|
373
377
|
# @option params [Types::Parameters] :parameters
|
374
|
-
#
|
375
|
-
#
|
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.
|
378
|
+
# The parameters for the creation of the dashboard, which you want to
|
379
|
+
# use to override the default settings. A dashboard can have any type of
|
380
|
+
# 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,14 @@ 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
|
-
#
|
424
|
+
# can be either `COLLAPSED` or `EXPANDED`. This option is `COLLAPSED`
|
425
|
+
# by default.
|
426
|
+
#
|
427
|
+
# @option params [String] :theme_arn
|
428
|
+
# The Amazon Resource Name (ARN) of the theme that is being used for
|
429
|
+
# this dashboard. If you add a value for this field, it overrides the
|
430
|
+
# value that is used in the source entity. The theme ARN must exist in
|
431
|
+
# the same AWS account where you create the dashboard.
|
421
432
|
#
|
422
433
|
# @return [Types::CreateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
423
434
|
#
|
@@ -495,6 +506,7 @@ module Aws::QuickSight
|
|
495
506
|
# visibility_state: "EXPANDED", # accepts EXPANDED, COLLAPSED
|
496
507
|
# },
|
497
508
|
# },
|
509
|
+
# theme_arn: "Arn",
|
498
510
|
# })
|
499
511
|
#
|
500
512
|
# @example Response structure
|
@@ -853,7 +865,96 @@ module Aws::QuickSight
|
|
853
865
|
# credential_pair: {
|
854
866
|
# username: "Username", # required
|
855
867
|
# password: "Password", # required
|
868
|
+
# alternate_data_source_parameters: [
|
869
|
+
# {
|
870
|
+
# amazon_elasticsearch_parameters: {
|
871
|
+
# domain: "Domain", # required
|
872
|
+
# },
|
873
|
+
# athena_parameters: {
|
874
|
+
# work_group: "WorkGroup",
|
875
|
+
# },
|
876
|
+
# aurora_parameters: {
|
877
|
+
# host: "Host", # required
|
878
|
+
# port: 1, # required
|
879
|
+
# database: "Database", # required
|
880
|
+
# },
|
881
|
+
# aurora_postgre_sql_parameters: {
|
882
|
+
# host: "Host", # required
|
883
|
+
# port: 1, # required
|
884
|
+
# database: "Database", # required
|
885
|
+
# },
|
886
|
+
# aws_iot_analytics_parameters: {
|
887
|
+
# data_set_name: "DataSetName", # required
|
888
|
+
# },
|
889
|
+
# jira_parameters: {
|
890
|
+
# site_base_url: "SiteBaseUrl", # required
|
891
|
+
# },
|
892
|
+
# maria_db_parameters: {
|
893
|
+
# host: "Host", # required
|
894
|
+
# port: 1, # required
|
895
|
+
# database: "Database", # required
|
896
|
+
# },
|
897
|
+
# my_sql_parameters: {
|
898
|
+
# host: "Host", # required
|
899
|
+
# port: 1, # required
|
900
|
+
# database: "Database", # required
|
901
|
+
# },
|
902
|
+
# postgre_sql_parameters: {
|
903
|
+
# host: "Host", # required
|
904
|
+
# port: 1, # required
|
905
|
+
# database: "Database", # required
|
906
|
+
# },
|
907
|
+
# presto_parameters: {
|
908
|
+
# host: "Host", # required
|
909
|
+
# port: 1, # required
|
910
|
+
# catalog: "Catalog", # required
|
911
|
+
# },
|
912
|
+
# rds_parameters: {
|
913
|
+
# instance_id: "InstanceId", # required
|
914
|
+
# database: "Database", # required
|
915
|
+
# },
|
916
|
+
# redshift_parameters: {
|
917
|
+
# host: "Host",
|
918
|
+
# port: 1,
|
919
|
+
# database: "Database", # required
|
920
|
+
# cluster_id: "ClusterId",
|
921
|
+
# },
|
922
|
+
# s3_parameters: {
|
923
|
+
# manifest_file_location: { # required
|
924
|
+
# bucket: "S3Bucket", # required
|
925
|
+
# key: "S3Key", # required
|
926
|
+
# },
|
927
|
+
# },
|
928
|
+
# service_now_parameters: {
|
929
|
+
# site_base_url: "SiteBaseUrl", # required
|
930
|
+
# },
|
931
|
+
# snowflake_parameters: {
|
932
|
+
# host: "Host", # required
|
933
|
+
# database: "Database", # required
|
934
|
+
# warehouse: "Warehouse", # required
|
935
|
+
# },
|
936
|
+
# spark_parameters: {
|
937
|
+
# host: "Host", # required
|
938
|
+
# port: 1, # required
|
939
|
+
# },
|
940
|
+
# sql_server_parameters: {
|
941
|
+
# host: "Host", # required
|
942
|
+
# port: 1, # required
|
943
|
+
# database: "Database", # required
|
944
|
+
# },
|
945
|
+
# teradata_parameters: {
|
946
|
+
# host: "Host", # required
|
947
|
+
# port: 1, # required
|
948
|
+
# database: "Database", # required
|
949
|
+
# },
|
950
|
+
# twitter_parameters: {
|
951
|
+
# query: "Query", # required
|
952
|
+
# max_rows: 1, # required
|
953
|
+
# },
|
954
|
+
# },
|
955
|
+
# ],
|
856
956
|
# },
|
957
|
+
# copy_source_arn: "CopySourceArn",
|
857
958
|
# },
|
858
959
|
# permissions: [
|
859
960
|
# {
|
@@ -1154,10 +1255,19 @@ module Aws::QuickSight
|
|
1154
1255
|
# A list of resource permissions to be set on the template.
|
1155
1256
|
#
|
1156
1257
|
# @option params [required, Types::TemplateSourceEntity] :source_entity
|
1157
|
-
# The
|
1158
|
-
# template
|
1159
|
-
#
|
1160
|
-
#
|
1258
|
+
# The entity that you are using as a source when you create the
|
1259
|
+
# template. In `SourceEntity`, you specify the type of object you're
|
1260
|
+
# using as source: `SourceTemplate` for a template or `SourceAnalysis`
|
1261
|
+
# for an analysis. Both of these require an Amazon Resource Name (ARN).
|
1262
|
+
# For `SourceTemplate`, specify the ARN of the source template. For
|
1263
|
+
# `SourceAnalysis`, specify the ARN of the source analysis. The
|
1264
|
+
# `SourceTemplate` ARN can contain any AWS Account and any
|
1265
|
+
# QuickSight-supported AWS Region.
|
1266
|
+
#
|
1267
|
+
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
1268
|
+
# `SourceAnalysis` to list the replacement datasets for the placeholders
|
1269
|
+
# listed in the original. The schema in each dataset must match its
|
1270
|
+
# placeholder.
|
1161
1271
|
#
|
1162
1272
|
# @option params [Array<Types::Tag>] :tags
|
1163
1273
|
# Contains a map of the key-value pairs for the resource tag or tags
|
@@ -1281,6 +1391,186 @@ module Aws::QuickSight
|
|
1281
1391
|
req.send_request(options)
|
1282
1392
|
end
|
1283
1393
|
|
1394
|
+
# Creates a theme.
|
1395
|
+
#
|
1396
|
+
# A *theme* is set of configuration options for color and layout. Themes
|
1397
|
+
# apply to analyses and dashboards. For more information, see [Using
|
1398
|
+
# Themes in Amazon QuickSight][1] in the *Amazon QuickSight User Guide*.
|
1399
|
+
#
|
1400
|
+
#
|
1401
|
+
#
|
1402
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html
|
1403
|
+
#
|
1404
|
+
# @option params [required, String] :aws_account_id
|
1405
|
+
# The ID of the AWS account where you want to store the new theme.
|
1406
|
+
#
|
1407
|
+
# @option params [required, String] :theme_id
|
1408
|
+
# An ID for the theme that you want to create. The theme ID is unique
|
1409
|
+
# per AWS Region in each AWS account.
|
1410
|
+
#
|
1411
|
+
# @option params [required, String] :name
|
1412
|
+
# A display name for the theme.
|
1413
|
+
#
|
1414
|
+
# @option params [required, String] :base_theme_id
|
1415
|
+
# The ID of the theme that a custom theme will inherit from. All themes
|
1416
|
+
# inherit from one of the starting themes defined by Amazon QuickSight.
|
1417
|
+
# For a list of the starting themes, use `ListThemes` or choose
|
1418
|
+
# **Themes** from within a QuickSight analysis.
|
1419
|
+
#
|
1420
|
+
# @option params [String] :version_description
|
1421
|
+
# A description of the first version of the theme that you're creating.
|
1422
|
+
# Every time `UpdateTheme` is called, a new version is created. Each
|
1423
|
+
# version of the theme has a description of the version in the
|
1424
|
+
# `VersionDescription` field.
|
1425
|
+
#
|
1426
|
+
# @option params [required, Types::ThemeConfiguration] :configuration
|
1427
|
+
# The theme configuration, which contains the theme display properties.
|
1428
|
+
#
|
1429
|
+
# @option params [Array<Types::ResourcePermission>] :permissions
|
1430
|
+
# A valid grouping of resource permissions to apply to the new theme.
|
1431
|
+
#
|
1432
|
+
# @option params [Array<Types::Tag>] :tags
|
1433
|
+
# A map of the key-value pairs for the resource tag or tags that you
|
1434
|
+
# want to add to the resource.
|
1435
|
+
#
|
1436
|
+
# @return [Types::CreateThemeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1437
|
+
#
|
1438
|
+
# * {Types::CreateThemeResponse#arn #arn} => String
|
1439
|
+
# * {Types::CreateThemeResponse#version_arn #version_arn} => String
|
1440
|
+
# * {Types::CreateThemeResponse#theme_id #theme_id} => String
|
1441
|
+
# * {Types::CreateThemeResponse#creation_status #creation_status} => String
|
1442
|
+
# * {Types::CreateThemeResponse#status #status} => Integer
|
1443
|
+
# * {Types::CreateThemeResponse#request_id #request_id} => String
|
1444
|
+
#
|
1445
|
+
# @example Request syntax with placeholder values
|
1446
|
+
#
|
1447
|
+
# resp = client.create_theme({
|
1448
|
+
# aws_account_id: "AwsAccountId", # required
|
1449
|
+
# theme_id: "RestrictiveResourceId", # required
|
1450
|
+
# name: "ThemeName", # required
|
1451
|
+
# base_theme_id: "RestrictiveResourceId", # required
|
1452
|
+
# version_description: "VersionDescription",
|
1453
|
+
# configuration: { # required
|
1454
|
+
# data_color_palette: {
|
1455
|
+
# colors: ["HexColor"],
|
1456
|
+
# min_max_gradient: ["HexColor"],
|
1457
|
+
# empty_fill_color: "HexColor",
|
1458
|
+
# },
|
1459
|
+
# ui_color_palette: {
|
1460
|
+
# primary_foreground: "HexColor",
|
1461
|
+
# primary_background: "HexColor",
|
1462
|
+
# secondary_foreground: "HexColor",
|
1463
|
+
# secondary_background: "HexColor",
|
1464
|
+
# accent: "HexColor",
|
1465
|
+
# accent_foreground: "HexColor",
|
1466
|
+
# danger: "HexColor",
|
1467
|
+
# danger_foreground: "HexColor",
|
1468
|
+
# warning: "HexColor",
|
1469
|
+
# warning_foreground: "HexColor",
|
1470
|
+
# success: "HexColor",
|
1471
|
+
# success_foreground: "HexColor",
|
1472
|
+
# dimension: "HexColor",
|
1473
|
+
# dimension_foreground: "HexColor",
|
1474
|
+
# measure: "HexColor",
|
1475
|
+
# measure_foreground: "HexColor",
|
1476
|
+
# },
|
1477
|
+
# sheet: {
|
1478
|
+
# tile: {
|
1479
|
+
# border: {
|
1480
|
+
# show: false,
|
1481
|
+
# },
|
1482
|
+
# },
|
1483
|
+
# tile_layout: {
|
1484
|
+
# gutter: {
|
1485
|
+
# show: false,
|
1486
|
+
# },
|
1487
|
+
# margin: {
|
1488
|
+
# show: false,
|
1489
|
+
# },
|
1490
|
+
# },
|
1491
|
+
# },
|
1492
|
+
# },
|
1493
|
+
# permissions: [
|
1494
|
+
# {
|
1495
|
+
# principal: "Principal", # required
|
1496
|
+
# actions: ["String"], # required
|
1497
|
+
# },
|
1498
|
+
# ],
|
1499
|
+
# tags: [
|
1500
|
+
# {
|
1501
|
+
# key: "TagKey", # required
|
1502
|
+
# value: "TagValue", # required
|
1503
|
+
# },
|
1504
|
+
# ],
|
1505
|
+
# })
|
1506
|
+
#
|
1507
|
+
# @example Response structure
|
1508
|
+
#
|
1509
|
+
# resp.arn #=> String
|
1510
|
+
# resp.version_arn #=> String
|
1511
|
+
# resp.theme_id #=> String
|
1512
|
+
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
1513
|
+
# resp.status #=> Integer
|
1514
|
+
# resp.request_id #=> String
|
1515
|
+
#
|
1516
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateTheme AWS API Documentation
|
1517
|
+
#
|
1518
|
+
# @overload create_theme(params = {})
|
1519
|
+
# @param [Hash] params ({})
|
1520
|
+
def create_theme(params = {}, options = {})
|
1521
|
+
req = build_request(:create_theme, params)
|
1522
|
+
req.send_request(options)
|
1523
|
+
end
|
1524
|
+
|
1525
|
+
# Creates a theme alias for a theme.
|
1526
|
+
#
|
1527
|
+
# @option params [required, String] :aws_account_id
|
1528
|
+
# The ID of the AWS account that contains the theme for the new theme
|
1529
|
+
# alias.
|
1530
|
+
#
|
1531
|
+
# @option params [required, String] :theme_id
|
1532
|
+
# An ID for the theme alias.
|
1533
|
+
#
|
1534
|
+
# @option params [required, String] :alias_name
|
1535
|
+
# The name that you want to give to the theme alias that you are
|
1536
|
+
# creating. The alias name can't begin with a `$`. Alias names that
|
1537
|
+
# start with `$` are reserved by Amazon QuickSight.
|
1538
|
+
#
|
1539
|
+
# @option params [required, Integer] :theme_version_number
|
1540
|
+
# The version number of the theme.
|
1541
|
+
#
|
1542
|
+
# @return [Types::CreateThemeAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1543
|
+
#
|
1544
|
+
# * {Types::CreateThemeAliasResponse#theme_alias #theme_alias} => Types::ThemeAlias
|
1545
|
+
# * {Types::CreateThemeAliasResponse#status #status} => Integer
|
1546
|
+
# * {Types::CreateThemeAliasResponse#request_id #request_id} => String
|
1547
|
+
#
|
1548
|
+
# @example Request syntax with placeholder values
|
1549
|
+
#
|
1550
|
+
# resp = client.create_theme_alias({
|
1551
|
+
# aws_account_id: "AwsAccountId", # required
|
1552
|
+
# theme_id: "RestrictiveResourceId", # required
|
1553
|
+
# alias_name: "AliasName", # required
|
1554
|
+
# theme_version_number: 1, # required
|
1555
|
+
# })
|
1556
|
+
#
|
1557
|
+
# @example Response structure
|
1558
|
+
#
|
1559
|
+
# resp.theme_alias.arn #=> String
|
1560
|
+
# resp.theme_alias.alias_name #=> String
|
1561
|
+
# resp.theme_alias.theme_version_number #=> Integer
|
1562
|
+
# resp.status #=> Integer
|
1563
|
+
# resp.request_id #=> String
|
1564
|
+
#
|
1565
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateThemeAlias AWS API Documentation
|
1566
|
+
#
|
1567
|
+
# @overload create_theme_alias(params = {})
|
1568
|
+
# @param [Hash] params ({})
|
1569
|
+
def create_theme_alias(params = {}, options = {})
|
1570
|
+
req = build_request(:create_theme_alias, params)
|
1571
|
+
req.send_request(options)
|
1572
|
+
end
|
1573
|
+
|
1284
1574
|
# Deletes a dashboard.
|
1285
1575
|
#
|
1286
1576
|
# @option params [required, String] :aws_account_id
|
@@ -1586,10 +1876,10 @@ module Aws::QuickSight
|
|
1586
1876
|
# The ID for the template that the specified alias is for.
|
1587
1877
|
#
|
1588
1878
|
# @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.
|
1879
|
+
# The name for the template alias. To delete a specific alias, you
|
1880
|
+
# delete the version that the alias points to. You can specify the alias
|
1881
|
+
# name, or specify the latest version of the template by providing the
|
1882
|
+
# keyword `$LATEST` in the `AliasName` parameter.
|
1593
1883
|
#
|
1594
1884
|
# @return [Types::DeleteTemplateAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1595
1885
|
#
|
@@ -1624,6 +1914,98 @@ module Aws::QuickSight
|
|
1624
1914
|
req.send_request(options)
|
1625
1915
|
end
|
1626
1916
|
|
1917
|
+
# Deletes a theme.
|
1918
|
+
#
|
1919
|
+
# @option params [required, String] :aws_account_id
|
1920
|
+
# The ID of the AWS account that contains the theme that you're
|
1921
|
+
# deleting.
|
1922
|
+
#
|
1923
|
+
# @option params [required, String] :theme_id
|
1924
|
+
# An ID for the theme that you want to delete.
|
1925
|
+
#
|
1926
|
+
# @option params [Integer] :version_number
|
1927
|
+
# The version of the theme that you want to delete.
|
1928
|
+
#
|
1929
|
+
# **Note:** If you don't provide a version number, you're using this
|
1930
|
+
# call to `DeleteTheme` to delete all versions of the theme.
|
1931
|
+
#
|
1932
|
+
# @return [Types::DeleteThemeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1933
|
+
#
|
1934
|
+
# * {Types::DeleteThemeResponse#arn #arn} => String
|
1935
|
+
# * {Types::DeleteThemeResponse#request_id #request_id} => String
|
1936
|
+
# * {Types::DeleteThemeResponse#status #status} => Integer
|
1937
|
+
# * {Types::DeleteThemeResponse#theme_id #theme_id} => String
|
1938
|
+
#
|
1939
|
+
# @example Request syntax with placeholder values
|
1940
|
+
#
|
1941
|
+
# resp = client.delete_theme({
|
1942
|
+
# aws_account_id: "AwsAccountId", # required
|
1943
|
+
# theme_id: "RestrictiveResourceId", # required
|
1944
|
+
# version_number: 1,
|
1945
|
+
# })
|
1946
|
+
#
|
1947
|
+
# @example Response structure
|
1948
|
+
#
|
1949
|
+
# resp.arn #=> String
|
1950
|
+
# resp.request_id #=> String
|
1951
|
+
# resp.status #=> Integer
|
1952
|
+
# resp.theme_id #=> String
|
1953
|
+
#
|
1954
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteTheme AWS API Documentation
|
1955
|
+
#
|
1956
|
+
# @overload delete_theme(params = {})
|
1957
|
+
# @param [Hash] params ({})
|
1958
|
+
def delete_theme(params = {}, options = {})
|
1959
|
+
req = build_request(:delete_theme, params)
|
1960
|
+
req.send_request(options)
|
1961
|
+
end
|
1962
|
+
|
1963
|
+
# Deletes the version of the theme that the specified theme alias points
|
1964
|
+
# to. If you provide a specific alias, you delete the version of the
|
1965
|
+
# theme that the alias points to.
|
1966
|
+
#
|
1967
|
+
# @option params [required, String] :aws_account_id
|
1968
|
+
# The ID of the AWS account that contains the theme alias to delete.
|
1969
|
+
#
|
1970
|
+
# @option params [required, String] :theme_id
|
1971
|
+
# The ID for the theme that the specified alias is for.
|
1972
|
+
#
|
1973
|
+
# @option params [required, String] :alias_name
|
1974
|
+
# The unique name for the theme alias to delete.
|
1975
|
+
#
|
1976
|
+
# @return [Types::DeleteThemeAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1977
|
+
#
|
1978
|
+
# * {Types::DeleteThemeAliasResponse#alias_name #alias_name} => String
|
1979
|
+
# * {Types::DeleteThemeAliasResponse#arn #arn} => String
|
1980
|
+
# * {Types::DeleteThemeAliasResponse#request_id #request_id} => String
|
1981
|
+
# * {Types::DeleteThemeAliasResponse#status #status} => Integer
|
1982
|
+
# * {Types::DeleteThemeAliasResponse#theme_id #theme_id} => String
|
1983
|
+
#
|
1984
|
+
# @example Request syntax with placeholder values
|
1985
|
+
#
|
1986
|
+
# resp = client.delete_theme_alias({
|
1987
|
+
# aws_account_id: "AwsAccountId", # required
|
1988
|
+
# theme_id: "RestrictiveResourceId", # required
|
1989
|
+
# alias_name: "AliasName", # required
|
1990
|
+
# })
|
1991
|
+
#
|
1992
|
+
# @example Response structure
|
1993
|
+
#
|
1994
|
+
# resp.alias_name #=> String
|
1995
|
+
# resp.arn #=> String
|
1996
|
+
# resp.request_id #=> String
|
1997
|
+
# resp.status #=> Integer
|
1998
|
+
# resp.theme_id #=> String
|
1999
|
+
#
|
2000
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteThemeAlias AWS API Documentation
|
2001
|
+
#
|
2002
|
+
# @overload delete_theme_alias(params = {})
|
2003
|
+
# @param [Hash] params ({})
|
2004
|
+
def delete_theme_alias(params = {}, options = {})
|
2005
|
+
req = build_request(:delete_theme_alias, params)
|
2006
|
+
req.send_request(options)
|
2007
|
+
end
|
2008
|
+
|
1627
2009
|
# Deletes the Amazon QuickSight user that is associated with the
|
1628
2010
|
# identity of the AWS Identity and Access Management (IAM) user or role
|
1629
2011
|
# that's making the call. The IAM user isn't deleted as a result of
|
@@ -2031,9 +2413,54 @@ module Aws::QuickSight
|
|
2031
2413
|
# resp.data_source.data_source_parameters.teradata_parameters.database #=> String
|
2032
2414
|
# resp.data_source.data_source_parameters.twitter_parameters.query #=> String
|
2033
2415
|
# resp.data_source.data_source_parameters.twitter_parameters.max_rows #=> Integer
|
2416
|
+
# resp.data_source.alternate_data_source_parameters #=> Array
|
2417
|
+
# resp.data_source.alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
|
2418
|
+
# resp.data_source.alternate_data_source_parameters[0].athena_parameters.work_group #=> String
|
2419
|
+
# resp.data_source.alternate_data_source_parameters[0].aurora_parameters.host #=> String
|
2420
|
+
# resp.data_source.alternate_data_source_parameters[0].aurora_parameters.port #=> Integer
|
2421
|
+
# resp.data_source.alternate_data_source_parameters[0].aurora_parameters.database #=> String
|
2422
|
+
# resp.data_source.alternate_data_source_parameters[0].aurora_postgre_sql_parameters.host #=> String
|
2423
|
+
# resp.data_source.alternate_data_source_parameters[0].aurora_postgre_sql_parameters.port #=> Integer
|
2424
|
+
# resp.data_source.alternate_data_source_parameters[0].aurora_postgre_sql_parameters.database #=> String
|
2425
|
+
# resp.data_source.alternate_data_source_parameters[0].aws_iot_analytics_parameters.data_set_name #=> String
|
2426
|
+
# resp.data_source.alternate_data_source_parameters[0].jira_parameters.site_base_url #=> String
|
2427
|
+
# resp.data_source.alternate_data_source_parameters[0].maria_db_parameters.host #=> String
|
2428
|
+
# resp.data_source.alternate_data_source_parameters[0].maria_db_parameters.port #=> Integer
|
2429
|
+
# resp.data_source.alternate_data_source_parameters[0].maria_db_parameters.database #=> String
|
2430
|
+
# resp.data_source.alternate_data_source_parameters[0].my_sql_parameters.host #=> String
|
2431
|
+
# resp.data_source.alternate_data_source_parameters[0].my_sql_parameters.port #=> Integer
|
2432
|
+
# resp.data_source.alternate_data_source_parameters[0].my_sql_parameters.database #=> String
|
2433
|
+
# resp.data_source.alternate_data_source_parameters[0].postgre_sql_parameters.host #=> String
|
2434
|
+
# resp.data_source.alternate_data_source_parameters[0].postgre_sql_parameters.port #=> Integer
|
2435
|
+
# resp.data_source.alternate_data_source_parameters[0].postgre_sql_parameters.database #=> String
|
2436
|
+
# resp.data_source.alternate_data_source_parameters[0].presto_parameters.host #=> String
|
2437
|
+
# resp.data_source.alternate_data_source_parameters[0].presto_parameters.port #=> Integer
|
2438
|
+
# resp.data_source.alternate_data_source_parameters[0].presto_parameters.catalog #=> String
|
2439
|
+
# resp.data_source.alternate_data_source_parameters[0].rds_parameters.instance_id #=> String
|
2440
|
+
# resp.data_source.alternate_data_source_parameters[0].rds_parameters.database #=> String
|
2441
|
+
# resp.data_source.alternate_data_source_parameters[0].redshift_parameters.host #=> String
|
2442
|
+
# resp.data_source.alternate_data_source_parameters[0].redshift_parameters.port #=> Integer
|
2443
|
+
# resp.data_source.alternate_data_source_parameters[0].redshift_parameters.database #=> String
|
2444
|
+
# resp.data_source.alternate_data_source_parameters[0].redshift_parameters.cluster_id #=> String
|
2445
|
+
# resp.data_source.alternate_data_source_parameters[0].s3_parameters.manifest_file_location.bucket #=> String
|
2446
|
+
# resp.data_source.alternate_data_source_parameters[0].s3_parameters.manifest_file_location.key #=> String
|
2447
|
+
# resp.data_source.alternate_data_source_parameters[0].service_now_parameters.site_base_url #=> String
|
2448
|
+
# resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.host #=> String
|
2449
|
+
# resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.database #=> String
|
2450
|
+
# resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.warehouse #=> String
|
2451
|
+
# resp.data_source.alternate_data_source_parameters[0].spark_parameters.host #=> String
|
2452
|
+
# resp.data_source.alternate_data_source_parameters[0].spark_parameters.port #=> Integer
|
2453
|
+
# resp.data_source.alternate_data_source_parameters[0].sql_server_parameters.host #=> String
|
2454
|
+
# resp.data_source.alternate_data_source_parameters[0].sql_server_parameters.port #=> Integer
|
2455
|
+
# resp.data_source.alternate_data_source_parameters[0].sql_server_parameters.database #=> String
|
2456
|
+
# resp.data_source.alternate_data_source_parameters[0].teradata_parameters.host #=> String
|
2457
|
+
# resp.data_source.alternate_data_source_parameters[0].teradata_parameters.port #=> Integer
|
2458
|
+
# resp.data_source.alternate_data_source_parameters[0].teradata_parameters.database #=> String
|
2459
|
+
# resp.data_source.alternate_data_source_parameters[0].twitter_parameters.query #=> String
|
2460
|
+
# resp.data_source.alternate_data_source_parameters[0].twitter_parameters.max_rows #=> Integer
|
2034
2461
|
# resp.data_source.vpc_connection_properties.vpc_connection_arn #=> String
|
2035
2462
|
# resp.data_source.ssl_properties.disable_ssl #=> Boolean
|
2036
|
-
# resp.data_source.error_info.type #=> String, one of "TIMEOUT", "ENGINE_VERSION_NOT_SUPPORTED", "UNKNOWN_HOST", "GENERIC_SQL_FAILURE", "CONFLICT", "UNKNOWN"
|
2463
|
+
# 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"
|
2037
2464
|
# resp.data_source.error_info.message #=> String
|
2038
2465
|
# resp.request_id #=> String
|
2039
2466
|
# resp.status #=> Integer
|
@@ -2264,6 +2691,7 @@ module Aws::QuickSight
|
|
2264
2691
|
#
|
2265
2692
|
# * {Types::DescribeTemplateResponse#template #template} => Types::Template
|
2266
2693
|
# * {Types::DescribeTemplateResponse#status #status} => Integer
|
2694
|
+
# * {Types::DescribeTemplateResponse#request_id #request_id} => String
|
2267
2695
|
#
|
2268
2696
|
# @example Request syntax with placeholder values
|
2269
2697
|
#
|
@@ -2300,6 +2728,7 @@ module Aws::QuickSight
|
|
2300
2728
|
# resp.template.last_updated_time #=> Time
|
2301
2729
|
# resp.template.created_time #=> Time
|
2302
2730
|
# resp.status #=> Integer
|
2731
|
+
# resp.request_id #=> String
|
2303
2732
|
#
|
2304
2733
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTemplate AWS API Documentation
|
2305
2734
|
#
|
@@ -2401,6 +2830,182 @@ module Aws::QuickSight
|
|
2401
2830
|
req.send_request(options)
|
2402
2831
|
end
|
2403
2832
|
|
2833
|
+
# Describes a theme.
|
2834
|
+
#
|
2835
|
+
# @option params [required, String] :aws_account_id
|
2836
|
+
# The ID of the AWS account that contains the theme that you're
|
2837
|
+
# describing.
|
2838
|
+
#
|
2839
|
+
# @option params [required, String] :theme_id
|
2840
|
+
# The ID for the theme.
|
2841
|
+
#
|
2842
|
+
# @option params [Integer] :version_number
|
2843
|
+
# The version number for the version to describe. If a `VersionNumber`
|
2844
|
+
# parameter value isn't provided, the latest version of the theme is
|
2845
|
+
# described.
|
2846
|
+
#
|
2847
|
+
# @option params [String] :alias_name
|
2848
|
+
# The alias of the theme that you want to describe. If you name a
|
2849
|
+
# specific alias, you describe the version that the alias points to. You
|
2850
|
+
# can specify the latest version of the theme by providing the keyword
|
2851
|
+
# `$LATEST` in the `AliasName` parameter. The keyword `$PUBLISHED`
|
2852
|
+
# doesn't apply to themes.
|
2853
|
+
#
|
2854
|
+
# @return [Types::DescribeThemeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2855
|
+
#
|
2856
|
+
# * {Types::DescribeThemeResponse#theme #theme} => Types::Theme
|
2857
|
+
# * {Types::DescribeThemeResponse#status #status} => Integer
|
2858
|
+
# * {Types::DescribeThemeResponse#request_id #request_id} => String
|
2859
|
+
#
|
2860
|
+
# @example Request syntax with placeholder values
|
2861
|
+
#
|
2862
|
+
# resp = client.describe_theme({
|
2863
|
+
# aws_account_id: "AwsAndAccountId", # required
|
2864
|
+
# theme_id: "RestrictiveResourceId", # required
|
2865
|
+
# version_number: 1,
|
2866
|
+
# alias_name: "AliasName",
|
2867
|
+
# })
|
2868
|
+
#
|
2869
|
+
# @example Response structure
|
2870
|
+
#
|
2871
|
+
# resp.theme.arn #=> String
|
2872
|
+
# resp.theme.name #=> String
|
2873
|
+
# resp.theme.theme_id #=> String
|
2874
|
+
# resp.theme.version.version_number #=> Integer
|
2875
|
+
# resp.theme.version.arn #=> String
|
2876
|
+
# resp.theme.version.description #=> String
|
2877
|
+
# resp.theme.version.base_theme_id #=> String
|
2878
|
+
# resp.theme.version.created_time #=> Time
|
2879
|
+
# resp.theme.version.configuration.data_color_palette.colors #=> Array
|
2880
|
+
# resp.theme.version.configuration.data_color_palette.colors[0] #=> String
|
2881
|
+
# resp.theme.version.configuration.data_color_palette.min_max_gradient #=> Array
|
2882
|
+
# resp.theme.version.configuration.data_color_palette.min_max_gradient[0] #=> String
|
2883
|
+
# resp.theme.version.configuration.data_color_palette.empty_fill_color #=> String
|
2884
|
+
# resp.theme.version.configuration.ui_color_palette.primary_foreground #=> String
|
2885
|
+
# resp.theme.version.configuration.ui_color_palette.primary_background #=> String
|
2886
|
+
# resp.theme.version.configuration.ui_color_palette.secondary_foreground #=> String
|
2887
|
+
# resp.theme.version.configuration.ui_color_palette.secondary_background #=> String
|
2888
|
+
# resp.theme.version.configuration.ui_color_palette.accent #=> String
|
2889
|
+
# resp.theme.version.configuration.ui_color_palette.accent_foreground #=> String
|
2890
|
+
# resp.theme.version.configuration.ui_color_palette.danger #=> String
|
2891
|
+
# resp.theme.version.configuration.ui_color_palette.danger_foreground #=> String
|
2892
|
+
# resp.theme.version.configuration.ui_color_palette.warning #=> String
|
2893
|
+
# resp.theme.version.configuration.ui_color_palette.warning_foreground #=> String
|
2894
|
+
# resp.theme.version.configuration.ui_color_palette.success #=> String
|
2895
|
+
# resp.theme.version.configuration.ui_color_palette.success_foreground #=> String
|
2896
|
+
# resp.theme.version.configuration.ui_color_palette.dimension #=> String
|
2897
|
+
# resp.theme.version.configuration.ui_color_palette.dimension_foreground #=> String
|
2898
|
+
# resp.theme.version.configuration.ui_color_palette.measure #=> String
|
2899
|
+
# resp.theme.version.configuration.ui_color_palette.measure_foreground #=> String
|
2900
|
+
# resp.theme.version.configuration.sheet.tile.border.show #=> Boolean
|
2901
|
+
# resp.theme.version.configuration.sheet.tile_layout.gutter.show #=> Boolean
|
2902
|
+
# resp.theme.version.configuration.sheet.tile_layout.margin.show #=> Boolean
|
2903
|
+
# resp.theme.version.errors #=> Array
|
2904
|
+
# resp.theme.version.errors[0].type #=> String, one of "INTERNAL_FAILURE"
|
2905
|
+
# resp.theme.version.errors[0].message #=> String
|
2906
|
+
# resp.theme.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
2907
|
+
# resp.theme.created_time #=> Time
|
2908
|
+
# resp.theme.last_updated_time #=> Time
|
2909
|
+
# resp.theme.type #=> String, one of "QUICKSIGHT", "CUSTOM", "ALL"
|
2910
|
+
# resp.status #=> Integer
|
2911
|
+
# resp.request_id #=> String
|
2912
|
+
#
|
2913
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTheme AWS API Documentation
|
2914
|
+
#
|
2915
|
+
# @overload describe_theme(params = {})
|
2916
|
+
# @param [Hash] params ({})
|
2917
|
+
def describe_theme(params = {}, options = {})
|
2918
|
+
req = build_request(:describe_theme, params)
|
2919
|
+
req.send_request(options)
|
2920
|
+
end
|
2921
|
+
|
2922
|
+
# Describes the alias for a theme.
|
2923
|
+
#
|
2924
|
+
# @option params [required, String] :aws_account_id
|
2925
|
+
# The ID of the AWS account that contains the theme alias that you're
|
2926
|
+
# describing.
|
2927
|
+
#
|
2928
|
+
# @option params [required, String] :theme_id
|
2929
|
+
# The ID for the theme.
|
2930
|
+
#
|
2931
|
+
# @option params [required, String] :alias_name
|
2932
|
+
# The name of the theme alias that you want to describe.
|
2933
|
+
#
|
2934
|
+
# @return [Types::DescribeThemeAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2935
|
+
#
|
2936
|
+
# * {Types::DescribeThemeAliasResponse#theme_alias #theme_alias} => Types::ThemeAlias
|
2937
|
+
# * {Types::DescribeThemeAliasResponse#status #status} => Integer
|
2938
|
+
# * {Types::DescribeThemeAliasResponse#request_id #request_id} => String
|
2939
|
+
#
|
2940
|
+
# @example Request syntax with placeholder values
|
2941
|
+
#
|
2942
|
+
# resp = client.describe_theme_alias({
|
2943
|
+
# aws_account_id: "AwsAccountId", # required
|
2944
|
+
# theme_id: "RestrictiveResourceId", # required
|
2945
|
+
# alias_name: "AliasName", # required
|
2946
|
+
# })
|
2947
|
+
#
|
2948
|
+
# @example Response structure
|
2949
|
+
#
|
2950
|
+
# resp.theme_alias.arn #=> String
|
2951
|
+
# resp.theme_alias.alias_name #=> String
|
2952
|
+
# resp.theme_alias.theme_version_number #=> Integer
|
2953
|
+
# resp.status #=> Integer
|
2954
|
+
# resp.request_id #=> String
|
2955
|
+
#
|
2956
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeThemeAlias AWS API Documentation
|
2957
|
+
#
|
2958
|
+
# @overload describe_theme_alias(params = {})
|
2959
|
+
# @param [Hash] params ({})
|
2960
|
+
def describe_theme_alias(params = {}, options = {})
|
2961
|
+
req = build_request(:describe_theme_alias, params)
|
2962
|
+
req.send_request(options)
|
2963
|
+
end
|
2964
|
+
|
2965
|
+
# Describes the read and write permissions for a theme.
|
2966
|
+
#
|
2967
|
+
# @option params [required, String] :aws_account_id
|
2968
|
+
# The ID of the AWS account that contains the theme that you're
|
2969
|
+
# describing.
|
2970
|
+
#
|
2971
|
+
# @option params [required, String] :theme_id
|
2972
|
+
# The ID for the theme that you want to describe permissions for.
|
2973
|
+
#
|
2974
|
+
# @return [Types::DescribeThemePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2975
|
+
#
|
2976
|
+
# * {Types::DescribeThemePermissionsResponse#theme_id #theme_id} => String
|
2977
|
+
# * {Types::DescribeThemePermissionsResponse#theme_arn #theme_arn} => String
|
2978
|
+
# * {Types::DescribeThemePermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission>
|
2979
|
+
# * {Types::DescribeThemePermissionsResponse#request_id #request_id} => String
|
2980
|
+
# * {Types::DescribeThemePermissionsResponse#status #status} => Integer
|
2981
|
+
#
|
2982
|
+
# @example Request syntax with placeholder values
|
2983
|
+
#
|
2984
|
+
# resp = client.describe_theme_permissions({
|
2985
|
+
# aws_account_id: "AwsAccountId", # required
|
2986
|
+
# theme_id: "RestrictiveResourceId", # required
|
2987
|
+
# })
|
2988
|
+
#
|
2989
|
+
# @example Response structure
|
2990
|
+
#
|
2991
|
+
# resp.theme_id #=> String
|
2992
|
+
# resp.theme_arn #=> String
|
2993
|
+
# resp.permissions #=> Array
|
2994
|
+
# resp.permissions[0].principal #=> String
|
2995
|
+
# resp.permissions[0].actions #=> Array
|
2996
|
+
# resp.permissions[0].actions[0] #=> String
|
2997
|
+
# resp.request_id #=> String
|
2998
|
+
# resp.status #=> Integer
|
2999
|
+
#
|
3000
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeThemePermissions AWS API Documentation
|
3001
|
+
#
|
3002
|
+
# @overload describe_theme_permissions(params = {})
|
3003
|
+
# @param [Hash] params ({})
|
3004
|
+
def describe_theme_permissions(params = {}, options = {})
|
3005
|
+
req = build_request(:describe_theme_permissions, params)
|
3006
|
+
req.send_request(options)
|
3007
|
+
end
|
3008
|
+
|
2404
3009
|
# Returns information about a user, given the user name.
|
2405
3010
|
#
|
2406
3011
|
# @option params [required, String] :user_name
|
@@ -2448,15 +3053,25 @@ module Aws::QuickSight
|
|
2448
3053
|
req.send_request(options)
|
2449
3054
|
end
|
2450
3055
|
|
2451
|
-
# Generates a
|
2452
|
-
#
|
2453
|
-
#
|
2454
|
-
# Dashboards][1] in the *Amazon QuickSight User Guide* or [Embedding
|
2455
|
-
# Amazon QuickSight Dashboards][2] in the *Amazon QuickSight API
|
2456
|
-
# Reference*.
|
3056
|
+
# Generates a URL and authorization code that you can embed in your web
|
3057
|
+
# server code. Before you use this command, make sure that you have
|
3058
|
+
# configured the dashboards and permissions.
|
2457
3059
|
#
|
2458
3060
|
# Currently, you can use `GetDashboardEmbedURL` only from the server,
|
2459
|
-
# not from the user
|
3061
|
+
# not from the user's browser. The following rules apply to the
|
3062
|
+
# combination of URL and authorization code:
|
3063
|
+
#
|
3064
|
+
# * They must be used together.
|
3065
|
+
#
|
3066
|
+
# * They can be used one time only.
|
3067
|
+
#
|
3068
|
+
# * They are valid for 5 minutes after you run this command.
|
3069
|
+
#
|
3070
|
+
# * The resulting user session is valid for 10 hours.
|
3071
|
+
#
|
3072
|
+
# For more information, see [Embedding Amazon QuickSight Dashboards][1]
|
3073
|
+
# in the *Amazon QuickSight User Guide* or [Embedding Amazon QuickSight
|
3074
|
+
# Dashboards][2] in the *Amazon QuickSight API Reference*.
|
2460
3075
|
#
|
2461
3076
|
#
|
2462
3077
|
#
|
@@ -2783,9 +3398,54 @@ module Aws::QuickSight
|
|
2783
3398
|
# resp.data_sources[0].data_source_parameters.teradata_parameters.database #=> String
|
2784
3399
|
# resp.data_sources[0].data_source_parameters.twitter_parameters.query #=> String
|
2785
3400
|
# resp.data_sources[0].data_source_parameters.twitter_parameters.max_rows #=> Integer
|
3401
|
+
# resp.data_sources[0].alternate_data_source_parameters #=> Array
|
3402
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
|
3403
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].athena_parameters.work_group #=> String
|
3404
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].aurora_parameters.host #=> String
|
3405
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].aurora_parameters.port #=> Integer
|
3406
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].aurora_parameters.database #=> String
|
3407
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].aurora_postgre_sql_parameters.host #=> String
|
3408
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].aurora_postgre_sql_parameters.port #=> Integer
|
3409
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].aurora_postgre_sql_parameters.database #=> String
|
3410
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].aws_iot_analytics_parameters.data_set_name #=> String
|
3411
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].jira_parameters.site_base_url #=> String
|
3412
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].maria_db_parameters.host #=> String
|
3413
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].maria_db_parameters.port #=> Integer
|
3414
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].maria_db_parameters.database #=> String
|
3415
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].my_sql_parameters.host #=> String
|
3416
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].my_sql_parameters.port #=> Integer
|
3417
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].my_sql_parameters.database #=> String
|
3418
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].postgre_sql_parameters.host #=> String
|
3419
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].postgre_sql_parameters.port #=> Integer
|
3420
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].postgre_sql_parameters.database #=> String
|
3421
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].presto_parameters.host #=> String
|
3422
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].presto_parameters.port #=> Integer
|
3423
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].presto_parameters.catalog #=> String
|
3424
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].rds_parameters.instance_id #=> String
|
3425
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].rds_parameters.database #=> String
|
3426
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.host #=> String
|
3427
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.port #=> Integer
|
3428
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.database #=> String
|
3429
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.cluster_id #=> String
|
3430
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].s3_parameters.manifest_file_location.bucket #=> String
|
3431
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].s3_parameters.manifest_file_location.key #=> String
|
3432
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].service_now_parameters.site_base_url #=> String
|
3433
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.host #=> String
|
3434
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.database #=> String
|
3435
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.warehouse #=> String
|
3436
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].spark_parameters.host #=> String
|
3437
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].spark_parameters.port #=> Integer
|
3438
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].sql_server_parameters.host #=> String
|
3439
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].sql_server_parameters.port #=> Integer
|
3440
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].sql_server_parameters.database #=> String
|
3441
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].teradata_parameters.host #=> String
|
3442
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].teradata_parameters.port #=> Integer
|
3443
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].teradata_parameters.database #=> String
|
3444
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].twitter_parameters.query #=> String
|
3445
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].twitter_parameters.max_rows #=> Integer
|
2786
3446
|
# resp.data_sources[0].vpc_connection_properties.vpc_connection_arn #=> String
|
2787
3447
|
# resp.data_sources[0].ssl_properties.disable_ssl #=> Boolean
|
2788
|
-
# resp.data_sources[0].error_info.type #=> String, one of "TIMEOUT", "ENGINE_VERSION_NOT_SUPPORTED", "UNKNOWN_HOST", "GENERIC_SQL_FAILURE", "CONFLICT", "UNKNOWN"
|
3448
|
+
# 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"
|
2789
3449
|
# resp.data_sources[0].error_info.message #=> String
|
2790
3450
|
# resp.next_token #=> String
|
2791
3451
|
# resp.request_id #=> String
|
@@ -3273,6 +3933,173 @@ module Aws::QuickSight
|
|
3273
3933
|
req.send_request(options)
|
3274
3934
|
end
|
3275
3935
|
|
3936
|
+
# Lists all the aliases of a theme.
|
3937
|
+
#
|
3938
|
+
# @option params [required, String] :aws_account_id
|
3939
|
+
# The ID of the AWS account that contains the theme aliases that you're
|
3940
|
+
# listing.
|
3941
|
+
#
|
3942
|
+
# @option params [required, String] :theme_id
|
3943
|
+
# The ID for the theme.
|
3944
|
+
#
|
3945
|
+
# @option params [String] :next_token
|
3946
|
+
# The token for the next set of results, or null if there are no more
|
3947
|
+
# results.
|
3948
|
+
#
|
3949
|
+
# @option params [Integer] :max_results
|
3950
|
+
# The maximum number of results to be returned per request.
|
3951
|
+
#
|
3952
|
+
# @return [Types::ListThemeAliasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3953
|
+
#
|
3954
|
+
# * {Types::ListThemeAliasesResponse#theme_alias_list #theme_alias_list} => Array<Types::ThemeAlias>
|
3955
|
+
# * {Types::ListThemeAliasesResponse#status #status} => Integer
|
3956
|
+
# * {Types::ListThemeAliasesResponse#request_id #request_id} => String
|
3957
|
+
# * {Types::ListThemeAliasesResponse#next_token #next_token} => String
|
3958
|
+
#
|
3959
|
+
# @example Request syntax with placeholder values
|
3960
|
+
#
|
3961
|
+
# resp = client.list_theme_aliases({
|
3962
|
+
# aws_account_id: "AwsAccountId", # required
|
3963
|
+
# theme_id: "RestrictiveResourceId", # required
|
3964
|
+
# next_token: "String",
|
3965
|
+
# max_results: 1,
|
3966
|
+
# })
|
3967
|
+
#
|
3968
|
+
# @example Response structure
|
3969
|
+
#
|
3970
|
+
# resp.theme_alias_list #=> Array
|
3971
|
+
# resp.theme_alias_list[0].arn #=> String
|
3972
|
+
# resp.theme_alias_list[0].alias_name #=> String
|
3973
|
+
# resp.theme_alias_list[0].theme_version_number #=> Integer
|
3974
|
+
# resp.status #=> Integer
|
3975
|
+
# resp.request_id #=> String
|
3976
|
+
# resp.next_token #=> String
|
3977
|
+
#
|
3978
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListThemeAliases AWS API Documentation
|
3979
|
+
#
|
3980
|
+
# @overload list_theme_aliases(params = {})
|
3981
|
+
# @param [Hash] params ({})
|
3982
|
+
def list_theme_aliases(params = {}, options = {})
|
3983
|
+
req = build_request(:list_theme_aliases, params)
|
3984
|
+
req.send_request(options)
|
3985
|
+
end
|
3986
|
+
|
3987
|
+
# Lists all the versions of the themes in the current AWS account.
|
3988
|
+
#
|
3989
|
+
# @option params [required, String] :aws_account_id
|
3990
|
+
# The ID of the AWS account that contains the themes that you're
|
3991
|
+
# listing.
|
3992
|
+
#
|
3993
|
+
# @option params [required, String] :theme_id
|
3994
|
+
# The ID for the theme.
|
3995
|
+
#
|
3996
|
+
# @option params [String] :next_token
|
3997
|
+
# The token for the next set of results, or null if there are no more
|
3998
|
+
# results.
|
3999
|
+
#
|
4000
|
+
# @option params [Integer] :max_results
|
4001
|
+
# The maximum number of results to be returned per request.
|
4002
|
+
#
|
4003
|
+
# @return [Types::ListThemeVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4004
|
+
#
|
4005
|
+
# * {Types::ListThemeVersionsResponse#theme_version_summary_list #theme_version_summary_list} => Array<Types::ThemeVersionSummary>
|
4006
|
+
# * {Types::ListThemeVersionsResponse#next_token #next_token} => String
|
4007
|
+
# * {Types::ListThemeVersionsResponse#status #status} => Integer
|
4008
|
+
# * {Types::ListThemeVersionsResponse#request_id #request_id} => String
|
4009
|
+
#
|
4010
|
+
# @example Request syntax with placeholder values
|
4011
|
+
#
|
4012
|
+
# resp = client.list_theme_versions({
|
4013
|
+
# aws_account_id: "AwsAccountId", # required
|
4014
|
+
# theme_id: "RestrictiveResourceId", # required
|
4015
|
+
# next_token: "String",
|
4016
|
+
# max_results: 1,
|
4017
|
+
# })
|
4018
|
+
#
|
4019
|
+
# @example Response structure
|
4020
|
+
#
|
4021
|
+
# resp.theme_version_summary_list #=> Array
|
4022
|
+
# resp.theme_version_summary_list[0].version_number #=> Integer
|
4023
|
+
# resp.theme_version_summary_list[0].arn #=> String
|
4024
|
+
# resp.theme_version_summary_list[0].description #=> String
|
4025
|
+
# resp.theme_version_summary_list[0].created_time #=> Time
|
4026
|
+
# resp.theme_version_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
4027
|
+
# resp.next_token #=> String
|
4028
|
+
# resp.status #=> Integer
|
4029
|
+
# resp.request_id #=> String
|
4030
|
+
#
|
4031
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListThemeVersions AWS API Documentation
|
4032
|
+
#
|
4033
|
+
# @overload list_theme_versions(params = {})
|
4034
|
+
# @param [Hash] params ({})
|
4035
|
+
def list_theme_versions(params = {}, options = {})
|
4036
|
+
req = build_request(:list_theme_versions, params)
|
4037
|
+
req.send_request(options)
|
4038
|
+
end
|
4039
|
+
|
4040
|
+
# Lists all the themes in the current AWS account.
|
4041
|
+
#
|
4042
|
+
# @option params [required, String] :aws_account_id
|
4043
|
+
# The ID of the AWS account that contains the themes that you're
|
4044
|
+
# listing.
|
4045
|
+
#
|
4046
|
+
# @option params [String] :next_token
|
4047
|
+
# The token for the next set of results, or null if there are no more
|
4048
|
+
# results.
|
4049
|
+
#
|
4050
|
+
# @option params [Integer] :max_results
|
4051
|
+
# The maximum number of results to be returned per request.
|
4052
|
+
#
|
4053
|
+
# @option params [String] :type
|
4054
|
+
# The type of themes that you want to list. Valid options include the
|
4055
|
+
# following:
|
4056
|
+
#
|
4057
|
+
# * `ALL (default)`- Display all existing themes.
|
4058
|
+
#
|
4059
|
+
# * `CUSTOM` - Display only the themes created by people using Amazon
|
4060
|
+
# QuickSight.
|
4061
|
+
#
|
4062
|
+
# * `QUICKSIGHT` - Display only the starting themes defined by
|
4063
|
+
# QuickSight.
|
4064
|
+
#
|
4065
|
+
# @return [Types::ListThemesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4066
|
+
#
|
4067
|
+
# * {Types::ListThemesResponse#theme_summary_list #theme_summary_list} => Array<Types::ThemeSummary>
|
4068
|
+
# * {Types::ListThemesResponse#next_token #next_token} => String
|
4069
|
+
# * {Types::ListThemesResponse#status #status} => Integer
|
4070
|
+
# * {Types::ListThemesResponse#request_id #request_id} => String
|
4071
|
+
#
|
4072
|
+
# @example Request syntax with placeholder values
|
4073
|
+
#
|
4074
|
+
# resp = client.list_themes({
|
4075
|
+
# aws_account_id: "AwsAccountId", # required
|
4076
|
+
# next_token: "String",
|
4077
|
+
# max_results: 1,
|
4078
|
+
# type: "QUICKSIGHT", # accepts QUICKSIGHT, CUSTOM, ALL
|
4079
|
+
# })
|
4080
|
+
#
|
4081
|
+
# @example Response structure
|
4082
|
+
#
|
4083
|
+
# resp.theme_summary_list #=> Array
|
4084
|
+
# resp.theme_summary_list[0].arn #=> String
|
4085
|
+
# resp.theme_summary_list[0].name #=> String
|
4086
|
+
# resp.theme_summary_list[0].theme_id #=> String
|
4087
|
+
# resp.theme_summary_list[0].latest_version_number #=> Integer
|
4088
|
+
# resp.theme_summary_list[0].created_time #=> Time
|
4089
|
+
# resp.theme_summary_list[0].last_updated_time #=> Time
|
4090
|
+
# resp.next_token #=> String
|
4091
|
+
# resp.status #=> Integer
|
4092
|
+
# resp.request_id #=> String
|
4093
|
+
#
|
4094
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListThemes AWS API Documentation
|
4095
|
+
#
|
4096
|
+
# @overload list_themes(params = {})
|
4097
|
+
# @param [Hash] params ({})
|
4098
|
+
def list_themes(params = {}, options = {})
|
4099
|
+
req = build_request(:list_themes, params)
|
4100
|
+
req.send_request(options)
|
4101
|
+
end
|
4102
|
+
|
3276
4103
|
# Lists the Amazon QuickSight groups that an Amazon QuickSight user is a
|
3277
4104
|
# member of.
|
3278
4105
|
#
|
@@ -3495,7 +4322,7 @@ module Aws::QuickSight
|
|
3495
4322
|
#
|
3496
4323
|
# @option params [required, Array<Types::DashboardSearchFilter>] :filters
|
3497
4324
|
# The filters to apply to the search. Currently, you can search only by
|
3498
|
-
# user name
|
4325
|
+
# user name, for example, `"Filters": [ \{ "Name": "QUICKSIGHT_USER",
|
3499
4326
|
# "Operator": "StringEquals", "Value":
|
3500
4327
|
# "arn:aws:quicksight:us-east-1:1:user/default/UserName1" \} ]`
|
3501
4328
|
#
|
@@ -3664,15 +4491,24 @@ module Aws::QuickSight
|
|
3664
4491
|
# The display name of the dashboard.
|
3665
4492
|
#
|
3666
4493
|
# @option params [required, Types::DashboardSourceEntity] :source_entity
|
3667
|
-
# The
|
3668
|
-
# `
|
3669
|
-
#
|
3670
|
-
#
|
3671
|
-
#
|
3672
|
-
#
|
4494
|
+
# The entity that you are using as a source when you update the
|
4495
|
+
# dashboard. In `SourceEntity`, you specify the type of object you're
|
4496
|
+
# using as source. You can only update a dashboard from a template, so
|
4497
|
+
# you use a `SourceTemplate` entity. If you need to update a dashboard
|
4498
|
+
# from an analysis, first convert the analysis to a template by using
|
4499
|
+
# the CreateTemplate API operation. For `SourceTemplate`, specify the
|
4500
|
+
# Amazon Resource Name (ARN) of the source template. The
|
4501
|
+
# `SourceTemplate` ARN can contain any AWS Account and any
|
4502
|
+
# QuickSight-supported AWS Region.
|
4503
|
+
#
|
4504
|
+
# Use the `DataSetReferences` entity within `SourceTemplate` to list the
|
4505
|
+
# replacement datasets for the placeholders listed in the original. The
|
4506
|
+
# schema in each dataset must match its placeholder.
|
3673
4507
|
#
|
3674
4508
|
# @option params [Types::Parameters] :parameters
|
3675
|
-
# A structure that contains the parameters of the dashboard.
|
4509
|
+
# A structure that contains the parameters of the dashboard. These are
|
4510
|
+
# parameter overrides for a dashboard. A dashboard can have any type of
|
4511
|
+
# parameters, and some parameters might accept multiple values.
|
3676
4512
|
#
|
3677
4513
|
# @option params [String] :version_description
|
3678
4514
|
# A description for the first version of the dashboard being created.
|
@@ -3692,9 +4528,14 @@ module Aws::QuickSight
|
|
3692
4528
|
# option is `ENABLED` by default.
|
3693
4529
|
#
|
3694
4530
|
# * `VisibilityState` for `SheetControlsOption` - This visibility state
|
3695
|
-
# can be either `COLLAPSED` or `EXPANDED`.
|
3696
|
-
#
|
3697
|
-
#
|
4531
|
+
# can be either `COLLAPSED` or `EXPANDED`. This option is `COLLAPSED`
|
4532
|
+
# by default.
|
4533
|
+
#
|
4534
|
+
# @option params [String] :theme_arn
|
4535
|
+
# The Amazon Resource Name (ARN) of the theme that is being used for
|
4536
|
+
# this dashboard. If you add a value for this field, it overrides the
|
4537
|
+
# value that was originally associated with the entity. The theme ARN
|
4538
|
+
# must exist in the same AWS account where you create the dashboard.
|
3698
4539
|
#
|
3699
4540
|
# @return [Types::UpdateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3700
4541
|
#
|
@@ -3760,6 +4601,7 @@ module Aws::QuickSight
|
|
3760
4601
|
# visibility_state: "EXPANDED", # accepts EXPANDED, COLLAPSED
|
3761
4602
|
# },
|
3762
4603
|
# },
|
4604
|
+
# theme_arn: "Arn",
|
3763
4605
|
# })
|
3764
4606
|
#
|
3765
4607
|
# @example Response structure
|
@@ -4249,7 +5091,96 @@ module Aws::QuickSight
|
|
4249
5091
|
# credential_pair: {
|
4250
5092
|
# username: "Username", # required
|
4251
5093
|
# password: "Password", # required
|
5094
|
+
# alternate_data_source_parameters: [
|
5095
|
+
# {
|
5096
|
+
# amazon_elasticsearch_parameters: {
|
5097
|
+
# domain: "Domain", # required
|
5098
|
+
# },
|
5099
|
+
# athena_parameters: {
|
5100
|
+
# work_group: "WorkGroup",
|
5101
|
+
# },
|
5102
|
+
# aurora_parameters: {
|
5103
|
+
# host: "Host", # required
|
5104
|
+
# port: 1, # required
|
5105
|
+
# database: "Database", # required
|
5106
|
+
# },
|
5107
|
+
# aurora_postgre_sql_parameters: {
|
5108
|
+
# host: "Host", # required
|
5109
|
+
# port: 1, # required
|
5110
|
+
# database: "Database", # required
|
5111
|
+
# },
|
5112
|
+
# aws_iot_analytics_parameters: {
|
5113
|
+
# data_set_name: "DataSetName", # required
|
5114
|
+
# },
|
5115
|
+
# jira_parameters: {
|
5116
|
+
# site_base_url: "SiteBaseUrl", # required
|
5117
|
+
# },
|
5118
|
+
# maria_db_parameters: {
|
5119
|
+
# host: "Host", # required
|
5120
|
+
# port: 1, # required
|
5121
|
+
# database: "Database", # required
|
5122
|
+
# },
|
5123
|
+
# my_sql_parameters: {
|
5124
|
+
# host: "Host", # required
|
5125
|
+
# port: 1, # required
|
5126
|
+
# database: "Database", # required
|
5127
|
+
# },
|
5128
|
+
# postgre_sql_parameters: {
|
5129
|
+
# host: "Host", # required
|
5130
|
+
# port: 1, # required
|
5131
|
+
# database: "Database", # required
|
5132
|
+
# },
|
5133
|
+
# presto_parameters: {
|
5134
|
+
# host: "Host", # required
|
5135
|
+
# port: 1, # required
|
5136
|
+
# catalog: "Catalog", # required
|
5137
|
+
# },
|
5138
|
+
# rds_parameters: {
|
5139
|
+
# instance_id: "InstanceId", # required
|
5140
|
+
# database: "Database", # required
|
5141
|
+
# },
|
5142
|
+
# redshift_parameters: {
|
5143
|
+
# host: "Host",
|
5144
|
+
# port: 1,
|
5145
|
+
# database: "Database", # required
|
5146
|
+
# cluster_id: "ClusterId",
|
5147
|
+
# },
|
5148
|
+
# s3_parameters: {
|
5149
|
+
# manifest_file_location: { # required
|
5150
|
+
# bucket: "S3Bucket", # required
|
5151
|
+
# key: "S3Key", # required
|
5152
|
+
# },
|
5153
|
+
# },
|
5154
|
+
# service_now_parameters: {
|
5155
|
+
# site_base_url: "SiteBaseUrl", # required
|
5156
|
+
# },
|
5157
|
+
# snowflake_parameters: {
|
5158
|
+
# host: "Host", # required
|
5159
|
+
# database: "Database", # required
|
5160
|
+
# warehouse: "Warehouse", # required
|
5161
|
+
# },
|
5162
|
+
# spark_parameters: {
|
5163
|
+
# host: "Host", # required
|
5164
|
+
# port: 1, # required
|
5165
|
+
# },
|
5166
|
+
# sql_server_parameters: {
|
5167
|
+
# host: "Host", # required
|
5168
|
+
# port: 1, # required
|
5169
|
+
# database: "Database", # required
|
5170
|
+
# },
|
5171
|
+
# teradata_parameters: {
|
5172
|
+
# host: "Host", # required
|
5173
|
+
# port: 1, # required
|
5174
|
+
# database: "Database", # required
|
5175
|
+
# },
|
5176
|
+
# twitter_parameters: {
|
5177
|
+
# query: "Query", # required
|
5178
|
+
# max_rows: 1, # required
|
5179
|
+
# },
|
5180
|
+
# },
|
5181
|
+
# ],
|
4252
5182
|
# },
|
5183
|
+
# copy_source_arn: "CopySourceArn",
|
4253
5184
|
# },
|
4254
5185
|
# vpc_connection_properties: {
|
4255
5186
|
# vpc_connection_arn: "Arn", # required
|
@@ -4473,9 +5404,19 @@ module Aws::QuickSight
|
|
4473
5404
|
# The ID for the template.
|
4474
5405
|
#
|
4475
5406
|
# @option params [required, Types::TemplateSourceEntity] :source_entity
|
4476
|
-
# The
|
4477
|
-
#
|
4478
|
-
#
|
5407
|
+
# The entity that you are using as a source when you update the
|
5408
|
+
# template. In `SourceEntity`, you specify the type of object you're
|
5409
|
+
# using as source: `SourceTemplate` for a template or `SourceAnalysis`
|
5410
|
+
# for an analysis. Both of these require an Amazon Resource Name (ARN).
|
5411
|
+
# For `SourceTemplate`, specify the ARN of the source template. For
|
5412
|
+
# `SourceAnalysis`, specify the ARN of the source analysis. The
|
5413
|
+
# `SourceTemplate` ARN can contain any AWS Account and any
|
5414
|
+
# QuickSight-supported AWS Region.
|
5415
|
+
#
|
5416
|
+
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
5417
|
+
# `SourceAnalysis` to list the replacement datasets for the placeholders
|
5418
|
+
# listed in the original. The schema in each dataset must match its
|
5419
|
+
# placeholder.
|
4479
5420
|
#
|
4480
5421
|
# @option params [String] :version_description
|
4481
5422
|
# A description of the current template version that is being updated.
|
@@ -4648,6 +5589,259 @@ module Aws::QuickSight
|
|
4648
5589
|
req.send_request(options)
|
4649
5590
|
end
|
4650
5591
|
|
5592
|
+
# Updates a theme.
|
5593
|
+
#
|
5594
|
+
# @option params [required, String] :aws_account_id
|
5595
|
+
# The ID of the AWS account that contains the theme that you're
|
5596
|
+
# updating.
|
5597
|
+
#
|
5598
|
+
# @option params [required, String] :theme_id
|
5599
|
+
# The ID for the theme.
|
5600
|
+
#
|
5601
|
+
# @option params [String] :name
|
5602
|
+
# The name for the theme.
|
5603
|
+
#
|
5604
|
+
# @option params [required, String] :base_theme_id
|
5605
|
+
# The theme ID, defined by Amazon QuickSight, that a custom theme
|
5606
|
+
# inherits from. All themes initially inherit from a default QuickSight
|
5607
|
+
# theme.
|
5608
|
+
#
|
5609
|
+
# @option params [String] :version_description
|
5610
|
+
# A description of the theme version that you're updating Every time
|
5611
|
+
# that you call `UpdateTheme`, you create a new version of the theme.
|
5612
|
+
# Each version of the theme maintains a description of the version in
|
5613
|
+
# `VersionDescription`.
|
5614
|
+
#
|
5615
|
+
# @option params [Types::ThemeConfiguration] :configuration
|
5616
|
+
# The theme configuration, which contains the theme display properties.
|
5617
|
+
#
|
5618
|
+
# @return [Types::UpdateThemeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5619
|
+
#
|
5620
|
+
# * {Types::UpdateThemeResponse#theme_id #theme_id} => String
|
5621
|
+
# * {Types::UpdateThemeResponse#arn #arn} => String
|
5622
|
+
# * {Types::UpdateThemeResponse#version_arn #version_arn} => String
|
5623
|
+
# * {Types::UpdateThemeResponse#creation_status #creation_status} => String
|
5624
|
+
# * {Types::UpdateThemeResponse#status #status} => Integer
|
5625
|
+
# * {Types::UpdateThemeResponse#request_id #request_id} => String
|
5626
|
+
#
|
5627
|
+
# @example Request syntax with placeholder values
|
5628
|
+
#
|
5629
|
+
# resp = client.update_theme({
|
5630
|
+
# aws_account_id: "AwsAccountId", # required
|
5631
|
+
# theme_id: "RestrictiveResourceId", # required
|
5632
|
+
# name: "ThemeName",
|
5633
|
+
# base_theme_id: "RestrictiveResourceId", # required
|
5634
|
+
# version_description: "VersionDescription",
|
5635
|
+
# configuration: {
|
5636
|
+
# data_color_palette: {
|
5637
|
+
# colors: ["HexColor"],
|
5638
|
+
# min_max_gradient: ["HexColor"],
|
5639
|
+
# empty_fill_color: "HexColor",
|
5640
|
+
# },
|
5641
|
+
# ui_color_palette: {
|
5642
|
+
# primary_foreground: "HexColor",
|
5643
|
+
# primary_background: "HexColor",
|
5644
|
+
# secondary_foreground: "HexColor",
|
5645
|
+
# secondary_background: "HexColor",
|
5646
|
+
# accent: "HexColor",
|
5647
|
+
# accent_foreground: "HexColor",
|
5648
|
+
# danger: "HexColor",
|
5649
|
+
# danger_foreground: "HexColor",
|
5650
|
+
# warning: "HexColor",
|
5651
|
+
# warning_foreground: "HexColor",
|
5652
|
+
# success: "HexColor",
|
5653
|
+
# success_foreground: "HexColor",
|
5654
|
+
# dimension: "HexColor",
|
5655
|
+
# dimension_foreground: "HexColor",
|
5656
|
+
# measure: "HexColor",
|
5657
|
+
# measure_foreground: "HexColor",
|
5658
|
+
# },
|
5659
|
+
# sheet: {
|
5660
|
+
# tile: {
|
5661
|
+
# border: {
|
5662
|
+
# show: false,
|
5663
|
+
# },
|
5664
|
+
# },
|
5665
|
+
# tile_layout: {
|
5666
|
+
# gutter: {
|
5667
|
+
# show: false,
|
5668
|
+
# },
|
5669
|
+
# margin: {
|
5670
|
+
# show: false,
|
5671
|
+
# },
|
5672
|
+
# },
|
5673
|
+
# },
|
5674
|
+
# },
|
5675
|
+
# })
|
5676
|
+
#
|
5677
|
+
# @example Response structure
|
5678
|
+
#
|
5679
|
+
# resp.theme_id #=> String
|
5680
|
+
# resp.arn #=> String
|
5681
|
+
# resp.version_arn #=> String
|
5682
|
+
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
5683
|
+
# resp.status #=> Integer
|
5684
|
+
# resp.request_id #=> String
|
5685
|
+
#
|
5686
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateTheme AWS API Documentation
|
5687
|
+
#
|
5688
|
+
# @overload update_theme(params = {})
|
5689
|
+
# @param [Hash] params ({})
|
5690
|
+
def update_theme(params = {}, options = {})
|
5691
|
+
req = build_request(:update_theme, params)
|
5692
|
+
req.send_request(options)
|
5693
|
+
end
|
5694
|
+
|
5695
|
+
# Updates an alias of a theme.
|
5696
|
+
#
|
5697
|
+
# @option params [required, String] :aws_account_id
|
5698
|
+
# The ID of the AWS account that contains the theme alias that you're
|
5699
|
+
# updating.
|
5700
|
+
#
|
5701
|
+
# @option params [required, String] :theme_id
|
5702
|
+
# The ID for the theme.
|
5703
|
+
#
|
5704
|
+
# @option params [required, String] :alias_name
|
5705
|
+
# The name of the theme alias that you want to update.
|
5706
|
+
#
|
5707
|
+
# @option params [required, Integer] :theme_version_number
|
5708
|
+
# The version number of the theme that the alias should reference.
|
5709
|
+
#
|
5710
|
+
# @return [Types::UpdateThemeAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5711
|
+
#
|
5712
|
+
# * {Types::UpdateThemeAliasResponse#theme_alias #theme_alias} => Types::ThemeAlias
|
5713
|
+
# * {Types::UpdateThemeAliasResponse#status #status} => Integer
|
5714
|
+
# * {Types::UpdateThemeAliasResponse#request_id #request_id} => String
|
5715
|
+
#
|
5716
|
+
# @example Request syntax with placeholder values
|
5717
|
+
#
|
5718
|
+
# resp = client.update_theme_alias({
|
5719
|
+
# aws_account_id: "AwsAccountId", # required
|
5720
|
+
# theme_id: "RestrictiveResourceId", # required
|
5721
|
+
# alias_name: "AliasName", # required
|
5722
|
+
# theme_version_number: 1, # required
|
5723
|
+
# })
|
5724
|
+
#
|
5725
|
+
# @example Response structure
|
5726
|
+
#
|
5727
|
+
# resp.theme_alias.arn #=> String
|
5728
|
+
# resp.theme_alias.alias_name #=> String
|
5729
|
+
# resp.theme_alias.theme_version_number #=> Integer
|
5730
|
+
# resp.status #=> Integer
|
5731
|
+
# resp.request_id #=> String
|
5732
|
+
#
|
5733
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateThemeAlias AWS API Documentation
|
5734
|
+
#
|
5735
|
+
# @overload update_theme_alias(params = {})
|
5736
|
+
# @param [Hash] params ({})
|
5737
|
+
def update_theme_alias(params = {}, options = {})
|
5738
|
+
req = build_request(:update_theme_alias, params)
|
5739
|
+
req.send_request(options)
|
5740
|
+
end
|
5741
|
+
|
5742
|
+
# Updates the resource permissions for a theme. Permissions apply to the
|
5743
|
+
# action to grant or revoke permissions on, for example
|
5744
|
+
# `"quicksight:DescribeTheme"`.
|
5745
|
+
#
|
5746
|
+
# Theme permissions apply in groupings. Valid groupings include the
|
5747
|
+
# following for the three levels of permissions, which are user, owner,
|
5748
|
+
# or no permissions:
|
5749
|
+
#
|
5750
|
+
# * User
|
5751
|
+
#
|
5752
|
+
# * `"quicksight:DescribeTheme"`
|
5753
|
+
#
|
5754
|
+
# * `"quicksight:DescribeThemeAlias"`
|
5755
|
+
#
|
5756
|
+
# * `"quicksight:ListThemeAliases"`
|
5757
|
+
#
|
5758
|
+
# * `"quicksight:ListThemeVersions"`
|
5759
|
+
#
|
5760
|
+
# * Owner
|
5761
|
+
#
|
5762
|
+
# * `"quicksight:DescribeTheme"`
|
5763
|
+
#
|
5764
|
+
# * `"quicksight:DescribeThemeAlias"`
|
5765
|
+
#
|
5766
|
+
# * `"quicksight:ListThemeAliases"`
|
5767
|
+
#
|
5768
|
+
# * `"quicksight:ListThemeVersions"`
|
5769
|
+
#
|
5770
|
+
# * `"quicksight:DeleteTheme"`
|
5771
|
+
#
|
5772
|
+
# * `"quicksight:UpdateTheme"`
|
5773
|
+
#
|
5774
|
+
# * `"quicksight:CreateThemeAlias"`
|
5775
|
+
#
|
5776
|
+
# * `"quicksight:DeleteThemeAlias"`
|
5777
|
+
#
|
5778
|
+
# * `"quicksight:UpdateThemeAlias"`
|
5779
|
+
#
|
5780
|
+
# * `"quicksight:UpdateThemePermissions"`
|
5781
|
+
#
|
5782
|
+
# * `"quicksight:DescribeThemePermissions"`
|
5783
|
+
#
|
5784
|
+
# * To specify no permissions, omit the permissions list.
|
5785
|
+
#
|
5786
|
+
# @option params [required, String] :aws_account_id
|
5787
|
+
# The ID of the AWS account that contains the theme.
|
5788
|
+
#
|
5789
|
+
# @option params [required, String] :theme_id
|
5790
|
+
# The ID for the theme.
|
5791
|
+
#
|
5792
|
+
# @option params [Array<Types::ResourcePermission>] :grant_permissions
|
5793
|
+
# A list of resource permissions to be granted for the theme.
|
5794
|
+
#
|
5795
|
+
# @option params [Array<Types::ResourcePermission>] :revoke_permissions
|
5796
|
+
# A list of resource permissions to be revoked from the theme.
|
5797
|
+
#
|
5798
|
+
# @return [Types::UpdateThemePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5799
|
+
#
|
5800
|
+
# * {Types::UpdateThemePermissionsResponse#theme_id #theme_id} => String
|
5801
|
+
# * {Types::UpdateThemePermissionsResponse#theme_arn #theme_arn} => String
|
5802
|
+
# * {Types::UpdateThemePermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission>
|
5803
|
+
# * {Types::UpdateThemePermissionsResponse#request_id #request_id} => String
|
5804
|
+
# * {Types::UpdateThemePermissionsResponse#status #status} => Integer
|
5805
|
+
#
|
5806
|
+
# @example Request syntax with placeholder values
|
5807
|
+
#
|
5808
|
+
# resp = client.update_theme_permissions({
|
5809
|
+
# aws_account_id: "AwsAccountId", # required
|
5810
|
+
# theme_id: "RestrictiveResourceId", # required
|
5811
|
+
# grant_permissions: [
|
5812
|
+
# {
|
5813
|
+
# principal: "Principal", # required
|
5814
|
+
# actions: ["String"], # required
|
5815
|
+
# },
|
5816
|
+
# ],
|
5817
|
+
# revoke_permissions: [
|
5818
|
+
# {
|
5819
|
+
# principal: "Principal", # required
|
5820
|
+
# actions: ["String"], # required
|
5821
|
+
# },
|
5822
|
+
# ],
|
5823
|
+
# })
|
5824
|
+
#
|
5825
|
+
# @example Response structure
|
5826
|
+
#
|
5827
|
+
# resp.theme_id #=> String
|
5828
|
+
# resp.theme_arn #=> String
|
5829
|
+
# resp.permissions #=> Array
|
5830
|
+
# resp.permissions[0].principal #=> String
|
5831
|
+
# resp.permissions[0].actions #=> Array
|
5832
|
+
# resp.permissions[0].actions[0] #=> String
|
5833
|
+
# resp.request_id #=> String
|
5834
|
+
# resp.status #=> Integer
|
5835
|
+
#
|
5836
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateThemePermissions AWS API Documentation
|
5837
|
+
#
|
5838
|
+
# @overload update_theme_permissions(params = {})
|
5839
|
+
# @param [Hash] params ({})
|
5840
|
+
def update_theme_permissions(params = {}, options = {})
|
5841
|
+
req = build_request(:update_theme_permissions, params)
|
5842
|
+
req.send_request(options)
|
5843
|
+
end
|
5844
|
+
|
4651
5845
|
# Updates an Amazon QuickSight user.
|
4652
5846
|
#
|
4653
5847
|
# @option params [required, String] :user_name
|
@@ -4725,7 +5919,7 @@ module Aws::QuickSight
|
|
4725
5919
|
params: params,
|
4726
5920
|
config: config)
|
4727
5921
|
context[:gem_name] = 'aws-sdk-quicksight'
|
4728
|
-
context[:gem_version] = '1.
|
5922
|
+
context[:gem_version] = '1.25.0'
|
4729
5923
|
Seahorse::Client::Request.new(handlers, context)
|
4730
5924
|
end
|
4731
5925
|
|