aws-sdk-quicksight 1.21.0 → 1.26.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 +1899 -132
- data/lib/aws-sdk-quicksight/client_api.rb +876 -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 +3345 -185
- 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: 8d80520b575a81b846237750af2db53859dc3efebfcbeb2afe45feab6ca3fe24
|
4
|
+
data.tar.gz: 8983ea37cef08fbfd984c22fb9609a7864efd741f3c8631691d2d79fcd798e7b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bf2786ff837b06a794e9184432a0849cd2b1c9158af22f566d05f4d519007b460e90e2db86853b6c0ecad67f170aba44cbfc04ab85c39491630e5e99ca783cf0
|
7
|
+
data.tar.gz: afd4503c43cdb35401ea4e996d8ca8240f5c0dd69eb03891996686fffea308ecd17fd6284dcf99c3145d1ac4f52e7251c411642f0ff3b36f078f0722e7f2c924
|
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.26.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
|
@@ -350,6 +354,58 @@ module Aws::QuickSight
|
|
350
354
|
req.send_request(options)
|
351
355
|
end
|
352
356
|
|
357
|
+
# Creates a customization for the Amazon QuickSight subscription
|
358
|
+
# associated with your AWS account.
|
359
|
+
#
|
360
|
+
# @option params [required, String] :aws_account_id
|
361
|
+
# The ID for the AWS account that you want to customize QuickSight for.
|
362
|
+
#
|
363
|
+
# @option params [String] :namespace
|
364
|
+
# The namespace associated with the customization that you're creating.
|
365
|
+
#
|
366
|
+
# @option params [required, Types::AccountCustomization] :account_customization
|
367
|
+
# The customizations you're adding to the QuickSight subscription for
|
368
|
+
# the AWS account. For example, you could add a default theme by setting
|
369
|
+
# `AccountCustomization` to the midnight theme
|
370
|
+
# (`DefaultTheme="arn:aws:quicksight::aws:theme/MIDNIGHT"`) or to a
|
371
|
+
# custom theme
|
372
|
+
# (`DefaultTheme="arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639"`).
|
373
|
+
#
|
374
|
+
# @return [Types::CreateAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
375
|
+
#
|
376
|
+
# * {Types::CreateAccountCustomizationResponse#aws_account_id #aws_account_id} => String
|
377
|
+
# * {Types::CreateAccountCustomizationResponse#namespace #namespace} => String
|
378
|
+
# * {Types::CreateAccountCustomizationResponse#account_customization #account_customization} => Types::AccountCustomization
|
379
|
+
# * {Types::CreateAccountCustomizationResponse#request_id #request_id} => String
|
380
|
+
# * {Types::CreateAccountCustomizationResponse#status #status} => Integer
|
381
|
+
#
|
382
|
+
# @example Request syntax with placeholder values
|
383
|
+
#
|
384
|
+
# resp = client.create_account_customization({
|
385
|
+
# aws_account_id: "AwsAccountId", # required
|
386
|
+
# namespace: "Namespace",
|
387
|
+
# account_customization: { # required
|
388
|
+
# default_theme: "Arn",
|
389
|
+
# },
|
390
|
+
# })
|
391
|
+
#
|
392
|
+
# @example Response structure
|
393
|
+
#
|
394
|
+
# resp.aws_account_id #=> String
|
395
|
+
# resp.namespace #=> String
|
396
|
+
# resp.account_customization.default_theme #=> String
|
397
|
+
# resp.request_id #=> String
|
398
|
+
# resp.status #=> Integer
|
399
|
+
#
|
400
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAccountCustomization AWS API Documentation
|
401
|
+
#
|
402
|
+
# @overload create_account_customization(params = {})
|
403
|
+
# @param [Hash] params ({})
|
404
|
+
def create_account_customization(params = {}, options = {})
|
405
|
+
req = build_request(:create_account_customization, params)
|
406
|
+
req.send_request(options)
|
407
|
+
end
|
408
|
+
|
353
409
|
# Creates a dashboard from a template. To first create a template, see
|
354
410
|
# the CreateTemplate API operation.
|
355
411
|
#
|
@@ -371,11 +427,9 @@ module Aws::QuickSight
|
|
371
427
|
# The display name of the dashboard.
|
372
428
|
#
|
373
429
|
# @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.
|
430
|
+
# The parameters for the creation of the dashboard, which you want to
|
431
|
+
# use to override the default settings. A dashboard can have any type of
|
432
|
+
# parameters, and some parameters might accept multiple values.
|
379
433
|
#
|
380
434
|
# @option params [Array<Types::ResourcePermission>] :permissions
|
381
435
|
# A structure that contains the permissions of the dashboard. You can
|
@@ -383,15 +437,19 @@ module Aws::QuickSight
|
|
383
437
|
# information.
|
384
438
|
#
|
385
439
|
# @option params [required, Types::DashboardSourceEntity] :source_entity
|
386
|
-
# The
|
387
|
-
#
|
388
|
-
#
|
389
|
-
#
|
390
|
-
#
|
391
|
-
#
|
392
|
-
#
|
393
|
-
#
|
394
|
-
# AWS
|
440
|
+
# The entity that you are using as a source when you create the
|
441
|
+
# dashboard. In `SourceEntity`, you specify the type of object you're
|
442
|
+
# using as source. You can only create a dashboard from a template, so
|
443
|
+
# you use a `SourceTemplate` entity. If you need to create a dashboard
|
444
|
+
# from an analysis, first convert the analysis to a template by using
|
445
|
+
# the CreateTemplate API operation. For `SourceTemplate`, specify the
|
446
|
+
# Amazon Resource Name (ARN) of the source template. The
|
447
|
+
# `SourceTemplate`ARN can contain any AWS Account and any
|
448
|
+
# QuickSight-supported AWS Region.
|
449
|
+
#
|
450
|
+
# Use the `DataSetReferences` entity within `SourceTemplate` to list the
|
451
|
+
# replacement datasets for the placeholders listed in the original. The
|
452
|
+
# schema in each dataset must match its placeholder.
|
395
453
|
#
|
396
454
|
# @option params [Array<Types::Tag>] :tags
|
397
455
|
# Contains a map of the key-value pairs for the resource tag or tags
|
@@ -415,9 +473,14 @@ module Aws::QuickSight
|
|
415
473
|
# option is `ENABLED` by default.
|
416
474
|
#
|
417
475
|
# * `VisibilityState` for `SheetControlsOption` - This visibility state
|
418
|
-
# can be either `COLLAPSED` or `EXPANDED`.
|
419
|
-
#
|
420
|
-
#
|
476
|
+
# can be either `COLLAPSED` or `EXPANDED`. This option is `COLLAPSED`
|
477
|
+
# by default.
|
478
|
+
#
|
479
|
+
# @option params [String] :theme_arn
|
480
|
+
# The Amazon Resource Name (ARN) of the theme that is being used for
|
481
|
+
# this dashboard. If you add a value for this field, it overrides the
|
482
|
+
# value that is used in the source entity. The theme ARN must exist in
|
483
|
+
# the same AWS account where you create the dashboard.
|
421
484
|
#
|
422
485
|
# @return [Types::CreateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
423
486
|
#
|
@@ -495,6 +558,7 @@ module Aws::QuickSight
|
|
495
558
|
# visibility_state: "EXPANDED", # accepts EXPANDED, COLLAPSED
|
496
559
|
# },
|
497
560
|
# },
|
561
|
+
# theme_arn: "Arn",
|
498
562
|
# })
|
499
563
|
#
|
500
564
|
# @example Response structure
|
@@ -677,6 +741,7 @@ module Aws::QuickSight
|
|
677
741
|
# },
|
678
742
|
# ],
|
679
743
|
# row_level_permission_data_set: {
|
744
|
+
# namespace: "Namespace",
|
680
745
|
# arn: "Arn", # required
|
681
746
|
# permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
|
682
747
|
# },
|
@@ -853,7 +918,96 @@ module Aws::QuickSight
|
|
853
918
|
# credential_pair: {
|
854
919
|
# username: "Username", # required
|
855
920
|
# password: "Password", # required
|
921
|
+
# alternate_data_source_parameters: [
|
922
|
+
# {
|
923
|
+
# amazon_elasticsearch_parameters: {
|
924
|
+
# domain: "Domain", # required
|
925
|
+
# },
|
926
|
+
# athena_parameters: {
|
927
|
+
# work_group: "WorkGroup",
|
928
|
+
# },
|
929
|
+
# aurora_parameters: {
|
930
|
+
# host: "Host", # required
|
931
|
+
# port: 1, # required
|
932
|
+
# database: "Database", # required
|
933
|
+
# },
|
934
|
+
# aurora_postgre_sql_parameters: {
|
935
|
+
# host: "Host", # required
|
936
|
+
# port: 1, # required
|
937
|
+
# database: "Database", # required
|
938
|
+
# },
|
939
|
+
# aws_iot_analytics_parameters: {
|
940
|
+
# data_set_name: "DataSetName", # required
|
941
|
+
# },
|
942
|
+
# jira_parameters: {
|
943
|
+
# site_base_url: "SiteBaseUrl", # required
|
944
|
+
# },
|
945
|
+
# maria_db_parameters: {
|
946
|
+
# host: "Host", # required
|
947
|
+
# port: 1, # required
|
948
|
+
# database: "Database", # required
|
949
|
+
# },
|
950
|
+
# my_sql_parameters: {
|
951
|
+
# host: "Host", # required
|
952
|
+
# port: 1, # required
|
953
|
+
# database: "Database", # required
|
954
|
+
# },
|
955
|
+
# postgre_sql_parameters: {
|
956
|
+
# host: "Host", # required
|
957
|
+
# port: 1, # required
|
958
|
+
# database: "Database", # required
|
959
|
+
# },
|
960
|
+
# presto_parameters: {
|
961
|
+
# host: "Host", # required
|
962
|
+
# port: 1, # required
|
963
|
+
# catalog: "Catalog", # required
|
964
|
+
# },
|
965
|
+
# rds_parameters: {
|
966
|
+
# instance_id: "InstanceId", # required
|
967
|
+
# database: "Database", # required
|
968
|
+
# },
|
969
|
+
# redshift_parameters: {
|
970
|
+
# host: "Host",
|
971
|
+
# port: 1,
|
972
|
+
# database: "Database", # required
|
973
|
+
# cluster_id: "ClusterId",
|
974
|
+
# },
|
975
|
+
# s3_parameters: {
|
976
|
+
# manifest_file_location: { # required
|
977
|
+
# bucket: "S3Bucket", # required
|
978
|
+
# key: "S3Key", # required
|
979
|
+
# },
|
980
|
+
# },
|
981
|
+
# service_now_parameters: {
|
982
|
+
# site_base_url: "SiteBaseUrl", # required
|
983
|
+
# },
|
984
|
+
# snowflake_parameters: {
|
985
|
+
# host: "Host", # required
|
986
|
+
# database: "Database", # required
|
987
|
+
# warehouse: "Warehouse", # required
|
988
|
+
# },
|
989
|
+
# spark_parameters: {
|
990
|
+
# host: "Host", # required
|
991
|
+
# port: 1, # required
|
992
|
+
# },
|
993
|
+
# sql_server_parameters: {
|
994
|
+
# host: "Host", # required
|
995
|
+
# port: 1, # required
|
996
|
+
# database: "Database", # required
|
997
|
+
# },
|
998
|
+
# teradata_parameters: {
|
999
|
+
# host: "Host", # required
|
1000
|
+
# port: 1, # required
|
1001
|
+
# database: "Database", # required
|
1002
|
+
# },
|
1003
|
+
# twitter_parameters: {
|
1004
|
+
# query: "Query", # required
|
1005
|
+
# max_rows: 1, # required
|
1006
|
+
# },
|
1007
|
+
# },
|
1008
|
+
# ],
|
856
1009
|
# },
|
1010
|
+
# copy_source_arn: "CopySourceArn",
|
857
1011
|
# },
|
858
1012
|
# permissions: [
|
859
1013
|
# {
|
@@ -1127,6 +1281,76 @@ module Aws::QuickSight
|
|
1127
1281
|
req.send_request(options)
|
1128
1282
|
end
|
1129
1283
|
|
1284
|
+
# (Enterprise edition only) Creates a new namespace for you to use with
|
1285
|
+
# Amazon QuickSight.
|
1286
|
+
#
|
1287
|
+
# A namespace allows you to isolate the QuickSight users and groups that
|
1288
|
+
# are registered for that namespace. Users that access the namespace can
|
1289
|
+
# share assets only with other users or groups in the same namespace.
|
1290
|
+
# They can't see users and groups in other namespaces. You can create a
|
1291
|
+
# namespace after your AWS account is subscribed to QuickSight. The
|
1292
|
+
# namespace must be unique within the AWS account. By default, there is
|
1293
|
+
# a limit of 100 namespaces per AWS account. To increase your limit,
|
1294
|
+
# create a ticket with AWS Support.
|
1295
|
+
#
|
1296
|
+
# @option params [required, String] :aws_account_id
|
1297
|
+
# The ID for the AWS account that you want to create the QuickSight
|
1298
|
+
# namespace in.
|
1299
|
+
#
|
1300
|
+
# @option params [required, String] :namespace
|
1301
|
+
# The name that you want to use to describe the new namespace.
|
1302
|
+
#
|
1303
|
+
# @option params [required, String] :identity_store
|
1304
|
+
# Specifies the type of your user identity directory. Currently, this
|
1305
|
+
# supports users with an identity type of `QUICKSIGHT`.
|
1306
|
+
#
|
1307
|
+
# @option params [Array<Types::Tag>] :tags
|
1308
|
+
# The tags that you want to associate with the namespace that you're
|
1309
|
+
# creating.
|
1310
|
+
#
|
1311
|
+
# @return [Types::CreateNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1312
|
+
#
|
1313
|
+
# * {Types::CreateNamespaceResponse#arn #arn} => String
|
1314
|
+
# * {Types::CreateNamespaceResponse#name #name} => String
|
1315
|
+
# * {Types::CreateNamespaceResponse#capacity_region #capacity_region} => String
|
1316
|
+
# * {Types::CreateNamespaceResponse#creation_status #creation_status} => String
|
1317
|
+
# * {Types::CreateNamespaceResponse#identity_store #identity_store} => String
|
1318
|
+
# * {Types::CreateNamespaceResponse#request_id #request_id} => String
|
1319
|
+
# * {Types::CreateNamespaceResponse#status #status} => Integer
|
1320
|
+
#
|
1321
|
+
# @example Request syntax with placeholder values
|
1322
|
+
#
|
1323
|
+
# resp = client.create_namespace({
|
1324
|
+
# aws_account_id: "AwsAccountId", # required
|
1325
|
+
# namespace: "Namespace", # required
|
1326
|
+
# identity_store: "QUICKSIGHT", # required, accepts QUICKSIGHT
|
1327
|
+
# tags: [
|
1328
|
+
# {
|
1329
|
+
# key: "TagKey", # required
|
1330
|
+
# value: "TagValue", # required
|
1331
|
+
# },
|
1332
|
+
# ],
|
1333
|
+
# })
|
1334
|
+
#
|
1335
|
+
# @example Response structure
|
1336
|
+
#
|
1337
|
+
# resp.arn #=> String
|
1338
|
+
# resp.name #=> String
|
1339
|
+
# resp.capacity_region #=> String
|
1340
|
+
# resp.creation_status #=> String, one of "CREATED", "CREATING", "DELETING", "RETRYABLE_FAILURE", "NON_RETRYABLE_FAILURE"
|
1341
|
+
# resp.identity_store #=> String, one of "QUICKSIGHT"
|
1342
|
+
# resp.request_id #=> String
|
1343
|
+
# resp.status #=> Integer
|
1344
|
+
#
|
1345
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateNamespace AWS API Documentation
|
1346
|
+
#
|
1347
|
+
# @overload create_namespace(params = {})
|
1348
|
+
# @param [Hash] params ({})
|
1349
|
+
def create_namespace(params = {}, options = {})
|
1350
|
+
req = build_request(:create_namespace, params)
|
1351
|
+
req.send_request(options)
|
1352
|
+
end
|
1353
|
+
|
1130
1354
|
# Creates a template from an existing QuickSight analysis or template.
|
1131
1355
|
# You can use the resulting template to create a dashboard.
|
1132
1356
|
#
|
@@ -1154,10 +1378,19 @@ module Aws::QuickSight
|
|
1154
1378
|
# A list of resource permissions to be set on the template.
|
1155
1379
|
#
|
1156
1380
|
# @option params [required, Types::TemplateSourceEntity] :source_entity
|
1157
|
-
# The
|
1158
|
-
# template
|
1159
|
-
#
|
1160
|
-
#
|
1381
|
+
# The entity that you are using as a source when you create the
|
1382
|
+
# template. In `SourceEntity`, you specify the type of object you're
|
1383
|
+
# using as source: `SourceTemplate` for a template or `SourceAnalysis`
|
1384
|
+
# for an analysis. Both of these require an Amazon Resource Name (ARN).
|
1385
|
+
# For `SourceTemplate`, specify the ARN of the source template. For
|
1386
|
+
# `SourceAnalysis`, specify the ARN of the source analysis. The
|
1387
|
+
# `SourceTemplate` ARN can contain any AWS Account and any
|
1388
|
+
# QuickSight-supported AWS Region.
|
1389
|
+
#
|
1390
|
+
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
1391
|
+
# `SourceAnalysis` to list the replacement datasets for the placeholders
|
1392
|
+
# listed in the original. The schema in each dataset must match its
|
1393
|
+
# placeholder.
|
1161
1394
|
#
|
1162
1395
|
# @option params [Array<Types::Tag>] :tags
|
1163
1396
|
# Contains a map of the key-value pairs for the resource tag or tags
|
@@ -1281,6 +1514,222 @@ module Aws::QuickSight
|
|
1281
1514
|
req.send_request(options)
|
1282
1515
|
end
|
1283
1516
|
|
1517
|
+
# Creates a theme.
|
1518
|
+
#
|
1519
|
+
# A *theme* is set of configuration options for color and layout. Themes
|
1520
|
+
# apply to analyses and dashboards. For more information, see [Using
|
1521
|
+
# Themes in Amazon QuickSight][1] in the *Amazon QuickSight User Guide*.
|
1522
|
+
#
|
1523
|
+
#
|
1524
|
+
#
|
1525
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html
|
1526
|
+
#
|
1527
|
+
# @option params [required, String] :aws_account_id
|
1528
|
+
# The ID of the AWS account where you want to store the new theme.
|
1529
|
+
#
|
1530
|
+
# @option params [required, String] :theme_id
|
1531
|
+
# An ID for the theme that you want to create. The theme ID is unique
|
1532
|
+
# per AWS Region in each AWS account.
|
1533
|
+
#
|
1534
|
+
# @option params [required, String] :name
|
1535
|
+
# A display name for the theme.
|
1536
|
+
#
|
1537
|
+
# @option params [required, String] :base_theme_id
|
1538
|
+
# The ID of the theme that a custom theme will inherit from. All themes
|
1539
|
+
# inherit from one of the starting themes defined by Amazon QuickSight.
|
1540
|
+
# For a list of the starting themes, use `ListThemes` or choose
|
1541
|
+
# **Themes** from within a QuickSight analysis.
|
1542
|
+
#
|
1543
|
+
# @option params [String] :version_description
|
1544
|
+
# A description of the first version of the theme that you're creating.
|
1545
|
+
# Every time `UpdateTheme` is called, a new version is created. Each
|
1546
|
+
# version of the theme has a description of the version in the
|
1547
|
+
# `VersionDescription` field.
|
1548
|
+
#
|
1549
|
+
# @option params [required, Types::ThemeConfiguration] :configuration
|
1550
|
+
# The theme configuration, which contains the theme display properties.
|
1551
|
+
#
|
1552
|
+
# @option params [Array<Types::ResourcePermission>] :permissions
|
1553
|
+
# A valid grouping of resource permissions to apply to the new theme.
|
1554
|
+
#
|
1555
|
+
# @option params [Array<Types::Tag>] :tags
|
1556
|
+
# A map of the key-value pairs for the resource tag or tags that you
|
1557
|
+
# want to add to the resource.
|
1558
|
+
#
|
1559
|
+
# @return [Types::CreateThemeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1560
|
+
#
|
1561
|
+
# * {Types::CreateThemeResponse#arn #arn} => String
|
1562
|
+
# * {Types::CreateThemeResponse#version_arn #version_arn} => String
|
1563
|
+
# * {Types::CreateThemeResponse#theme_id #theme_id} => String
|
1564
|
+
# * {Types::CreateThemeResponse#creation_status #creation_status} => String
|
1565
|
+
# * {Types::CreateThemeResponse#status #status} => Integer
|
1566
|
+
# * {Types::CreateThemeResponse#request_id #request_id} => String
|
1567
|
+
#
|
1568
|
+
# @example Request syntax with placeholder values
|
1569
|
+
#
|
1570
|
+
# resp = client.create_theme({
|
1571
|
+
# aws_account_id: "AwsAccountId", # required
|
1572
|
+
# theme_id: "RestrictiveResourceId", # required
|
1573
|
+
# name: "ThemeName", # required
|
1574
|
+
# base_theme_id: "RestrictiveResourceId", # required
|
1575
|
+
# version_description: "VersionDescription",
|
1576
|
+
# configuration: { # required
|
1577
|
+
# data_color_palette: {
|
1578
|
+
# colors: ["HexColor"],
|
1579
|
+
# min_max_gradient: ["HexColor"],
|
1580
|
+
# empty_fill_color: "HexColor",
|
1581
|
+
# },
|
1582
|
+
# ui_color_palette: {
|
1583
|
+
# primary_foreground: "HexColor",
|
1584
|
+
# primary_background: "HexColor",
|
1585
|
+
# secondary_foreground: "HexColor",
|
1586
|
+
# secondary_background: "HexColor",
|
1587
|
+
# accent: "HexColor",
|
1588
|
+
# accent_foreground: "HexColor",
|
1589
|
+
# danger: "HexColor",
|
1590
|
+
# danger_foreground: "HexColor",
|
1591
|
+
# warning: "HexColor",
|
1592
|
+
# warning_foreground: "HexColor",
|
1593
|
+
# success: "HexColor",
|
1594
|
+
# success_foreground: "HexColor",
|
1595
|
+
# dimension: "HexColor",
|
1596
|
+
# dimension_foreground: "HexColor",
|
1597
|
+
# measure: "HexColor",
|
1598
|
+
# measure_foreground: "HexColor",
|
1599
|
+
# },
|
1600
|
+
# sheet: {
|
1601
|
+
# tile: {
|
1602
|
+
# border: {
|
1603
|
+
# show: false,
|
1604
|
+
# },
|
1605
|
+
# },
|
1606
|
+
# tile_layout: {
|
1607
|
+
# gutter: {
|
1608
|
+
# show: false,
|
1609
|
+
# },
|
1610
|
+
# margin: {
|
1611
|
+
# show: false,
|
1612
|
+
# },
|
1613
|
+
# },
|
1614
|
+
# },
|
1615
|
+
# },
|
1616
|
+
# permissions: [
|
1617
|
+
# {
|
1618
|
+
# principal: "Principal", # required
|
1619
|
+
# actions: ["String"], # required
|
1620
|
+
# },
|
1621
|
+
# ],
|
1622
|
+
# tags: [
|
1623
|
+
# {
|
1624
|
+
# key: "TagKey", # required
|
1625
|
+
# value: "TagValue", # required
|
1626
|
+
# },
|
1627
|
+
# ],
|
1628
|
+
# })
|
1629
|
+
#
|
1630
|
+
# @example Response structure
|
1631
|
+
#
|
1632
|
+
# resp.arn #=> String
|
1633
|
+
# resp.version_arn #=> String
|
1634
|
+
# resp.theme_id #=> String
|
1635
|
+
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
1636
|
+
# resp.status #=> Integer
|
1637
|
+
# resp.request_id #=> String
|
1638
|
+
#
|
1639
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateTheme AWS API Documentation
|
1640
|
+
#
|
1641
|
+
# @overload create_theme(params = {})
|
1642
|
+
# @param [Hash] params ({})
|
1643
|
+
def create_theme(params = {}, options = {})
|
1644
|
+
req = build_request(:create_theme, params)
|
1645
|
+
req.send_request(options)
|
1646
|
+
end
|
1647
|
+
|
1648
|
+
# Creates a theme alias for a theme.
|
1649
|
+
#
|
1650
|
+
# @option params [required, String] :aws_account_id
|
1651
|
+
# The ID of the AWS account that contains the theme for the new theme
|
1652
|
+
# alias.
|
1653
|
+
#
|
1654
|
+
# @option params [required, String] :theme_id
|
1655
|
+
# An ID for the theme alias.
|
1656
|
+
#
|
1657
|
+
# @option params [required, String] :alias_name
|
1658
|
+
# The name that you want to give to the theme alias that you are
|
1659
|
+
# creating. The alias name can't begin with a `$`. Alias names that
|
1660
|
+
# start with `$` are reserved by Amazon QuickSight.
|
1661
|
+
#
|
1662
|
+
# @option params [required, Integer] :theme_version_number
|
1663
|
+
# The version number of the theme.
|
1664
|
+
#
|
1665
|
+
# @return [Types::CreateThemeAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1666
|
+
#
|
1667
|
+
# * {Types::CreateThemeAliasResponse#theme_alias #theme_alias} => Types::ThemeAlias
|
1668
|
+
# * {Types::CreateThemeAliasResponse#status #status} => Integer
|
1669
|
+
# * {Types::CreateThemeAliasResponse#request_id #request_id} => String
|
1670
|
+
#
|
1671
|
+
# @example Request syntax with placeholder values
|
1672
|
+
#
|
1673
|
+
# resp = client.create_theme_alias({
|
1674
|
+
# aws_account_id: "AwsAccountId", # required
|
1675
|
+
# theme_id: "RestrictiveResourceId", # required
|
1676
|
+
# alias_name: "AliasName", # required
|
1677
|
+
# theme_version_number: 1, # required
|
1678
|
+
# })
|
1679
|
+
#
|
1680
|
+
# @example Response structure
|
1681
|
+
#
|
1682
|
+
# resp.theme_alias.arn #=> String
|
1683
|
+
# resp.theme_alias.alias_name #=> String
|
1684
|
+
# resp.theme_alias.theme_version_number #=> Integer
|
1685
|
+
# resp.status #=> Integer
|
1686
|
+
# resp.request_id #=> String
|
1687
|
+
#
|
1688
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateThemeAlias AWS API Documentation
|
1689
|
+
#
|
1690
|
+
# @overload create_theme_alias(params = {})
|
1691
|
+
# @param [Hash] params ({})
|
1692
|
+
def create_theme_alias(params = {}, options = {})
|
1693
|
+
req = build_request(:create_theme_alias, params)
|
1694
|
+
req.send_request(options)
|
1695
|
+
end
|
1696
|
+
|
1697
|
+
# Deletes customizations for the QuickSight subscription on your AWS
|
1698
|
+
# account.
|
1699
|
+
#
|
1700
|
+
# @option params [required, String] :aws_account_id
|
1701
|
+
# The ID for the AWS account that you want to delete QuickSight
|
1702
|
+
# customizations from.
|
1703
|
+
#
|
1704
|
+
# @option params [String] :namespace
|
1705
|
+
# The namespace associated with the customization that you're deleting.
|
1706
|
+
#
|
1707
|
+
# @return [Types::DeleteAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1708
|
+
#
|
1709
|
+
# * {Types::DeleteAccountCustomizationResponse#request_id #request_id} => String
|
1710
|
+
# * {Types::DeleteAccountCustomizationResponse#status #status} => Integer
|
1711
|
+
#
|
1712
|
+
# @example Request syntax with placeholder values
|
1713
|
+
#
|
1714
|
+
# resp = client.delete_account_customization({
|
1715
|
+
# aws_account_id: "AwsAccountId", # required
|
1716
|
+
# namespace: "Namespace",
|
1717
|
+
# })
|
1718
|
+
#
|
1719
|
+
# @example Response structure
|
1720
|
+
#
|
1721
|
+
# resp.request_id #=> String
|
1722
|
+
# resp.status #=> Integer
|
1723
|
+
#
|
1724
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAccountCustomization AWS API Documentation
|
1725
|
+
#
|
1726
|
+
# @overload delete_account_customization(params = {})
|
1727
|
+
# @param [Hash] params ({})
|
1728
|
+
def delete_account_customization(params = {}, options = {})
|
1729
|
+
req = build_request(:delete_account_customization, params)
|
1730
|
+
req.send_request(options)
|
1731
|
+
end
|
1732
|
+
|
1284
1733
|
# Deletes a dashboard.
|
1285
1734
|
#
|
1286
1735
|
# @option params [required, String] :aws_account_id
|
@@ -1530,6 +1979,44 @@ module Aws::QuickSight
|
|
1530
1979
|
req.send_request(options)
|
1531
1980
|
end
|
1532
1981
|
|
1982
|
+
# Deletes a namespace and the users and groups that are associated with
|
1983
|
+
# the namespace. This is an asynchronous process. Assets including
|
1984
|
+
# dashboards, analyses, datasets and data sources are not deleted. To
|
1985
|
+
# delete these assets, you use the APIs for the relevant asset.
|
1986
|
+
#
|
1987
|
+
# @option params [required, String] :aws_account_id
|
1988
|
+
# The ID for the AWS account that you want to delete the QuickSight
|
1989
|
+
# namespace from.
|
1990
|
+
#
|
1991
|
+
# @option params [required, String] :namespace
|
1992
|
+
# The namespace that you want to delete.
|
1993
|
+
#
|
1994
|
+
# @return [Types::DeleteNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1995
|
+
#
|
1996
|
+
# * {Types::DeleteNamespaceResponse#request_id #request_id} => String
|
1997
|
+
# * {Types::DeleteNamespaceResponse#status #status} => Integer
|
1998
|
+
#
|
1999
|
+
# @example Request syntax with placeholder values
|
2000
|
+
#
|
2001
|
+
# resp = client.delete_namespace({
|
2002
|
+
# aws_account_id: "AwsAccountId", # required
|
2003
|
+
# namespace: "Namespace", # required
|
2004
|
+
# })
|
2005
|
+
#
|
2006
|
+
# @example Response structure
|
2007
|
+
#
|
2008
|
+
# resp.request_id #=> String
|
2009
|
+
# resp.status #=> Integer
|
2010
|
+
#
|
2011
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteNamespace AWS API Documentation
|
2012
|
+
#
|
2013
|
+
# @overload delete_namespace(params = {})
|
2014
|
+
# @param [Hash] params ({})
|
2015
|
+
def delete_namespace(params = {}, options = {})
|
2016
|
+
req = build_request(:delete_namespace, params)
|
2017
|
+
req.send_request(options)
|
2018
|
+
end
|
2019
|
+
|
1533
2020
|
# Deletes a template.
|
1534
2021
|
#
|
1535
2022
|
# @option params [required, String] :aws_account_id
|
@@ -1586,10 +2073,10 @@ module Aws::QuickSight
|
|
1586
2073
|
# The ID for the template that the specified alias is for.
|
1587
2074
|
#
|
1588
2075
|
# @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.
|
2076
|
+
# The name for the template alias. To delete a specific alias, you
|
2077
|
+
# delete the version that the alias points to. You can specify the alias
|
2078
|
+
# name, or specify the latest version of the template by providing the
|
2079
|
+
# keyword `$LATEST` in the `AliasName` parameter.
|
1593
2080
|
#
|
1594
2081
|
# @return [Types::DeleteTemplateAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1595
2082
|
#
|
@@ -1624,69 +2111,161 @@ module Aws::QuickSight
|
|
1624
2111
|
req.send_request(options)
|
1625
2112
|
end
|
1626
2113
|
|
1627
|
-
# Deletes
|
1628
|
-
# identity of the AWS Identity and Access Management (IAM) user or role
|
1629
|
-
# that's making the call. The IAM user isn't deleted as a result of
|
1630
|
-
# this call.
|
1631
|
-
#
|
1632
|
-
# @option params [required, String] :user_name
|
1633
|
-
# The name of the user that you want to delete.
|
2114
|
+
# Deletes a theme.
|
1634
2115
|
#
|
1635
2116
|
# @option params [required, String] :aws_account_id
|
1636
|
-
# The ID
|
1637
|
-
#
|
2117
|
+
# The ID of the AWS account that contains the theme that you're
|
2118
|
+
# deleting.
|
1638
2119
|
#
|
1639
|
-
# @option params [required, String] :
|
1640
|
-
#
|
2120
|
+
# @option params [required, String] :theme_id
|
2121
|
+
# An ID for the theme that you want to delete.
|
1641
2122
|
#
|
1642
|
-
# @
|
2123
|
+
# @option params [Integer] :version_number
|
2124
|
+
# The version of the theme that you want to delete.
|
1643
2125
|
#
|
1644
|
-
#
|
1645
|
-
#
|
2126
|
+
# **Note:** If you don't provide a version number, you're using this
|
2127
|
+
# call to `DeleteTheme` to delete all versions of the theme.
|
2128
|
+
#
|
2129
|
+
# @return [Types::DeleteThemeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2130
|
+
#
|
2131
|
+
# * {Types::DeleteThemeResponse#arn #arn} => String
|
2132
|
+
# * {Types::DeleteThemeResponse#request_id #request_id} => String
|
2133
|
+
# * {Types::DeleteThemeResponse#status #status} => Integer
|
2134
|
+
# * {Types::DeleteThemeResponse#theme_id #theme_id} => String
|
1646
2135
|
#
|
1647
2136
|
# @example Request syntax with placeholder values
|
1648
2137
|
#
|
1649
|
-
# resp = client.
|
1650
|
-
# user_name: "UserName", # required
|
2138
|
+
# resp = client.delete_theme({
|
1651
2139
|
# aws_account_id: "AwsAccountId", # required
|
1652
|
-
#
|
2140
|
+
# theme_id: "RestrictiveResourceId", # required
|
2141
|
+
# version_number: 1,
|
1653
2142
|
# })
|
1654
2143
|
#
|
1655
2144
|
# @example Response structure
|
1656
2145
|
#
|
2146
|
+
# resp.arn #=> String
|
1657
2147
|
# resp.request_id #=> String
|
1658
2148
|
# resp.status #=> Integer
|
2149
|
+
# resp.theme_id #=> String
|
1659
2150
|
#
|
1660
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
2151
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteTheme AWS API Documentation
|
1661
2152
|
#
|
1662
|
-
# @overload
|
2153
|
+
# @overload delete_theme(params = {})
|
1663
2154
|
# @param [Hash] params ({})
|
1664
|
-
def
|
1665
|
-
req = build_request(:
|
2155
|
+
def delete_theme(params = {}, options = {})
|
2156
|
+
req = build_request(:delete_theme, params)
|
1666
2157
|
req.send_request(options)
|
1667
2158
|
end
|
1668
2159
|
|
1669
|
-
# Deletes
|
1670
|
-
#
|
1671
|
-
#
|
1672
|
-
# The principal ID of the user.
|
2160
|
+
# Deletes the version of the theme that the specified theme alias points
|
2161
|
+
# to. If you provide a specific alias, you delete the version of the
|
2162
|
+
# theme that the alias points to.
|
1673
2163
|
#
|
1674
2164
|
# @option params [required, String] :aws_account_id
|
1675
|
-
# The ID
|
1676
|
-
# ID for the AWS account that contains your Amazon QuickSight account.
|
2165
|
+
# The ID of the AWS account that contains the theme alias to delete.
|
1677
2166
|
#
|
1678
|
-
# @option params [required, String] :
|
1679
|
-
# The
|
2167
|
+
# @option params [required, String] :theme_id
|
2168
|
+
# The ID for the theme that the specified alias is for.
|
1680
2169
|
#
|
1681
|
-
# @
|
2170
|
+
# @option params [required, String] :alias_name
|
2171
|
+
# The unique name for the theme alias to delete.
|
1682
2172
|
#
|
1683
|
-
#
|
1684
|
-
#
|
2173
|
+
# @return [Types::DeleteThemeAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2174
|
+
#
|
2175
|
+
# * {Types::DeleteThemeAliasResponse#alias_name #alias_name} => String
|
2176
|
+
# * {Types::DeleteThemeAliasResponse#arn #arn} => String
|
2177
|
+
# * {Types::DeleteThemeAliasResponse#request_id #request_id} => String
|
2178
|
+
# * {Types::DeleteThemeAliasResponse#status #status} => Integer
|
2179
|
+
# * {Types::DeleteThemeAliasResponse#theme_id #theme_id} => String
|
1685
2180
|
#
|
1686
2181
|
# @example Request syntax with placeholder values
|
1687
2182
|
#
|
1688
|
-
# resp = client.
|
1689
|
-
#
|
2183
|
+
# resp = client.delete_theme_alias({
|
2184
|
+
# aws_account_id: "AwsAccountId", # required
|
2185
|
+
# theme_id: "RestrictiveResourceId", # required
|
2186
|
+
# alias_name: "AliasName", # required
|
2187
|
+
# })
|
2188
|
+
#
|
2189
|
+
# @example Response structure
|
2190
|
+
#
|
2191
|
+
# resp.alias_name #=> String
|
2192
|
+
# resp.arn #=> String
|
2193
|
+
# resp.request_id #=> String
|
2194
|
+
# resp.status #=> Integer
|
2195
|
+
# resp.theme_id #=> String
|
2196
|
+
#
|
2197
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteThemeAlias AWS API Documentation
|
2198
|
+
#
|
2199
|
+
# @overload delete_theme_alias(params = {})
|
2200
|
+
# @param [Hash] params ({})
|
2201
|
+
def delete_theme_alias(params = {}, options = {})
|
2202
|
+
req = build_request(:delete_theme_alias, params)
|
2203
|
+
req.send_request(options)
|
2204
|
+
end
|
2205
|
+
|
2206
|
+
# Deletes the Amazon QuickSight user that is associated with the
|
2207
|
+
# identity of the AWS Identity and Access Management (IAM) user or role
|
2208
|
+
# that's making the call. The IAM user isn't deleted as a result of
|
2209
|
+
# this call.
|
2210
|
+
#
|
2211
|
+
# @option params [required, String] :user_name
|
2212
|
+
# The name of the user that you want to delete.
|
2213
|
+
#
|
2214
|
+
# @option params [required, String] :aws_account_id
|
2215
|
+
# The ID for the AWS account that the user is in. Currently, you use the
|
2216
|
+
# ID for the AWS account that contains your Amazon QuickSight account.
|
2217
|
+
#
|
2218
|
+
# @option params [required, String] :namespace
|
2219
|
+
# The namespace. Currently, you should set this to `default`.
|
2220
|
+
#
|
2221
|
+
# @return [Types::DeleteUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2222
|
+
#
|
2223
|
+
# * {Types::DeleteUserResponse#request_id #request_id} => String
|
2224
|
+
# * {Types::DeleteUserResponse#status #status} => Integer
|
2225
|
+
#
|
2226
|
+
# @example Request syntax with placeholder values
|
2227
|
+
#
|
2228
|
+
# resp = client.delete_user({
|
2229
|
+
# user_name: "UserName", # required
|
2230
|
+
# aws_account_id: "AwsAccountId", # required
|
2231
|
+
# namespace: "Namespace", # required
|
2232
|
+
# })
|
2233
|
+
#
|
2234
|
+
# @example Response structure
|
2235
|
+
#
|
2236
|
+
# resp.request_id #=> String
|
2237
|
+
# resp.status #=> Integer
|
2238
|
+
#
|
2239
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteUser AWS API Documentation
|
2240
|
+
#
|
2241
|
+
# @overload delete_user(params = {})
|
2242
|
+
# @param [Hash] params ({})
|
2243
|
+
def delete_user(params = {}, options = {})
|
2244
|
+
req = build_request(:delete_user, params)
|
2245
|
+
req.send_request(options)
|
2246
|
+
end
|
2247
|
+
|
2248
|
+
# Deletes a user identified by its principal ID.
|
2249
|
+
#
|
2250
|
+
# @option params [required, String] :principal_id
|
2251
|
+
# The principal ID of the user.
|
2252
|
+
#
|
2253
|
+
# @option params [required, String] :aws_account_id
|
2254
|
+
# The ID for the AWS account that the user is in. Currently, you use the
|
2255
|
+
# ID for the AWS account that contains your Amazon QuickSight account.
|
2256
|
+
#
|
2257
|
+
# @option params [required, String] :namespace
|
2258
|
+
# The namespace. Currently, you should set this to `default`.
|
2259
|
+
#
|
2260
|
+
# @return [Types::DeleteUserByPrincipalIdResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2261
|
+
#
|
2262
|
+
# * {Types::DeleteUserByPrincipalIdResponse#request_id #request_id} => String
|
2263
|
+
# * {Types::DeleteUserByPrincipalIdResponse#status #status} => Integer
|
2264
|
+
#
|
2265
|
+
# @example Request syntax with placeholder values
|
2266
|
+
#
|
2267
|
+
# resp = client.delete_user_by_principal_id({
|
2268
|
+
# principal_id: "String", # required
|
1690
2269
|
# aws_account_id: "AwsAccountId", # required
|
1691
2270
|
# namespace: "Namespace", # required
|
1692
2271
|
# })
|
@@ -1705,6 +2284,91 @@ module Aws::QuickSight
|
|
1705
2284
|
req.send_request(options)
|
1706
2285
|
end
|
1707
2286
|
|
2287
|
+
# Describes the customizations associated with your AWS account.
|
2288
|
+
#
|
2289
|
+
# @option params [required, String] :aws_account_id
|
2290
|
+
# The ID for the AWS account that you want to describe QuickSight
|
2291
|
+
# customizations for.
|
2292
|
+
#
|
2293
|
+
# @option params [String] :namespace
|
2294
|
+
# The namespace associated with the customization that you're
|
2295
|
+
# describing.
|
2296
|
+
#
|
2297
|
+
# @option params [Boolean] :resolved
|
2298
|
+
# The status of the creation of the customization. This is an
|
2299
|
+
# asynchronous process. A status of `CREATED` means that your
|
2300
|
+
# customization is ready to use.
|
2301
|
+
#
|
2302
|
+
# @return [Types::DescribeAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2303
|
+
#
|
2304
|
+
# * {Types::DescribeAccountCustomizationResponse#aws_account_id #aws_account_id} => String
|
2305
|
+
# * {Types::DescribeAccountCustomizationResponse#namespace #namespace} => String
|
2306
|
+
# * {Types::DescribeAccountCustomizationResponse#account_customization #account_customization} => Types::AccountCustomization
|
2307
|
+
# * {Types::DescribeAccountCustomizationResponse#request_id #request_id} => String
|
2308
|
+
# * {Types::DescribeAccountCustomizationResponse#status #status} => Integer
|
2309
|
+
#
|
2310
|
+
# @example Request syntax with placeholder values
|
2311
|
+
#
|
2312
|
+
# resp = client.describe_account_customization({
|
2313
|
+
# aws_account_id: "AwsAccountId", # required
|
2314
|
+
# namespace: "Namespace",
|
2315
|
+
# resolved: false,
|
2316
|
+
# })
|
2317
|
+
#
|
2318
|
+
# @example Response structure
|
2319
|
+
#
|
2320
|
+
# resp.aws_account_id #=> String
|
2321
|
+
# resp.namespace #=> String
|
2322
|
+
# resp.account_customization.default_theme #=> String
|
2323
|
+
# resp.request_id #=> String
|
2324
|
+
# resp.status #=> Integer
|
2325
|
+
#
|
2326
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountCustomization AWS API Documentation
|
2327
|
+
#
|
2328
|
+
# @overload describe_account_customization(params = {})
|
2329
|
+
# @param [Hash] params ({})
|
2330
|
+
def describe_account_customization(params = {}, options = {})
|
2331
|
+
req = build_request(:describe_account_customization, params)
|
2332
|
+
req.send_request(options)
|
2333
|
+
end
|
2334
|
+
|
2335
|
+
# Describes the settings that were used when your QuickSight
|
2336
|
+
# subscription was first created in this AWS Account.
|
2337
|
+
#
|
2338
|
+
# @option params [required, String] :aws_account_id
|
2339
|
+
# The ID for the AWS account that contains the QuickSight namespaces
|
2340
|
+
# that you want to list.
|
2341
|
+
#
|
2342
|
+
# @return [Types::DescribeAccountSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2343
|
+
#
|
2344
|
+
# * {Types::DescribeAccountSettingsResponse#account_settings #account_settings} => Types::AccountSettings
|
2345
|
+
# * {Types::DescribeAccountSettingsResponse#request_id #request_id} => String
|
2346
|
+
# * {Types::DescribeAccountSettingsResponse#status #status} => Integer
|
2347
|
+
#
|
2348
|
+
# @example Request syntax with placeholder values
|
2349
|
+
#
|
2350
|
+
# resp = client.describe_account_settings({
|
2351
|
+
# aws_account_id: "AwsAccountId", # required
|
2352
|
+
# })
|
2353
|
+
#
|
2354
|
+
# @example Response structure
|
2355
|
+
#
|
2356
|
+
# resp.account_settings.account_name #=> String
|
2357
|
+
# resp.account_settings.edition #=> String, one of "STANDARD", "ENTERPRISE"
|
2358
|
+
# resp.account_settings.default_namespace #=> String
|
2359
|
+
# resp.account_settings.notification_email #=> String
|
2360
|
+
# resp.request_id #=> String
|
2361
|
+
# resp.status #=> Integer
|
2362
|
+
#
|
2363
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountSettings AWS API Documentation
|
2364
|
+
#
|
2365
|
+
# @overload describe_account_settings(params = {})
|
2366
|
+
# @param [Hash] params ({})
|
2367
|
+
def describe_account_settings(params = {}, options = {})
|
2368
|
+
req = build_request(:describe_account_settings, params)
|
2369
|
+
req.send_request(options)
|
2370
|
+
end
|
2371
|
+
|
1708
2372
|
# Provides a summary for a dashboard.
|
1709
2373
|
#
|
1710
2374
|
# @option params [required, String] :aws_account_id
|
@@ -1895,6 +2559,7 @@ module Aws::QuickSight
|
|
1895
2559
|
# resp.data_set.column_groups[0].geo_spatial_column_group.country_code #=> String, one of "US"
|
1896
2560
|
# resp.data_set.column_groups[0].geo_spatial_column_group.columns #=> Array
|
1897
2561
|
# resp.data_set.column_groups[0].geo_spatial_column_group.columns[0] #=> String
|
2562
|
+
# resp.data_set.row_level_permission_data_set.namespace #=> String
|
1898
2563
|
# resp.data_set.row_level_permission_data_set.arn #=> String
|
1899
2564
|
# resp.data_set.row_level_permission_data_set.permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS"
|
1900
2565
|
# resp.request_id #=> String
|
@@ -2031,9 +2696,54 @@ module Aws::QuickSight
|
|
2031
2696
|
# resp.data_source.data_source_parameters.teradata_parameters.database #=> String
|
2032
2697
|
# resp.data_source.data_source_parameters.twitter_parameters.query #=> String
|
2033
2698
|
# resp.data_source.data_source_parameters.twitter_parameters.max_rows #=> Integer
|
2699
|
+
# resp.data_source.alternate_data_source_parameters #=> Array
|
2700
|
+
# resp.data_source.alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
|
2701
|
+
# resp.data_source.alternate_data_source_parameters[0].athena_parameters.work_group #=> String
|
2702
|
+
# resp.data_source.alternate_data_source_parameters[0].aurora_parameters.host #=> String
|
2703
|
+
# resp.data_source.alternate_data_source_parameters[0].aurora_parameters.port #=> Integer
|
2704
|
+
# resp.data_source.alternate_data_source_parameters[0].aurora_parameters.database #=> String
|
2705
|
+
# resp.data_source.alternate_data_source_parameters[0].aurora_postgre_sql_parameters.host #=> String
|
2706
|
+
# resp.data_source.alternate_data_source_parameters[0].aurora_postgre_sql_parameters.port #=> Integer
|
2707
|
+
# resp.data_source.alternate_data_source_parameters[0].aurora_postgre_sql_parameters.database #=> String
|
2708
|
+
# resp.data_source.alternate_data_source_parameters[0].aws_iot_analytics_parameters.data_set_name #=> String
|
2709
|
+
# resp.data_source.alternate_data_source_parameters[0].jira_parameters.site_base_url #=> String
|
2710
|
+
# resp.data_source.alternate_data_source_parameters[0].maria_db_parameters.host #=> String
|
2711
|
+
# resp.data_source.alternate_data_source_parameters[0].maria_db_parameters.port #=> Integer
|
2712
|
+
# resp.data_source.alternate_data_source_parameters[0].maria_db_parameters.database #=> String
|
2713
|
+
# resp.data_source.alternate_data_source_parameters[0].my_sql_parameters.host #=> String
|
2714
|
+
# resp.data_source.alternate_data_source_parameters[0].my_sql_parameters.port #=> Integer
|
2715
|
+
# resp.data_source.alternate_data_source_parameters[0].my_sql_parameters.database #=> String
|
2716
|
+
# resp.data_source.alternate_data_source_parameters[0].postgre_sql_parameters.host #=> String
|
2717
|
+
# resp.data_source.alternate_data_source_parameters[0].postgre_sql_parameters.port #=> Integer
|
2718
|
+
# resp.data_source.alternate_data_source_parameters[0].postgre_sql_parameters.database #=> String
|
2719
|
+
# resp.data_source.alternate_data_source_parameters[0].presto_parameters.host #=> String
|
2720
|
+
# resp.data_source.alternate_data_source_parameters[0].presto_parameters.port #=> Integer
|
2721
|
+
# resp.data_source.alternate_data_source_parameters[0].presto_parameters.catalog #=> String
|
2722
|
+
# resp.data_source.alternate_data_source_parameters[0].rds_parameters.instance_id #=> String
|
2723
|
+
# resp.data_source.alternate_data_source_parameters[0].rds_parameters.database #=> String
|
2724
|
+
# resp.data_source.alternate_data_source_parameters[0].redshift_parameters.host #=> String
|
2725
|
+
# resp.data_source.alternate_data_source_parameters[0].redshift_parameters.port #=> Integer
|
2726
|
+
# resp.data_source.alternate_data_source_parameters[0].redshift_parameters.database #=> String
|
2727
|
+
# resp.data_source.alternate_data_source_parameters[0].redshift_parameters.cluster_id #=> String
|
2728
|
+
# resp.data_source.alternate_data_source_parameters[0].s3_parameters.manifest_file_location.bucket #=> String
|
2729
|
+
# resp.data_source.alternate_data_source_parameters[0].s3_parameters.manifest_file_location.key #=> String
|
2730
|
+
# resp.data_source.alternate_data_source_parameters[0].service_now_parameters.site_base_url #=> String
|
2731
|
+
# resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.host #=> String
|
2732
|
+
# resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.database #=> String
|
2733
|
+
# resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.warehouse #=> String
|
2734
|
+
# resp.data_source.alternate_data_source_parameters[0].spark_parameters.host #=> String
|
2735
|
+
# resp.data_source.alternate_data_source_parameters[0].spark_parameters.port #=> Integer
|
2736
|
+
# resp.data_source.alternate_data_source_parameters[0].sql_server_parameters.host #=> String
|
2737
|
+
# resp.data_source.alternate_data_source_parameters[0].sql_server_parameters.port #=> Integer
|
2738
|
+
# resp.data_source.alternate_data_source_parameters[0].sql_server_parameters.database #=> String
|
2739
|
+
# resp.data_source.alternate_data_source_parameters[0].teradata_parameters.host #=> String
|
2740
|
+
# resp.data_source.alternate_data_source_parameters[0].teradata_parameters.port #=> Integer
|
2741
|
+
# resp.data_source.alternate_data_source_parameters[0].teradata_parameters.database #=> String
|
2742
|
+
# resp.data_source.alternate_data_source_parameters[0].twitter_parameters.query #=> String
|
2743
|
+
# resp.data_source.alternate_data_source_parameters[0].twitter_parameters.max_rows #=> Integer
|
2034
2744
|
# resp.data_source.vpc_connection_properties.vpc_connection_arn #=> String
|
2035
2745
|
# 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"
|
2746
|
+
# 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
2747
|
# resp.data_source.error_info.message #=> String
|
2038
2748
|
# resp.request_id #=> String
|
2039
2749
|
# resp.status #=> Integer
|
@@ -2239,6 +2949,49 @@ module Aws::QuickSight
|
|
2239
2949
|
req.send_request(options)
|
2240
2950
|
end
|
2241
2951
|
|
2952
|
+
# Describes the current namespace.
|
2953
|
+
#
|
2954
|
+
# @option params [required, String] :aws_account_id
|
2955
|
+
# The ID for the AWS account that contains the QuickSight namespace that
|
2956
|
+
# you want to describe.
|
2957
|
+
#
|
2958
|
+
# @option params [required, String] :namespace
|
2959
|
+
# The namespace that you want to describe.
|
2960
|
+
#
|
2961
|
+
# @return [Types::DescribeNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2962
|
+
#
|
2963
|
+
# * {Types::DescribeNamespaceResponse#namespace #namespace} => Types::NamespaceInfoV2
|
2964
|
+
# * {Types::DescribeNamespaceResponse#request_id #request_id} => String
|
2965
|
+
# * {Types::DescribeNamespaceResponse#status #status} => Integer
|
2966
|
+
#
|
2967
|
+
# @example Request syntax with placeholder values
|
2968
|
+
#
|
2969
|
+
# resp = client.describe_namespace({
|
2970
|
+
# aws_account_id: "AwsAccountId", # required
|
2971
|
+
# namespace: "Namespace", # required
|
2972
|
+
# })
|
2973
|
+
#
|
2974
|
+
# @example Response structure
|
2975
|
+
#
|
2976
|
+
# resp.namespace.name #=> String
|
2977
|
+
# resp.namespace.arn #=> String
|
2978
|
+
# resp.namespace.capacity_region #=> String
|
2979
|
+
# resp.namespace.creation_status #=> String, one of "CREATED", "CREATING", "DELETING", "RETRYABLE_FAILURE", "NON_RETRYABLE_FAILURE"
|
2980
|
+
# resp.namespace.identity_store #=> String, one of "QUICKSIGHT"
|
2981
|
+
# resp.namespace.namespace_error.type #=> String, one of "PERMISSION_DENIED", "INTERNAL_SERVICE_ERROR"
|
2982
|
+
# resp.namespace.namespace_error.message #=> String
|
2983
|
+
# resp.request_id #=> String
|
2984
|
+
# resp.status #=> Integer
|
2985
|
+
#
|
2986
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeNamespace AWS API Documentation
|
2987
|
+
#
|
2988
|
+
# @overload describe_namespace(params = {})
|
2989
|
+
# @param [Hash] params ({})
|
2990
|
+
def describe_namespace(params = {}, options = {})
|
2991
|
+
req = build_request(:describe_namespace, params)
|
2992
|
+
req.send_request(options)
|
2993
|
+
end
|
2994
|
+
|
2242
2995
|
# Describes a template's metadata.
|
2243
2996
|
#
|
2244
2997
|
# @option params [required, String] :aws_account_id
|
@@ -2264,6 +3017,7 @@ module Aws::QuickSight
|
|
2264
3017
|
#
|
2265
3018
|
# * {Types::DescribeTemplateResponse#template #template} => Types::Template
|
2266
3019
|
# * {Types::DescribeTemplateResponse#status #status} => Integer
|
3020
|
+
# * {Types::DescribeTemplateResponse#request_id #request_id} => String
|
2267
3021
|
#
|
2268
3022
|
# @example Request syntax with placeholder values
|
2269
3023
|
#
|
@@ -2300,6 +3054,7 @@ module Aws::QuickSight
|
|
2300
3054
|
# resp.template.last_updated_time #=> Time
|
2301
3055
|
# resp.template.created_time #=> Time
|
2302
3056
|
# resp.status #=> Integer
|
3057
|
+
# resp.request_id #=> String
|
2303
3058
|
#
|
2304
3059
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTemplate AWS API Documentation
|
2305
3060
|
#
|
@@ -2401,6 +3156,182 @@ module Aws::QuickSight
|
|
2401
3156
|
req.send_request(options)
|
2402
3157
|
end
|
2403
3158
|
|
3159
|
+
# Describes a theme.
|
3160
|
+
#
|
3161
|
+
# @option params [required, String] :aws_account_id
|
3162
|
+
# The ID of the AWS account that contains the theme that you're
|
3163
|
+
# describing.
|
3164
|
+
#
|
3165
|
+
# @option params [required, String] :theme_id
|
3166
|
+
# The ID for the theme.
|
3167
|
+
#
|
3168
|
+
# @option params [Integer] :version_number
|
3169
|
+
# The version number for the version to describe. If a `VersionNumber`
|
3170
|
+
# parameter value isn't provided, the latest version of the theme is
|
3171
|
+
# described.
|
3172
|
+
#
|
3173
|
+
# @option params [String] :alias_name
|
3174
|
+
# The alias of the theme that you want to describe. If you name a
|
3175
|
+
# specific alias, you describe the version that the alias points to. You
|
3176
|
+
# can specify the latest version of the theme by providing the keyword
|
3177
|
+
# `$LATEST` in the `AliasName` parameter. The keyword `$PUBLISHED`
|
3178
|
+
# doesn't apply to themes.
|
3179
|
+
#
|
3180
|
+
# @return [Types::DescribeThemeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3181
|
+
#
|
3182
|
+
# * {Types::DescribeThemeResponse#theme #theme} => Types::Theme
|
3183
|
+
# * {Types::DescribeThemeResponse#status #status} => Integer
|
3184
|
+
# * {Types::DescribeThemeResponse#request_id #request_id} => String
|
3185
|
+
#
|
3186
|
+
# @example Request syntax with placeholder values
|
3187
|
+
#
|
3188
|
+
# resp = client.describe_theme({
|
3189
|
+
# aws_account_id: "AwsAndAccountId", # required
|
3190
|
+
# theme_id: "RestrictiveResourceId", # required
|
3191
|
+
# version_number: 1,
|
3192
|
+
# alias_name: "AliasName",
|
3193
|
+
# })
|
3194
|
+
#
|
3195
|
+
# @example Response structure
|
3196
|
+
#
|
3197
|
+
# resp.theme.arn #=> String
|
3198
|
+
# resp.theme.name #=> String
|
3199
|
+
# resp.theme.theme_id #=> String
|
3200
|
+
# resp.theme.version.version_number #=> Integer
|
3201
|
+
# resp.theme.version.arn #=> String
|
3202
|
+
# resp.theme.version.description #=> String
|
3203
|
+
# resp.theme.version.base_theme_id #=> String
|
3204
|
+
# resp.theme.version.created_time #=> Time
|
3205
|
+
# resp.theme.version.configuration.data_color_palette.colors #=> Array
|
3206
|
+
# resp.theme.version.configuration.data_color_palette.colors[0] #=> String
|
3207
|
+
# resp.theme.version.configuration.data_color_palette.min_max_gradient #=> Array
|
3208
|
+
# resp.theme.version.configuration.data_color_palette.min_max_gradient[0] #=> String
|
3209
|
+
# resp.theme.version.configuration.data_color_palette.empty_fill_color #=> String
|
3210
|
+
# resp.theme.version.configuration.ui_color_palette.primary_foreground #=> String
|
3211
|
+
# resp.theme.version.configuration.ui_color_palette.primary_background #=> String
|
3212
|
+
# resp.theme.version.configuration.ui_color_palette.secondary_foreground #=> String
|
3213
|
+
# resp.theme.version.configuration.ui_color_palette.secondary_background #=> String
|
3214
|
+
# resp.theme.version.configuration.ui_color_palette.accent #=> String
|
3215
|
+
# resp.theme.version.configuration.ui_color_palette.accent_foreground #=> String
|
3216
|
+
# resp.theme.version.configuration.ui_color_palette.danger #=> String
|
3217
|
+
# resp.theme.version.configuration.ui_color_palette.danger_foreground #=> String
|
3218
|
+
# resp.theme.version.configuration.ui_color_palette.warning #=> String
|
3219
|
+
# resp.theme.version.configuration.ui_color_palette.warning_foreground #=> String
|
3220
|
+
# resp.theme.version.configuration.ui_color_palette.success #=> String
|
3221
|
+
# resp.theme.version.configuration.ui_color_palette.success_foreground #=> String
|
3222
|
+
# resp.theme.version.configuration.ui_color_palette.dimension #=> String
|
3223
|
+
# resp.theme.version.configuration.ui_color_palette.dimension_foreground #=> String
|
3224
|
+
# resp.theme.version.configuration.ui_color_palette.measure #=> String
|
3225
|
+
# resp.theme.version.configuration.ui_color_palette.measure_foreground #=> String
|
3226
|
+
# resp.theme.version.configuration.sheet.tile.border.show #=> Boolean
|
3227
|
+
# resp.theme.version.configuration.sheet.tile_layout.gutter.show #=> Boolean
|
3228
|
+
# resp.theme.version.configuration.sheet.tile_layout.margin.show #=> Boolean
|
3229
|
+
# resp.theme.version.errors #=> Array
|
3230
|
+
# resp.theme.version.errors[0].type #=> String, one of "INTERNAL_FAILURE"
|
3231
|
+
# resp.theme.version.errors[0].message #=> String
|
3232
|
+
# resp.theme.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
3233
|
+
# resp.theme.created_time #=> Time
|
3234
|
+
# resp.theme.last_updated_time #=> Time
|
3235
|
+
# resp.theme.type #=> String, one of "QUICKSIGHT", "CUSTOM", "ALL"
|
3236
|
+
# resp.status #=> Integer
|
3237
|
+
# resp.request_id #=> String
|
3238
|
+
#
|
3239
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTheme AWS API Documentation
|
3240
|
+
#
|
3241
|
+
# @overload describe_theme(params = {})
|
3242
|
+
# @param [Hash] params ({})
|
3243
|
+
def describe_theme(params = {}, options = {})
|
3244
|
+
req = build_request(:describe_theme, params)
|
3245
|
+
req.send_request(options)
|
3246
|
+
end
|
3247
|
+
|
3248
|
+
# Describes the alias for a theme.
|
3249
|
+
#
|
3250
|
+
# @option params [required, String] :aws_account_id
|
3251
|
+
# The ID of the AWS account that contains the theme alias that you're
|
3252
|
+
# describing.
|
3253
|
+
#
|
3254
|
+
# @option params [required, String] :theme_id
|
3255
|
+
# The ID for the theme.
|
3256
|
+
#
|
3257
|
+
# @option params [required, String] :alias_name
|
3258
|
+
# The name of the theme alias that you want to describe.
|
3259
|
+
#
|
3260
|
+
# @return [Types::DescribeThemeAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3261
|
+
#
|
3262
|
+
# * {Types::DescribeThemeAliasResponse#theme_alias #theme_alias} => Types::ThemeAlias
|
3263
|
+
# * {Types::DescribeThemeAliasResponse#status #status} => Integer
|
3264
|
+
# * {Types::DescribeThemeAliasResponse#request_id #request_id} => String
|
3265
|
+
#
|
3266
|
+
# @example Request syntax with placeholder values
|
3267
|
+
#
|
3268
|
+
# resp = client.describe_theme_alias({
|
3269
|
+
# aws_account_id: "AwsAccountId", # required
|
3270
|
+
# theme_id: "RestrictiveResourceId", # required
|
3271
|
+
# alias_name: "AliasName", # required
|
3272
|
+
# })
|
3273
|
+
#
|
3274
|
+
# @example Response structure
|
3275
|
+
#
|
3276
|
+
# resp.theme_alias.arn #=> String
|
3277
|
+
# resp.theme_alias.alias_name #=> String
|
3278
|
+
# resp.theme_alias.theme_version_number #=> Integer
|
3279
|
+
# resp.status #=> Integer
|
3280
|
+
# resp.request_id #=> String
|
3281
|
+
#
|
3282
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeThemeAlias AWS API Documentation
|
3283
|
+
#
|
3284
|
+
# @overload describe_theme_alias(params = {})
|
3285
|
+
# @param [Hash] params ({})
|
3286
|
+
def describe_theme_alias(params = {}, options = {})
|
3287
|
+
req = build_request(:describe_theme_alias, params)
|
3288
|
+
req.send_request(options)
|
3289
|
+
end
|
3290
|
+
|
3291
|
+
# Describes the read and write permissions for a theme.
|
3292
|
+
#
|
3293
|
+
# @option params [required, String] :aws_account_id
|
3294
|
+
# The ID of the AWS account that contains the theme that you're
|
3295
|
+
# describing.
|
3296
|
+
#
|
3297
|
+
# @option params [required, String] :theme_id
|
3298
|
+
# The ID for the theme that you want to describe permissions for.
|
3299
|
+
#
|
3300
|
+
# @return [Types::DescribeThemePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3301
|
+
#
|
3302
|
+
# * {Types::DescribeThemePermissionsResponse#theme_id #theme_id} => String
|
3303
|
+
# * {Types::DescribeThemePermissionsResponse#theme_arn #theme_arn} => String
|
3304
|
+
# * {Types::DescribeThemePermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission>
|
3305
|
+
# * {Types::DescribeThemePermissionsResponse#request_id #request_id} => String
|
3306
|
+
# * {Types::DescribeThemePermissionsResponse#status #status} => Integer
|
3307
|
+
#
|
3308
|
+
# @example Request syntax with placeholder values
|
3309
|
+
#
|
3310
|
+
# resp = client.describe_theme_permissions({
|
3311
|
+
# aws_account_id: "AwsAccountId", # required
|
3312
|
+
# theme_id: "RestrictiveResourceId", # required
|
3313
|
+
# })
|
3314
|
+
#
|
3315
|
+
# @example Response structure
|
3316
|
+
#
|
3317
|
+
# resp.theme_id #=> String
|
3318
|
+
# resp.theme_arn #=> String
|
3319
|
+
# resp.permissions #=> Array
|
3320
|
+
# resp.permissions[0].principal #=> String
|
3321
|
+
# resp.permissions[0].actions #=> Array
|
3322
|
+
# resp.permissions[0].actions[0] #=> String
|
3323
|
+
# resp.request_id #=> String
|
3324
|
+
# resp.status #=> Integer
|
3325
|
+
#
|
3326
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeThemePermissions AWS API Documentation
|
3327
|
+
#
|
3328
|
+
# @overload describe_theme_permissions(params = {})
|
3329
|
+
# @param [Hash] params ({})
|
3330
|
+
def describe_theme_permissions(params = {}, options = {})
|
3331
|
+
req = build_request(:describe_theme_permissions, params)
|
3332
|
+
req.send_request(options)
|
3333
|
+
end
|
3334
|
+
|
2404
3335
|
# Returns information about a user, given the user name.
|
2405
3336
|
#
|
2406
3337
|
# @option params [required, String] :user_name
|
@@ -2436,6 +3367,7 @@ module Aws::QuickSight
|
|
2436
3367
|
# resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
|
2437
3368
|
# resp.user.active #=> Boolean
|
2438
3369
|
# resp.user.principal_id #=> String
|
3370
|
+
# resp.user.custom_permissions_name #=> String
|
2439
3371
|
# resp.request_id #=> String
|
2440
3372
|
# resp.status #=> Integer
|
2441
3373
|
#
|
@@ -2448,15 +3380,25 @@ module Aws::QuickSight
|
|
2448
3380
|
req.send_request(options)
|
2449
3381
|
end
|
2450
3382
|
|
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*.
|
3383
|
+
# Generates a URL and authorization code that you can embed in your web
|
3384
|
+
# server code. Before you use this command, make sure that you have
|
3385
|
+
# configured the dashboards and permissions.
|
2457
3386
|
#
|
2458
3387
|
# Currently, you can use `GetDashboardEmbedURL` only from the server,
|
2459
|
-
# not from the user
|
3388
|
+
# not from the user's browser. The following rules apply to the
|
3389
|
+
# combination of URL and authorization code:
|
3390
|
+
#
|
3391
|
+
# * They must be used together.
|
3392
|
+
#
|
3393
|
+
# * They can be used one time only.
|
3394
|
+
#
|
3395
|
+
# * They are valid for 5 minutes after you run this command.
|
3396
|
+
#
|
3397
|
+
# * The resulting user session is valid for 10 hours.
|
3398
|
+
#
|
3399
|
+
# For more information, see [Embedding Amazon QuickSight Dashboards][1]
|
3400
|
+
# in the *Amazon QuickSight User Guide* or [Embedding Amazon QuickSight
|
3401
|
+
# Dashboards][2] in the *Amazon QuickSight API Reference*.
|
2460
3402
|
#
|
2461
3403
|
#
|
2462
3404
|
#
|
@@ -2532,6 +3474,64 @@ module Aws::QuickSight
|
|
2532
3474
|
req.send_request(options)
|
2533
3475
|
end
|
2534
3476
|
|
3477
|
+
# Generates a session URL and authorization code that you can embed in
|
3478
|
+
# your web server code.
|
3479
|
+
#
|
3480
|
+
# @option params [required, String] :aws_account_id
|
3481
|
+
# The ID for the AWS account that contains the QuickSight session that
|
3482
|
+
# you're embedding.
|
3483
|
+
#
|
3484
|
+
# @option params [String] :entry_point
|
3485
|
+
# The entry point for the embedded session.
|
3486
|
+
#
|
3487
|
+
# @option params [Integer] :session_lifetime_in_minutes
|
3488
|
+
# How many minutes the session is valid. The session lifetime must be
|
3489
|
+
# 15-600 minutes.
|
3490
|
+
#
|
3491
|
+
# @option params [String] :user_arn
|
3492
|
+
# The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
|
3493
|
+
# `QUICKSIGHT` identity type. You can use this for any Amazon QuickSight
|
3494
|
+
# users in your account (readers, authors, or admins) authenticated as
|
3495
|
+
# one of the following:
|
3496
|
+
#
|
3497
|
+
# * Active Directory (AD) users or group members
|
3498
|
+
#
|
3499
|
+
# * Invited nonfederated users
|
3500
|
+
#
|
3501
|
+
# * IAM users and IAM role-based sessions authenticated through
|
3502
|
+
# Federated Single Sign-On using SAML, OpenID Connect, or IAM
|
3503
|
+
# federation.
|
3504
|
+
#
|
3505
|
+
# @return [Types::GetSessionEmbedUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3506
|
+
#
|
3507
|
+
# * {Types::GetSessionEmbedUrlResponse#embed_url #embed_url} => String
|
3508
|
+
# * {Types::GetSessionEmbedUrlResponse#status #status} => Integer
|
3509
|
+
# * {Types::GetSessionEmbedUrlResponse#request_id #request_id} => String
|
3510
|
+
#
|
3511
|
+
# @example Request syntax with placeholder values
|
3512
|
+
#
|
3513
|
+
# resp = client.get_session_embed_url({
|
3514
|
+
# aws_account_id: "AwsAccountId", # required
|
3515
|
+
# entry_point: "EntryPoint",
|
3516
|
+
# session_lifetime_in_minutes: 1,
|
3517
|
+
# user_arn: "Arn",
|
3518
|
+
# })
|
3519
|
+
#
|
3520
|
+
# @example Response structure
|
3521
|
+
#
|
3522
|
+
# resp.embed_url #=> String
|
3523
|
+
# resp.status #=> Integer
|
3524
|
+
# resp.request_id #=> String
|
3525
|
+
#
|
3526
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetSessionEmbedUrl AWS API Documentation
|
3527
|
+
#
|
3528
|
+
# @overload get_session_embed_url(params = {})
|
3529
|
+
# @param [Hash] params ({})
|
3530
|
+
def get_session_embed_url(params = {}, options = {})
|
3531
|
+
req = build_request(:get_session_embed_url, params)
|
3532
|
+
req.send_request(options)
|
3533
|
+
end
|
3534
|
+
|
2535
3535
|
# Lists all the versions of the dashboards in the QuickSight
|
2536
3536
|
# subscription.
|
2537
3537
|
#
|
@@ -2684,6 +3684,7 @@ module Aws::QuickSight
|
|
2684
3684
|
# resp.data_set_summaries[0].created_time #=> Time
|
2685
3685
|
# resp.data_set_summaries[0].last_updated_time #=> Time
|
2686
3686
|
# resp.data_set_summaries[0].import_mode #=> String, one of "SPICE", "DIRECT_QUERY"
|
3687
|
+
# resp.data_set_summaries[0].row_level_permission_data_set.namespace #=> String
|
2687
3688
|
# resp.data_set_summaries[0].row_level_permission_data_set.arn #=> String
|
2688
3689
|
# resp.data_set_summaries[0].row_level_permission_data_set.permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS"
|
2689
3690
|
# resp.next_token #=> String
|
@@ -2783,9 +3784,54 @@ module Aws::QuickSight
|
|
2783
3784
|
# resp.data_sources[0].data_source_parameters.teradata_parameters.database #=> String
|
2784
3785
|
# resp.data_sources[0].data_source_parameters.twitter_parameters.query #=> String
|
2785
3786
|
# resp.data_sources[0].data_source_parameters.twitter_parameters.max_rows #=> Integer
|
3787
|
+
# resp.data_sources[0].alternate_data_source_parameters #=> Array
|
3788
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
|
3789
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].athena_parameters.work_group #=> String
|
3790
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].aurora_parameters.host #=> String
|
3791
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].aurora_parameters.port #=> Integer
|
3792
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].aurora_parameters.database #=> String
|
3793
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].aurora_postgre_sql_parameters.host #=> String
|
3794
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].aurora_postgre_sql_parameters.port #=> Integer
|
3795
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].aurora_postgre_sql_parameters.database #=> String
|
3796
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].aws_iot_analytics_parameters.data_set_name #=> String
|
3797
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].jira_parameters.site_base_url #=> String
|
3798
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].maria_db_parameters.host #=> String
|
3799
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].maria_db_parameters.port #=> Integer
|
3800
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].maria_db_parameters.database #=> String
|
3801
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].my_sql_parameters.host #=> String
|
3802
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].my_sql_parameters.port #=> Integer
|
3803
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].my_sql_parameters.database #=> String
|
3804
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].postgre_sql_parameters.host #=> String
|
3805
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].postgre_sql_parameters.port #=> Integer
|
3806
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].postgre_sql_parameters.database #=> String
|
3807
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].presto_parameters.host #=> String
|
3808
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].presto_parameters.port #=> Integer
|
3809
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].presto_parameters.catalog #=> String
|
3810
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].rds_parameters.instance_id #=> String
|
3811
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].rds_parameters.database #=> String
|
3812
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.host #=> String
|
3813
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.port #=> Integer
|
3814
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.database #=> String
|
3815
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.cluster_id #=> String
|
3816
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].s3_parameters.manifest_file_location.bucket #=> String
|
3817
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].s3_parameters.manifest_file_location.key #=> String
|
3818
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].service_now_parameters.site_base_url #=> String
|
3819
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.host #=> String
|
3820
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.database #=> String
|
3821
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.warehouse #=> String
|
3822
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].spark_parameters.host #=> String
|
3823
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].spark_parameters.port #=> Integer
|
3824
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].sql_server_parameters.host #=> String
|
3825
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].sql_server_parameters.port #=> Integer
|
3826
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].sql_server_parameters.database #=> String
|
3827
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].teradata_parameters.host #=> String
|
3828
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].teradata_parameters.port #=> Integer
|
3829
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].teradata_parameters.database #=> String
|
3830
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].twitter_parameters.query #=> String
|
3831
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].twitter_parameters.max_rows #=> Integer
|
2786
3832
|
# resp.data_sources[0].vpc_connection_properties.vpc_connection_arn #=> String
|
2787
3833
|
# 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"
|
3834
|
+
# 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
3835
|
# resp.data_sources[0].error_info.message #=> String
|
2790
3836
|
# resp.next_token #=> String
|
2791
3837
|
# resp.request_id #=> String
|
@@ -3077,6 +4123,58 @@ module Aws::QuickSight
|
|
3077
4123
|
req.send_request(options)
|
3078
4124
|
end
|
3079
4125
|
|
4126
|
+
# Lists the namespaces for the specified AWS account.
|
4127
|
+
#
|
4128
|
+
# @option params [required, String] :aws_account_id
|
4129
|
+
# The ID for the AWS account that contains the QuickSight namespaces
|
4130
|
+
# that you want to list.
|
4131
|
+
#
|
4132
|
+
# @option params [String] :next_token
|
4133
|
+
# A pagination token that can be used in a subsequent request.
|
4134
|
+
#
|
4135
|
+
# @option params [Integer] :max_results
|
4136
|
+
# The maximum number of results to return.
|
4137
|
+
#
|
4138
|
+
# @return [Types::ListNamespacesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4139
|
+
#
|
4140
|
+
# * {Types::ListNamespacesResponse#namespaces #namespaces} => Array<Types::NamespaceInfoV2>
|
4141
|
+
# * {Types::ListNamespacesResponse#next_token #next_token} => String
|
4142
|
+
# * {Types::ListNamespacesResponse#request_id #request_id} => String
|
4143
|
+
# * {Types::ListNamespacesResponse#status #status} => Integer
|
4144
|
+
#
|
4145
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4146
|
+
#
|
4147
|
+
# @example Request syntax with placeholder values
|
4148
|
+
#
|
4149
|
+
# resp = client.list_namespaces({
|
4150
|
+
# aws_account_id: "AwsAccountId", # required
|
4151
|
+
# next_token: "String",
|
4152
|
+
# max_results: 1,
|
4153
|
+
# })
|
4154
|
+
#
|
4155
|
+
# @example Response structure
|
4156
|
+
#
|
4157
|
+
# resp.namespaces #=> Array
|
4158
|
+
# resp.namespaces[0].name #=> String
|
4159
|
+
# resp.namespaces[0].arn #=> String
|
4160
|
+
# resp.namespaces[0].capacity_region #=> String
|
4161
|
+
# resp.namespaces[0].creation_status #=> String, one of "CREATED", "CREATING", "DELETING", "RETRYABLE_FAILURE", "NON_RETRYABLE_FAILURE"
|
4162
|
+
# resp.namespaces[0].identity_store #=> String, one of "QUICKSIGHT"
|
4163
|
+
# resp.namespaces[0].namespace_error.type #=> String, one of "PERMISSION_DENIED", "INTERNAL_SERVICE_ERROR"
|
4164
|
+
# resp.namespaces[0].namespace_error.message #=> String
|
4165
|
+
# resp.next_token #=> String
|
4166
|
+
# resp.request_id #=> String
|
4167
|
+
# resp.status #=> Integer
|
4168
|
+
#
|
4169
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListNamespaces AWS API Documentation
|
4170
|
+
#
|
4171
|
+
# @overload list_namespaces(params = {})
|
4172
|
+
# @param [Hash] params ({})
|
4173
|
+
def list_namespaces(params = {}, options = {})
|
4174
|
+
req = build_request(:list_namespaces, params)
|
4175
|
+
req.send_request(options)
|
4176
|
+
end
|
4177
|
+
|
3080
4178
|
# Lists the tags assigned to a resource.
|
3081
4179
|
#
|
3082
4180
|
# @option params [required, String] :resource_arn
|
@@ -3156,24 +4254,182 @@ module Aws::QuickSight
|
|
3156
4254
|
# resp.request_id #=> String
|
3157
4255
|
# resp.next_token #=> String
|
3158
4256
|
#
|
3159
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTemplateAliases AWS API Documentation
|
4257
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTemplateAliases AWS API Documentation
|
4258
|
+
#
|
4259
|
+
# @overload list_template_aliases(params = {})
|
4260
|
+
# @param [Hash] params ({})
|
4261
|
+
def list_template_aliases(params = {}, options = {})
|
4262
|
+
req = build_request(:list_template_aliases, params)
|
4263
|
+
req.send_request(options)
|
4264
|
+
end
|
4265
|
+
|
4266
|
+
# Lists all the versions of the templates in the current Amazon
|
4267
|
+
# QuickSight account.
|
4268
|
+
#
|
4269
|
+
# @option params [required, String] :aws_account_id
|
4270
|
+
# The ID of the AWS account that contains the templates that you're
|
4271
|
+
# listing.
|
4272
|
+
#
|
4273
|
+
# @option params [required, String] :template_id
|
4274
|
+
# The ID for the template.
|
4275
|
+
#
|
4276
|
+
# @option params [String] :next_token
|
4277
|
+
# The token for the next set of results, or null if there are no more
|
4278
|
+
# results.
|
4279
|
+
#
|
4280
|
+
# @option params [Integer] :max_results
|
4281
|
+
# The maximum number of results to be returned per request.
|
4282
|
+
#
|
4283
|
+
# @return [Types::ListTemplateVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4284
|
+
#
|
4285
|
+
# * {Types::ListTemplateVersionsResponse#template_version_summary_list #template_version_summary_list} => Array<Types::TemplateVersionSummary>
|
4286
|
+
# * {Types::ListTemplateVersionsResponse#next_token #next_token} => String
|
4287
|
+
# * {Types::ListTemplateVersionsResponse#status #status} => Integer
|
4288
|
+
# * {Types::ListTemplateVersionsResponse#request_id #request_id} => String
|
4289
|
+
#
|
4290
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4291
|
+
#
|
4292
|
+
# @example Request syntax with placeholder values
|
4293
|
+
#
|
4294
|
+
# resp = client.list_template_versions({
|
4295
|
+
# aws_account_id: "AwsAccountId", # required
|
4296
|
+
# template_id: "RestrictiveResourceId", # required
|
4297
|
+
# next_token: "String",
|
4298
|
+
# max_results: 1,
|
4299
|
+
# })
|
4300
|
+
#
|
4301
|
+
# @example Response structure
|
4302
|
+
#
|
4303
|
+
# resp.template_version_summary_list #=> Array
|
4304
|
+
# resp.template_version_summary_list[0].arn #=> String
|
4305
|
+
# resp.template_version_summary_list[0].version_number #=> Integer
|
4306
|
+
# resp.template_version_summary_list[0].created_time #=> Time
|
4307
|
+
# resp.template_version_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
4308
|
+
# resp.template_version_summary_list[0].description #=> String
|
4309
|
+
# resp.next_token #=> String
|
4310
|
+
# resp.status #=> Integer
|
4311
|
+
# resp.request_id #=> String
|
4312
|
+
#
|
4313
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTemplateVersions AWS API Documentation
|
4314
|
+
#
|
4315
|
+
# @overload list_template_versions(params = {})
|
4316
|
+
# @param [Hash] params ({})
|
4317
|
+
def list_template_versions(params = {}, options = {})
|
4318
|
+
req = build_request(:list_template_versions, params)
|
4319
|
+
req.send_request(options)
|
4320
|
+
end
|
4321
|
+
|
4322
|
+
# Lists all the templates in the current Amazon QuickSight account.
|
4323
|
+
#
|
4324
|
+
# @option params [required, String] :aws_account_id
|
4325
|
+
# The ID of the AWS account that contains the templates that you're
|
4326
|
+
# listing.
|
4327
|
+
#
|
4328
|
+
# @option params [String] :next_token
|
4329
|
+
# The token for the next set of results, or null if there are no more
|
4330
|
+
# results.
|
4331
|
+
#
|
4332
|
+
# @option params [Integer] :max_results
|
4333
|
+
# The maximum number of results to be returned per request.
|
4334
|
+
#
|
4335
|
+
# @return [Types::ListTemplatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4336
|
+
#
|
4337
|
+
# * {Types::ListTemplatesResponse#template_summary_list #template_summary_list} => Array<Types::TemplateSummary>
|
4338
|
+
# * {Types::ListTemplatesResponse#next_token #next_token} => String
|
4339
|
+
# * {Types::ListTemplatesResponse#status #status} => Integer
|
4340
|
+
# * {Types::ListTemplatesResponse#request_id #request_id} => String
|
4341
|
+
#
|
4342
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4343
|
+
#
|
4344
|
+
# @example Request syntax with placeholder values
|
4345
|
+
#
|
4346
|
+
# resp = client.list_templates({
|
4347
|
+
# aws_account_id: "AwsAccountId", # required
|
4348
|
+
# next_token: "String",
|
4349
|
+
# max_results: 1,
|
4350
|
+
# })
|
4351
|
+
#
|
4352
|
+
# @example Response structure
|
4353
|
+
#
|
4354
|
+
# resp.template_summary_list #=> Array
|
4355
|
+
# resp.template_summary_list[0].arn #=> String
|
4356
|
+
# resp.template_summary_list[0].template_id #=> String
|
4357
|
+
# resp.template_summary_list[0].name #=> String
|
4358
|
+
# resp.template_summary_list[0].latest_version_number #=> Integer
|
4359
|
+
# resp.template_summary_list[0].created_time #=> Time
|
4360
|
+
# resp.template_summary_list[0].last_updated_time #=> Time
|
4361
|
+
# resp.next_token #=> String
|
4362
|
+
# resp.status #=> Integer
|
4363
|
+
# resp.request_id #=> String
|
4364
|
+
#
|
4365
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTemplates AWS API Documentation
|
4366
|
+
#
|
4367
|
+
# @overload list_templates(params = {})
|
4368
|
+
# @param [Hash] params ({})
|
4369
|
+
def list_templates(params = {}, options = {})
|
4370
|
+
req = build_request(:list_templates, params)
|
4371
|
+
req.send_request(options)
|
4372
|
+
end
|
4373
|
+
|
4374
|
+
# Lists all the aliases of a theme.
|
4375
|
+
#
|
4376
|
+
# @option params [required, String] :aws_account_id
|
4377
|
+
# The ID of the AWS account that contains the theme aliases that you're
|
4378
|
+
# listing.
|
4379
|
+
#
|
4380
|
+
# @option params [required, String] :theme_id
|
4381
|
+
# The ID for the theme.
|
4382
|
+
#
|
4383
|
+
# @option params [String] :next_token
|
4384
|
+
# The token for the next set of results, or null if there are no more
|
4385
|
+
# results.
|
4386
|
+
#
|
4387
|
+
# @option params [Integer] :max_results
|
4388
|
+
# The maximum number of results to be returned per request.
|
4389
|
+
#
|
4390
|
+
# @return [Types::ListThemeAliasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4391
|
+
#
|
4392
|
+
# * {Types::ListThemeAliasesResponse#theme_alias_list #theme_alias_list} => Array<Types::ThemeAlias>
|
4393
|
+
# * {Types::ListThemeAliasesResponse#status #status} => Integer
|
4394
|
+
# * {Types::ListThemeAliasesResponse#request_id #request_id} => String
|
4395
|
+
# * {Types::ListThemeAliasesResponse#next_token #next_token} => String
|
4396
|
+
#
|
4397
|
+
# @example Request syntax with placeholder values
|
4398
|
+
#
|
4399
|
+
# resp = client.list_theme_aliases({
|
4400
|
+
# aws_account_id: "AwsAccountId", # required
|
4401
|
+
# theme_id: "RestrictiveResourceId", # required
|
4402
|
+
# next_token: "String",
|
4403
|
+
# max_results: 1,
|
4404
|
+
# })
|
4405
|
+
#
|
4406
|
+
# @example Response structure
|
4407
|
+
#
|
4408
|
+
# resp.theme_alias_list #=> Array
|
4409
|
+
# resp.theme_alias_list[0].arn #=> String
|
4410
|
+
# resp.theme_alias_list[0].alias_name #=> String
|
4411
|
+
# resp.theme_alias_list[0].theme_version_number #=> Integer
|
4412
|
+
# resp.status #=> Integer
|
4413
|
+
# resp.request_id #=> String
|
4414
|
+
# resp.next_token #=> String
|
4415
|
+
#
|
4416
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListThemeAliases AWS API Documentation
|
3160
4417
|
#
|
3161
|
-
# @overload
|
4418
|
+
# @overload list_theme_aliases(params = {})
|
3162
4419
|
# @param [Hash] params ({})
|
3163
|
-
def
|
3164
|
-
req = build_request(:
|
4420
|
+
def list_theme_aliases(params = {}, options = {})
|
4421
|
+
req = build_request(:list_theme_aliases, params)
|
3165
4422
|
req.send_request(options)
|
3166
4423
|
end
|
3167
4424
|
|
3168
|
-
# Lists all the versions of the
|
3169
|
-
# QuickSight account.
|
4425
|
+
# Lists all the versions of the themes in the current AWS account.
|
3170
4426
|
#
|
3171
4427
|
# @option params [required, String] :aws_account_id
|
3172
|
-
# The ID of the AWS account that contains the
|
4428
|
+
# The ID of the AWS account that contains the themes that you're
|
3173
4429
|
# listing.
|
3174
4430
|
#
|
3175
|
-
# @option params [required, String] :
|
3176
|
-
# The ID for the
|
4431
|
+
# @option params [required, String] :theme_id
|
4432
|
+
# The ID for the theme.
|
3177
4433
|
#
|
3178
4434
|
# @option params [String] :next_token
|
3179
4435
|
# The token for the next set of results, or null if there are no more
|
@@ -3182,49 +4438,47 @@ module Aws::QuickSight
|
|
3182
4438
|
# @option params [Integer] :max_results
|
3183
4439
|
# The maximum number of results to be returned per request.
|
3184
4440
|
#
|
3185
|
-
# @return [Types::
|
3186
|
-
#
|
3187
|
-
# * {Types::ListTemplateVersionsResponse#template_version_summary_list #template_version_summary_list} => Array<Types::TemplateVersionSummary>
|
3188
|
-
# * {Types::ListTemplateVersionsResponse#next_token #next_token} => String
|
3189
|
-
# * {Types::ListTemplateVersionsResponse#status #status} => Integer
|
3190
|
-
# * {Types::ListTemplateVersionsResponse#request_id #request_id} => String
|
4441
|
+
# @return [Types::ListThemeVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3191
4442
|
#
|
3192
|
-
#
|
4443
|
+
# * {Types::ListThemeVersionsResponse#theme_version_summary_list #theme_version_summary_list} => Array<Types::ThemeVersionSummary>
|
4444
|
+
# * {Types::ListThemeVersionsResponse#next_token #next_token} => String
|
4445
|
+
# * {Types::ListThemeVersionsResponse#status #status} => Integer
|
4446
|
+
# * {Types::ListThemeVersionsResponse#request_id #request_id} => String
|
3193
4447
|
#
|
3194
4448
|
# @example Request syntax with placeholder values
|
3195
4449
|
#
|
3196
|
-
# resp = client.
|
4450
|
+
# resp = client.list_theme_versions({
|
3197
4451
|
# aws_account_id: "AwsAccountId", # required
|
3198
|
-
#
|
4452
|
+
# theme_id: "RestrictiveResourceId", # required
|
3199
4453
|
# next_token: "String",
|
3200
4454
|
# max_results: 1,
|
3201
4455
|
# })
|
3202
4456
|
#
|
3203
4457
|
# @example Response structure
|
3204
4458
|
#
|
3205
|
-
# resp.
|
3206
|
-
# resp.
|
3207
|
-
# resp.
|
3208
|
-
# resp.
|
3209
|
-
# resp.
|
3210
|
-
# resp.
|
4459
|
+
# resp.theme_version_summary_list #=> Array
|
4460
|
+
# resp.theme_version_summary_list[0].version_number #=> Integer
|
4461
|
+
# resp.theme_version_summary_list[0].arn #=> String
|
4462
|
+
# resp.theme_version_summary_list[0].description #=> String
|
4463
|
+
# resp.theme_version_summary_list[0].created_time #=> Time
|
4464
|
+
# resp.theme_version_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
3211
4465
|
# resp.next_token #=> String
|
3212
4466
|
# resp.status #=> Integer
|
3213
4467
|
# resp.request_id #=> String
|
3214
4468
|
#
|
3215
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
4469
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListThemeVersions AWS API Documentation
|
3216
4470
|
#
|
3217
|
-
# @overload
|
4471
|
+
# @overload list_theme_versions(params = {})
|
3218
4472
|
# @param [Hash] params ({})
|
3219
|
-
def
|
3220
|
-
req = build_request(:
|
4473
|
+
def list_theme_versions(params = {}, options = {})
|
4474
|
+
req = build_request(:list_theme_versions, params)
|
3221
4475
|
req.send_request(options)
|
3222
4476
|
end
|
3223
4477
|
|
3224
|
-
# Lists all the
|
4478
|
+
# Lists all the themes in the current AWS account.
|
3225
4479
|
#
|
3226
4480
|
# @option params [required, String] :aws_account_id
|
3227
|
-
# The ID of the AWS account that contains the
|
4481
|
+
# The ID of the AWS account that contains the themes that you're
|
3228
4482
|
# listing.
|
3229
4483
|
#
|
3230
4484
|
# @option params [String] :next_token
|
@@ -3234,42 +4488,53 @@ module Aws::QuickSight
|
|
3234
4488
|
# @option params [Integer] :max_results
|
3235
4489
|
# The maximum number of results to be returned per request.
|
3236
4490
|
#
|
3237
|
-
# @
|
4491
|
+
# @option params [String] :type
|
4492
|
+
# The type of themes that you want to list. Valid options include the
|
4493
|
+
# following:
|
3238
4494
|
#
|
3239
|
-
# *
|
3240
|
-
# * {Types::ListTemplatesResponse#next_token #next_token} => String
|
3241
|
-
# * {Types::ListTemplatesResponse#status #status} => Integer
|
3242
|
-
# * {Types::ListTemplatesResponse#request_id #request_id} => String
|
4495
|
+
# * `ALL (default)`- Display all existing themes.
|
3243
4496
|
#
|
3244
|
-
#
|
4497
|
+
# * `CUSTOM` - Display only the themes created by people using Amazon
|
4498
|
+
# QuickSight.
|
4499
|
+
#
|
4500
|
+
# * `QUICKSIGHT` - Display only the starting themes defined by
|
4501
|
+
# QuickSight.
|
4502
|
+
#
|
4503
|
+
# @return [Types::ListThemesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4504
|
+
#
|
4505
|
+
# * {Types::ListThemesResponse#theme_summary_list #theme_summary_list} => Array<Types::ThemeSummary>
|
4506
|
+
# * {Types::ListThemesResponse#next_token #next_token} => String
|
4507
|
+
# * {Types::ListThemesResponse#status #status} => Integer
|
4508
|
+
# * {Types::ListThemesResponse#request_id #request_id} => String
|
3245
4509
|
#
|
3246
4510
|
# @example Request syntax with placeholder values
|
3247
4511
|
#
|
3248
|
-
# resp = client.
|
4512
|
+
# resp = client.list_themes({
|
3249
4513
|
# aws_account_id: "AwsAccountId", # required
|
3250
4514
|
# next_token: "String",
|
3251
4515
|
# max_results: 1,
|
4516
|
+
# type: "QUICKSIGHT", # accepts QUICKSIGHT, CUSTOM, ALL
|
3252
4517
|
# })
|
3253
4518
|
#
|
3254
4519
|
# @example Response structure
|
3255
4520
|
#
|
3256
|
-
# resp.
|
3257
|
-
# resp.
|
3258
|
-
# resp.
|
3259
|
-
# resp.
|
3260
|
-
# resp.
|
3261
|
-
# resp.
|
3262
|
-
# resp.
|
4521
|
+
# resp.theme_summary_list #=> Array
|
4522
|
+
# resp.theme_summary_list[0].arn #=> String
|
4523
|
+
# resp.theme_summary_list[0].name #=> String
|
4524
|
+
# resp.theme_summary_list[0].theme_id #=> String
|
4525
|
+
# resp.theme_summary_list[0].latest_version_number #=> Integer
|
4526
|
+
# resp.theme_summary_list[0].created_time #=> Time
|
4527
|
+
# resp.theme_summary_list[0].last_updated_time #=> Time
|
3263
4528
|
# resp.next_token #=> String
|
3264
4529
|
# resp.status #=> Integer
|
3265
4530
|
# resp.request_id #=> String
|
3266
4531
|
#
|
3267
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
4532
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListThemes AWS API Documentation
|
3268
4533
|
#
|
3269
|
-
# @overload
|
4534
|
+
# @overload list_themes(params = {})
|
3270
4535
|
# @param [Hash] params ({})
|
3271
|
-
def
|
3272
|
-
req = build_request(:
|
4536
|
+
def list_themes(params = {}, options = {})
|
4537
|
+
req = build_request(:list_themes, params)
|
3273
4538
|
req.send_request(options)
|
3274
4539
|
end
|
3275
4540
|
|
@@ -3372,6 +4637,7 @@ module Aws::QuickSight
|
|
3372
4637
|
# resp.user_list[0].identity_type #=> String, one of "IAM", "QUICKSIGHT"
|
3373
4638
|
# resp.user_list[0].active #=> Boolean
|
3374
4639
|
# resp.user_list[0].principal_id #=> String
|
4640
|
+
# resp.user_list[0].custom_permissions_name #=> String
|
3375
4641
|
# resp.next_token #=> String
|
3376
4642
|
# resp.request_id #=> String
|
3377
4643
|
# resp.status #=> Integer
|
@@ -3445,6 +4711,30 @@ module Aws::QuickSight
|
|
3445
4711
|
# The Amazon QuickSight user name that you want to create for the user
|
3446
4712
|
# you are registering.
|
3447
4713
|
#
|
4714
|
+
# @option params [String] :custom_permissions_name
|
4715
|
+
# (Enterprise edition only) The name of the custom permissions profile
|
4716
|
+
# that you want to assign to this user. Currently, custom permissions
|
4717
|
+
# profile names are assigned to permissions profiles in the QuickSight
|
4718
|
+
# console. You use this API to assign the named set of permissions to a
|
4719
|
+
# QuickSight user.
|
4720
|
+
#
|
4721
|
+
# Customizing permissions in the QuickSight UI allows you to control a
|
4722
|
+
# user's access to the following operations:
|
4723
|
+
#
|
4724
|
+
# *
|
4725
|
+
# *
|
4726
|
+
# *
|
4727
|
+
# *
|
4728
|
+
#
|
4729
|
+
# QuickSight custom permissions are applied through IAM policies.
|
4730
|
+
# Therefore, they override the permissions typically granted by
|
4731
|
+
# assigning QuickSight users to one of the default security cohorts
|
4732
|
+
# (admin, author, reader) in QuickSight.
|
4733
|
+
#
|
4734
|
+
# This feature is available only to QuickSight Enterprise edition
|
4735
|
+
# subscriptions that use SAML 2.0-Based Federation for Single Sign-On
|
4736
|
+
# (SSO).
|
4737
|
+
#
|
3448
4738
|
# @return [Types::RegisterUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3449
4739
|
#
|
3450
4740
|
# * {Types::RegisterUserResponse#user #user} => Types::User
|
@@ -3463,6 +4753,7 @@ module Aws::QuickSight
|
|
3463
4753
|
# aws_account_id: "AwsAccountId", # required
|
3464
4754
|
# namespace: "Namespace", # required
|
3465
4755
|
# user_name: "UserName",
|
4756
|
+
# custom_permissions_name: "RoleName",
|
3466
4757
|
# })
|
3467
4758
|
#
|
3468
4759
|
# @example Response structure
|
@@ -3474,6 +4765,7 @@ module Aws::QuickSight
|
|
3474
4765
|
# resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
|
3475
4766
|
# resp.user.active #=> Boolean
|
3476
4767
|
# resp.user.principal_id #=> String
|
4768
|
+
# resp.user.custom_permissions_name #=> String
|
3477
4769
|
# resp.user_invitation_url #=> String
|
3478
4770
|
# resp.request_id #=> String
|
3479
4771
|
# resp.status #=> Integer
|
@@ -3495,7 +4787,7 @@ module Aws::QuickSight
|
|
3495
4787
|
#
|
3496
4788
|
# @option params [required, Array<Types::DashboardSearchFilter>] :filters
|
3497
4789
|
# The filters to apply to the search. Currently, you can search only by
|
3498
|
-
# user name
|
4790
|
+
# user name, for example, `"Filters": [ \{ "Name": "QUICKSIGHT_USER",
|
3499
4791
|
# "Operator": "StringEquals", "Value":
|
3500
4792
|
# "arn:aws:quicksight:us-east-1:1:user/default/UserName1" \} ]`
|
3501
4793
|
#
|
@@ -3651,6 +4943,97 @@ module Aws::QuickSight
|
|
3651
4943
|
req.send_request(options)
|
3652
4944
|
end
|
3653
4945
|
|
4946
|
+
# Updates customizations associated with the QuickSight subscription on
|
4947
|
+
# your AWS account.
|
4948
|
+
#
|
4949
|
+
# @option params [required, String] :aws_account_id
|
4950
|
+
# The ID for the AWS account that you want to update QuickSight
|
4951
|
+
# customizations for.
|
4952
|
+
#
|
4953
|
+
# @option params [String] :namespace
|
4954
|
+
# The namespace associated with the customization that you're updating.
|
4955
|
+
#
|
4956
|
+
# @option params [required, Types::AccountCustomization] :account_customization
|
4957
|
+
# The customizations you want to update in QuickSight.
|
4958
|
+
#
|
4959
|
+
# @return [Types::UpdateAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4960
|
+
#
|
4961
|
+
# * {Types::UpdateAccountCustomizationResponse#aws_account_id #aws_account_id} => String
|
4962
|
+
# * {Types::UpdateAccountCustomizationResponse#namespace #namespace} => String
|
4963
|
+
# * {Types::UpdateAccountCustomizationResponse#account_customization #account_customization} => Types::AccountCustomization
|
4964
|
+
# * {Types::UpdateAccountCustomizationResponse#request_id #request_id} => String
|
4965
|
+
# * {Types::UpdateAccountCustomizationResponse#status #status} => Integer
|
4966
|
+
#
|
4967
|
+
# @example Request syntax with placeholder values
|
4968
|
+
#
|
4969
|
+
# resp = client.update_account_customization({
|
4970
|
+
# aws_account_id: "AwsAccountId", # required
|
4971
|
+
# namespace: "Namespace",
|
4972
|
+
# account_customization: { # required
|
4973
|
+
# default_theme: "Arn",
|
4974
|
+
# },
|
4975
|
+
# })
|
4976
|
+
#
|
4977
|
+
# @example Response structure
|
4978
|
+
#
|
4979
|
+
# resp.aws_account_id #=> String
|
4980
|
+
# resp.namespace #=> String
|
4981
|
+
# resp.account_customization.default_theme #=> String
|
4982
|
+
# resp.request_id #=> String
|
4983
|
+
# resp.status #=> Integer
|
4984
|
+
#
|
4985
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomization AWS API Documentation
|
4986
|
+
#
|
4987
|
+
# @overload update_account_customization(params = {})
|
4988
|
+
# @param [Hash] params ({})
|
4989
|
+
def update_account_customization(params = {}, options = {})
|
4990
|
+
req = build_request(:update_account_customization, params)
|
4991
|
+
req.send_request(options)
|
4992
|
+
end
|
4993
|
+
|
4994
|
+
# Updates the settings for the Amazon QuickSight subscription in your
|
4995
|
+
# AWS Account.
|
4996
|
+
#
|
4997
|
+
# @option params [required, String] :aws_account_id
|
4998
|
+
# The ID for the AWS account that contains the QuickSight namespaces
|
4999
|
+
# that you want to list.
|
5000
|
+
#
|
5001
|
+
# @option params [required, String] :default_namespace
|
5002
|
+
# The default namespace for this AWS Account. Currently, the default is
|
5003
|
+
# `default`. IAM users who register for the first time with QuickSight
|
5004
|
+
# provide an email that becomes associated with the default namespace.
|
5005
|
+
#
|
5006
|
+
# @option params [String] :notification_email
|
5007
|
+
# Email address used to send notifications regarding administration of
|
5008
|
+
# QuickSight.
|
5009
|
+
#
|
5010
|
+
# @return [Types::UpdateAccountSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5011
|
+
#
|
5012
|
+
# * {Types::UpdateAccountSettingsResponse#request_id #request_id} => String
|
5013
|
+
# * {Types::UpdateAccountSettingsResponse#status #status} => Integer
|
5014
|
+
#
|
5015
|
+
# @example Request syntax with placeholder values
|
5016
|
+
#
|
5017
|
+
# resp = client.update_account_settings({
|
5018
|
+
# aws_account_id: "AwsAccountId", # required
|
5019
|
+
# default_namespace: "Namespace", # required
|
5020
|
+
# notification_email: "String",
|
5021
|
+
# })
|
5022
|
+
#
|
5023
|
+
# @example Response structure
|
5024
|
+
#
|
5025
|
+
# resp.request_id #=> String
|
5026
|
+
# resp.status #=> Integer
|
5027
|
+
#
|
5028
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountSettings AWS API Documentation
|
5029
|
+
#
|
5030
|
+
# @overload update_account_settings(params = {})
|
5031
|
+
# @param [Hash] params ({})
|
5032
|
+
def update_account_settings(params = {}, options = {})
|
5033
|
+
req = build_request(:update_account_settings, params)
|
5034
|
+
req.send_request(options)
|
5035
|
+
end
|
5036
|
+
|
3654
5037
|
# Updates a dashboard in an AWS account.
|
3655
5038
|
#
|
3656
5039
|
# @option params [required, String] :aws_account_id
|
@@ -3664,15 +5047,24 @@ module Aws::QuickSight
|
|
3664
5047
|
# The display name of the dashboard.
|
3665
5048
|
#
|
3666
5049
|
# @option params [required, Types::DashboardSourceEntity] :source_entity
|
3667
|
-
# The
|
3668
|
-
# `
|
3669
|
-
#
|
3670
|
-
#
|
3671
|
-
#
|
3672
|
-
#
|
5050
|
+
# The entity that you are using as a source when you update the
|
5051
|
+
# dashboard. In `SourceEntity`, you specify the type of object you're
|
5052
|
+
# using as source. You can only update a dashboard from a template, so
|
5053
|
+
# you use a `SourceTemplate` entity. If you need to update a dashboard
|
5054
|
+
# from an analysis, first convert the analysis to a template by using
|
5055
|
+
# the CreateTemplate API operation. For `SourceTemplate`, specify the
|
5056
|
+
# Amazon Resource Name (ARN) of the source template. The
|
5057
|
+
# `SourceTemplate` ARN can contain any AWS Account and any
|
5058
|
+
# QuickSight-supported AWS Region.
|
5059
|
+
#
|
5060
|
+
# Use the `DataSetReferences` entity within `SourceTemplate` to list the
|
5061
|
+
# replacement datasets for the placeholders listed in the original. The
|
5062
|
+
# schema in each dataset must match its placeholder.
|
3673
5063
|
#
|
3674
5064
|
# @option params [Types::Parameters] :parameters
|
3675
|
-
# A structure that contains the parameters of the dashboard.
|
5065
|
+
# A structure that contains the parameters of the dashboard. These are
|
5066
|
+
# parameter overrides for a dashboard. A dashboard can have any type of
|
5067
|
+
# parameters, and some parameters might accept multiple values.
|
3676
5068
|
#
|
3677
5069
|
# @option params [String] :version_description
|
3678
5070
|
# A description for the first version of the dashboard being created.
|
@@ -3692,9 +5084,14 @@ module Aws::QuickSight
|
|
3692
5084
|
# option is `ENABLED` by default.
|
3693
5085
|
#
|
3694
5086
|
# * `VisibilityState` for `SheetControlsOption` - This visibility state
|
3695
|
-
# can be either `COLLAPSED` or `EXPANDED`.
|
3696
|
-
#
|
3697
|
-
#
|
5087
|
+
# can be either `COLLAPSED` or `EXPANDED`. This option is `COLLAPSED`
|
5088
|
+
# by default.
|
5089
|
+
#
|
5090
|
+
# @option params [String] :theme_arn
|
5091
|
+
# The Amazon Resource Name (ARN) of the theme that is being used for
|
5092
|
+
# this dashboard. If you add a value for this field, it overrides the
|
5093
|
+
# value that was originally associated with the entity. The theme ARN
|
5094
|
+
# must exist in the same AWS account where you create the dashboard.
|
3698
5095
|
#
|
3699
5096
|
# @return [Types::UpdateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3700
5097
|
#
|
@@ -3760,6 +5157,7 @@ module Aws::QuickSight
|
|
3760
5157
|
# visibility_state: "EXPANDED", # accepts EXPANDED, COLLAPSED
|
3761
5158
|
# },
|
3762
5159
|
# },
|
5160
|
+
# theme_arn: "Arn",
|
3763
5161
|
# })
|
3764
5162
|
#
|
3765
5163
|
# @example Response structure
|
@@ -4033,6 +5431,7 @@ module Aws::QuickSight
|
|
4033
5431
|
# },
|
4034
5432
|
# ],
|
4035
5433
|
# row_level_permission_data_set: {
|
5434
|
+
# namespace: "Namespace",
|
4036
5435
|
# arn: "Arn", # required
|
4037
5436
|
# permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
|
4038
5437
|
# },
|
@@ -4249,7 +5648,96 @@ module Aws::QuickSight
|
|
4249
5648
|
# credential_pair: {
|
4250
5649
|
# username: "Username", # required
|
4251
5650
|
# password: "Password", # required
|
5651
|
+
# alternate_data_source_parameters: [
|
5652
|
+
# {
|
5653
|
+
# amazon_elasticsearch_parameters: {
|
5654
|
+
# domain: "Domain", # required
|
5655
|
+
# },
|
5656
|
+
# athena_parameters: {
|
5657
|
+
# work_group: "WorkGroup",
|
5658
|
+
# },
|
5659
|
+
# aurora_parameters: {
|
5660
|
+
# host: "Host", # required
|
5661
|
+
# port: 1, # required
|
5662
|
+
# database: "Database", # required
|
5663
|
+
# },
|
5664
|
+
# aurora_postgre_sql_parameters: {
|
5665
|
+
# host: "Host", # required
|
5666
|
+
# port: 1, # required
|
5667
|
+
# database: "Database", # required
|
5668
|
+
# },
|
5669
|
+
# aws_iot_analytics_parameters: {
|
5670
|
+
# data_set_name: "DataSetName", # required
|
5671
|
+
# },
|
5672
|
+
# jira_parameters: {
|
5673
|
+
# site_base_url: "SiteBaseUrl", # required
|
5674
|
+
# },
|
5675
|
+
# maria_db_parameters: {
|
5676
|
+
# host: "Host", # required
|
5677
|
+
# port: 1, # required
|
5678
|
+
# database: "Database", # required
|
5679
|
+
# },
|
5680
|
+
# my_sql_parameters: {
|
5681
|
+
# host: "Host", # required
|
5682
|
+
# port: 1, # required
|
5683
|
+
# database: "Database", # required
|
5684
|
+
# },
|
5685
|
+
# postgre_sql_parameters: {
|
5686
|
+
# host: "Host", # required
|
5687
|
+
# port: 1, # required
|
5688
|
+
# database: "Database", # required
|
5689
|
+
# },
|
5690
|
+
# presto_parameters: {
|
5691
|
+
# host: "Host", # required
|
5692
|
+
# port: 1, # required
|
5693
|
+
# catalog: "Catalog", # required
|
5694
|
+
# },
|
5695
|
+
# rds_parameters: {
|
5696
|
+
# instance_id: "InstanceId", # required
|
5697
|
+
# database: "Database", # required
|
5698
|
+
# },
|
5699
|
+
# redshift_parameters: {
|
5700
|
+
# host: "Host",
|
5701
|
+
# port: 1,
|
5702
|
+
# database: "Database", # required
|
5703
|
+
# cluster_id: "ClusterId",
|
5704
|
+
# },
|
5705
|
+
# s3_parameters: {
|
5706
|
+
# manifest_file_location: { # required
|
5707
|
+
# bucket: "S3Bucket", # required
|
5708
|
+
# key: "S3Key", # required
|
5709
|
+
# },
|
5710
|
+
# },
|
5711
|
+
# service_now_parameters: {
|
5712
|
+
# site_base_url: "SiteBaseUrl", # required
|
5713
|
+
# },
|
5714
|
+
# snowflake_parameters: {
|
5715
|
+
# host: "Host", # required
|
5716
|
+
# database: "Database", # required
|
5717
|
+
# warehouse: "Warehouse", # required
|
5718
|
+
# },
|
5719
|
+
# spark_parameters: {
|
5720
|
+
# host: "Host", # required
|
5721
|
+
# port: 1, # required
|
5722
|
+
# },
|
5723
|
+
# sql_server_parameters: {
|
5724
|
+
# host: "Host", # required
|
5725
|
+
# port: 1, # required
|
5726
|
+
# database: "Database", # required
|
5727
|
+
# },
|
5728
|
+
# teradata_parameters: {
|
5729
|
+
# host: "Host", # required
|
5730
|
+
# port: 1, # required
|
5731
|
+
# database: "Database", # required
|
5732
|
+
# },
|
5733
|
+
# twitter_parameters: {
|
5734
|
+
# query: "Query", # required
|
5735
|
+
# max_rows: 1, # required
|
5736
|
+
# },
|
5737
|
+
# },
|
5738
|
+
# ],
|
4252
5739
|
# },
|
5740
|
+
# copy_source_arn: "CopySourceArn",
|
4253
5741
|
# },
|
4254
5742
|
# vpc_connection_properties: {
|
4255
5743
|
# vpc_connection_arn: "Arn", # required
|
@@ -4473,9 +5961,19 @@ module Aws::QuickSight
|
|
4473
5961
|
# The ID for the template.
|
4474
5962
|
#
|
4475
5963
|
# @option params [required, Types::TemplateSourceEntity] :source_entity
|
4476
|
-
# The
|
4477
|
-
#
|
4478
|
-
#
|
5964
|
+
# The entity that you are using as a source when you update the
|
5965
|
+
# template. In `SourceEntity`, you specify the type of object you're
|
5966
|
+
# using as source: `SourceTemplate` for a template or `SourceAnalysis`
|
5967
|
+
# for an analysis. Both of these require an Amazon Resource Name (ARN).
|
5968
|
+
# For `SourceTemplate`, specify the ARN of the source template. For
|
5969
|
+
# `SourceAnalysis`, specify the ARN of the source analysis. The
|
5970
|
+
# `SourceTemplate` ARN can contain any AWS Account and any
|
5971
|
+
# QuickSight-supported AWS Region.
|
5972
|
+
#
|
5973
|
+
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
5974
|
+
# `SourceAnalysis` to list the replacement datasets for the placeholders
|
5975
|
+
# listed in the original. The schema in each dataset must match its
|
5976
|
+
# placeholder.
|
4479
5977
|
#
|
4480
5978
|
# @option params [String] :version_description
|
4481
5979
|
# A description of the current template version that is being updated.
|
@@ -4648,6 +6146,259 @@ module Aws::QuickSight
|
|
4648
6146
|
req.send_request(options)
|
4649
6147
|
end
|
4650
6148
|
|
6149
|
+
# Updates a theme.
|
6150
|
+
#
|
6151
|
+
# @option params [required, String] :aws_account_id
|
6152
|
+
# The ID of the AWS account that contains the theme that you're
|
6153
|
+
# updating.
|
6154
|
+
#
|
6155
|
+
# @option params [required, String] :theme_id
|
6156
|
+
# The ID for the theme.
|
6157
|
+
#
|
6158
|
+
# @option params [String] :name
|
6159
|
+
# The name for the theme.
|
6160
|
+
#
|
6161
|
+
# @option params [required, String] :base_theme_id
|
6162
|
+
# The theme ID, defined by Amazon QuickSight, that a custom theme
|
6163
|
+
# inherits from. All themes initially inherit from a default QuickSight
|
6164
|
+
# theme.
|
6165
|
+
#
|
6166
|
+
# @option params [String] :version_description
|
6167
|
+
# A description of the theme version that you're updating Every time
|
6168
|
+
# that you call `UpdateTheme`, you create a new version of the theme.
|
6169
|
+
# Each version of the theme maintains a description of the version in
|
6170
|
+
# `VersionDescription`.
|
6171
|
+
#
|
6172
|
+
# @option params [Types::ThemeConfiguration] :configuration
|
6173
|
+
# The theme configuration, which contains the theme display properties.
|
6174
|
+
#
|
6175
|
+
# @return [Types::UpdateThemeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6176
|
+
#
|
6177
|
+
# * {Types::UpdateThemeResponse#theme_id #theme_id} => String
|
6178
|
+
# * {Types::UpdateThemeResponse#arn #arn} => String
|
6179
|
+
# * {Types::UpdateThemeResponse#version_arn #version_arn} => String
|
6180
|
+
# * {Types::UpdateThemeResponse#creation_status #creation_status} => String
|
6181
|
+
# * {Types::UpdateThemeResponse#status #status} => Integer
|
6182
|
+
# * {Types::UpdateThemeResponse#request_id #request_id} => String
|
6183
|
+
#
|
6184
|
+
# @example Request syntax with placeholder values
|
6185
|
+
#
|
6186
|
+
# resp = client.update_theme({
|
6187
|
+
# aws_account_id: "AwsAccountId", # required
|
6188
|
+
# theme_id: "RestrictiveResourceId", # required
|
6189
|
+
# name: "ThemeName",
|
6190
|
+
# base_theme_id: "RestrictiveResourceId", # required
|
6191
|
+
# version_description: "VersionDescription",
|
6192
|
+
# configuration: {
|
6193
|
+
# data_color_palette: {
|
6194
|
+
# colors: ["HexColor"],
|
6195
|
+
# min_max_gradient: ["HexColor"],
|
6196
|
+
# empty_fill_color: "HexColor",
|
6197
|
+
# },
|
6198
|
+
# ui_color_palette: {
|
6199
|
+
# primary_foreground: "HexColor",
|
6200
|
+
# primary_background: "HexColor",
|
6201
|
+
# secondary_foreground: "HexColor",
|
6202
|
+
# secondary_background: "HexColor",
|
6203
|
+
# accent: "HexColor",
|
6204
|
+
# accent_foreground: "HexColor",
|
6205
|
+
# danger: "HexColor",
|
6206
|
+
# danger_foreground: "HexColor",
|
6207
|
+
# warning: "HexColor",
|
6208
|
+
# warning_foreground: "HexColor",
|
6209
|
+
# success: "HexColor",
|
6210
|
+
# success_foreground: "HexColor",
|
6211
|
+
# dimension: "HexColor",
|
6212
|
+
# dimension_foreground: "HexColor",
|
6213
|
+
# measure: "HexColor",
|
6214
|
+
# measure_foreground: "HexColor",
|
6215
|
+
# },
|
6216
|
+
# sheet: {
|
6217
|
+
# tile: {
|
6218
|
+
# border: {
|
6219
|
+
# show: false,
|
6220
|
+
# },
|
6221
|
+
# },
|
6222
|
+
# tile_layout: {
|
6223
|
+
# gutter: {
|
6224
|
+
# show: false,
|
6225
|
+
# },
|
6226
|
+
# margin: {
|
6227
|
+
# show: false,
|
6228
|
+
# },
|
6229
|
+
# },
|
6230
|
+
# },
|
6231
|
+
# },
|
6232
|
+
# })
|
6233
|
+
#
|
6234
|
+
# @example Response structure
|
6235
|
+
#
|
6236
|
+
# resp.theme_id #=> String
|
6237
|
+
# resp.arn #=> String
|
6238
|
+
# resp.version_arn #=> String
|
6239
|
+
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
6240
|
+
# resp.status #=> Integer
|
6241
|
+
# resp.request_id #=> String
|
6242
|
+
#
|
6243
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateTheme AWS API Documentation
|
6244
|
+
#
|
6245
|
+
# @overload update_theme(params = {})
|
6246
|
+
# @param [Hash] params ({})
|
6247
|
+
def update_theme(params = {}, options = {})
|
6248
|
+
req = build_request(:update_theme, params)
|
6249
|
+
req.send_request(options)
|
6250
|
+
end
|
6251
|
+
|
6252
|
+
# Updates an alias of a theme.
|
6253
|
+
#
|
6254
|
+
# @option params [required, String] :aws_account_id
|
6255
|
+
# The ID of the AWS account that contains the theme alias that you're
|
6256
|
+
# updating.
|
6257
|
+
#
|
6258
|
+
# @option params [required, String] :theme_id
|
6259
|
+
# The ID for the theme.
|
6260
|
+
#
|
6261
|
+
# @option params [required, String] :alias_name
|
6262
|
+
# The name of the theme alias that you want to update.
|
6263
|
+
#
|
6264
|
+
# @option params [required, Integer] :theme_version_number
|
6265
|
+
# The version number of the theme that the alias should reference.
|
6266
|
+
#
|
6267
|
+
# @return [Types::UpdateThemeAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6268
|
+
#
|
6269
|
+
# * {Types::UpdateThemeAliasResponse#theme_alias #theme_alias} => Types::ThemeAlias
|
6270
|
+
# * {Types::UpdateThemeAliasResponse#status #status} => Integer
|
6271
|
+
# * {Types::UpdateThemeAliasResponse#request_id #request_id} => String
|
6272
|
+
#
|
6273
|
+
# @example Request syntax with placeholder values
|
6274
|
+
#
|
6275
|
+
# resp = client.update_theme_alias({
|
6276
|
+
# aws_account_id: "AwsAccountId", # required
|
6277
|
+
# theme_id: "RestrictiveResourceId", # required
|
6278
|
+
# alias_name: "AliasName", # required
|
6279
|
+
# theme_version_number: 1, # required
|
6280
|
+
# })
|
6281
|
+
#
|
6282
|
+
# @example Response structure
|
6283
|
+
#
|
6284
|
+
# resp.theme_alias.arn #=> String
|
6285
|
+
# resp.theme_alias.alias_name #=> String
|
6286
|
+
# resp.theme_alias.theme_version_number #=> Integer
|
6287
|
+
# resp.status #=> Integer
|
6288
|
+
# resp.request_id #=> String
|
6289
|
+
#
|
6290
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateThemeAlias AWS API Documentation
|
6291
|
+
#
|
6292
|
+
# @overload update_theme_alias(params = {})
|
6293
|
+
# @param [Hash] params ({})
|
6294
|
+
def update_theme_alias(params = {}, options = {})
|
6295
|
+
req = build_request(:update_theme_alias, params)
|
6296
|
+
req.send_request(options)
|
6297
|
+
end
|
6298
|
+
|
6299
|
+
# Updates the resource permissions for a theme. Permissions apply to the
|
6300
|
+
# action to grant or revoke permissions on, for example
|
6301
|
+
# `"quicksight:DescribeTheme"`.
|
6302
|
+
#
|
6303
|
+
# Theme permissions apply in groupings. Valid groupings include the
|
6304
|
+
# following for the three levels of permissions, which are user, owner,
|
6305
|
+
# or no permissions:
|
6306
|
+
#
|
6307
|
+
# * User
|
6308
|
+
#
|
6309
|
+
# * `"quicksight:DescribeTheme"`
|
6310
|
+
#
|
6311
|
+
# * `"quicksight:DescribeThemeAlias"`
|
6312
|
+
#
|
6313
|
+
# * `"quicksight:ListThemeAliases"`
|
6314
|
+
#
|
6315
|
+
# * `"quicksight:ListThemeVersions"`
|
6316
|
+
#
|
6317
|
+
# * Owner
|
6318
|
+
#
|
6319
|
+
# * `"quicksight:DescribeTheme"`
|
6320
|
+
#
|
6321
|
+
# * `"quicksight:DescribeThemeAlias"`
|
6322
|
+
#
|
6323
|
+
# * `"quicksight:ListThemeAliases"`
|
6324
|
+
#
|
6325
|
+
# * `"quicksight:ListThemeVersions"`
|
6326
|
+
#
|
6327
|
+
# * `"quicksight:DeleteTheme"`
|
6328
|
+
#
|
6329
|
+
# * `"quicksight:UpdateTheme"`
|
6330
|
+
#
|
6331
|
+
# * `"quicksight:CreateThemeAlias"`
|
6332
|
+
#
|
6333
|
+
# * `"quicksight:DeleteThemeAlias"`
|
6334
|
+
#
|
6335
|
+
# * `"quicksight:UpdateThemeAlias"`
|
6336
|
+
#
|
6337
|
+
# * `"quicksight:UpdateThemePermissions"`
|
6338
|
+
#
|
6339
|
+
# * `"quicksight:DescribeThemePermissions"`
|
6340
|
+
#
|
6341
|
+
# * To specify no permissions, omit the permissions list.
|
6342
|
+
#
|
6343
|
+
# @option params [required, String] :aws_account_id
|
6344
|
+
# The ID of the AWS account that contains the theme.
|
6345
|
+
#
|
6346
|
+
# @option params [required, String] :theme_id
|
6347
|
+
# The ID for the theme.
|
6348
|
+
#
|
6349
|
+
# @option params [Array<Types::ResourcePermission>] :grant_permissions
|
6350
|
+
# A list of resource permissions to be granted for the theme.
|
6351
|
+
#
|
6352
|
+
# @option params [Array<Types::ResourcePermission>] :revoke_permissions
|
6353
|
+
# A list of resource permissions to be revoked from the theme.
|
6354
|
+
#
|
6355
|
+
# @return [Types::UpdateThemePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6356
|
+
#
|
6357
|
+
# * {Types::UpdateThemePermissionsResponse#theme_id #theme_id} => String
|
6358
|
+
# * {Types::UpdateThemePermissionsResponse#theme_arn #theme_arn} => String
|
6359
|
+
# * {Types::UpdateThemePermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission>
|
6360
|
+
# * {Types::UpdateThemePermissionsResponse#request_id #request_id} => String
|
6361
|
+
# * {Types::UpdateThemePermissionsResponse#status #status} => Integer
|
6362
|
+
#
|
6363
|
+
# @example Request syntax with placeholder values
|
6364
|
+
#
|
6365
|
+
# resp = client.update_theme_permissions({
|
6366
|
+
# aws_account_id: "AwsAccountId", # required
|
6367
|
+
# theme_id: "RestrictiveResourceId", # required
|
6368
|
+
# grant_permissions: [
|
6369
|
+
# {
|
6370
|
+
# principal: "Principal", # required
|
6371
|
+
# actions: ["String"], # required
|
6372
|
+
# },
|
6373
|
+
# ],
|
6374
|
+
# revoke_permissions: [
|
6375
|
+
# {
|
6376
|
+
# principal: "Principal", # required
|
6377
|
+
# actions: ["String"], # required
|
6378
|
+
# },
|
6379
|
+
# ],
|
6380
|
+
# })
|
6381
|
+
#
|
6382
|
+
# @example Response structure
|
6383
|
+
#
|
6384
|
+
# resp.theme_id #=> String
|
6385
|
+
# resp.theme_arn #=> String
|
6386
|
+
# resp.permissions #=> Array
|
6387
|
+
# resp.permissions[0].principal #=> String
|
6388
|
+
# resp.permissions[0].actions #=> Array
|
6389
|
+
# resp.permissions[0].actions[0] #=> String
|
6390
|
+
# resp.request_id #=> String
|
6391
|
+
# resp.status #=> Integer
|
6392
|
+
#
|
6393
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateThemePermissions AWS API Documentation
|
6394
|
+
#
|
6395
|
+
# @overload update_theme_permissions(params = {})
|
6396
|
+
# @param [Hash] params ({})
|
6397
|
+
def update_theme_permissions(params = {}, options = {})
|
6398
|
+
req = build_request(:update_theme_permissions, params)
|
6399
|
+
req.send_request(options)
|
6400
|
+
end
|
6401
|
+
|
4651
6402
|
# Updates an Amazon QuickSight user.
|
4652
6403
|
#
|
4653
6404
|
# @option params [required, String] :user_name
|
@@ -4675,6 +6426,19 @@ module Aws::QuickSight
|
|
4675
6426
|
# * `ADMIN`\: A user who is an author, who can also manage Amazon
|
4676
6427
|
# QuickSight settings.
|
4677
6428
|
#
|
6429
|
+
# @option params [String] :custom_permissions_name
|
6430
|
+
# The name of the custom permissions profile that you want to assign to
|
6431
|
+
# this user. Currently, custom permissions profile names are assigned to
|
6432
|
+
# permissions profiles in the QuickSight console. You use this API to
|
6433
|
+
# assign the named set of permissions to a QuickSight user.
|
6434
|
+
#
|
6435
|
+
# @option params [Boolean] :unapply_custom_permissions
|
6436
|
+
# A flag that you use to indicate that you want to remove all custom
|
6437
|
+
# permissions from this user. Using this parameter resets the user to
|
6438
|
+
# the state it was in before a custom permissions profile was applied.
|
6439
|
+
# This parameter defaults to NULL and it doesn't accept any other
|
6440
|
+
# value.
|
6441
|
+
#
|
4678
6442
|
# @return [Types::UpdateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4679
6443
|
#
|
4680
6444
|
# * {Types::UpdateUserResponse#user #user} => Types::User
|
@@ -4689,6 +6453,8 @@ module Aws::QuickSight
|
|
4689
6453
|
# namespace: "Namespace", # required
|
4690
6454
|
# email: "String", # required
|
4691
6455
|
# role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER
|
6456
|
+
# custom_permissions_name: "RoleName",
|
6457
|
+
# unapply_custom_permissions: false,
|
4692
6458
|
# })
|
4693
6459
|
#
|
4694
6460
|
# @example Response structure
|
@@ -4700,6 +6466,7 @@ module Aws::QuickSight
|
|
4700
6466
|
# resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
|
4701
6467
|
# resp.user.active #=> Boolean
|
4702
6468
|
# resp.user.principal_id #=> String
|
6469
|
+
# resp.user.custom_permissions_name #=> String
|
4703
6470
|
# resp.request_id #=> String
|
4704
6471
|
# resp.status #=> Integer
|
4705
6472
|
#
|
@@ -4725,7 +6492,7 @@ module Aws::QuickSight
|
|
4725
6492
|
params: params,
|
4726
6493
|
config: config)
|
4727
6494
|
context[:gem_name] = 'aws-sdk-quicksight'
|
4728
|
-
context[:gem_version] = '1.
|
6495
|
+
context[:gem_version] = '1.26.0'
|
4729
6496
|
Seahorse::Client::Request.new(handlers, context)
|
4730
6497
|
end
|
4731
6498
|
|