aws-sdk-quicksight 1.22.1 → 1.27.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 +2772 -242
- data/lib/aws-sdk-quicksight/client_api.rb +1199 -1
- 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 +4529 -343
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f25c203680ab75e3508f036909369c0c5fce3d70313ab6f34f3ee7ee123d6889
|
4
|
+
data.tar.gz: 2a4ce4e8c5c88cdcf24e8c85e52932eba553571796a97009aafdf67efb09b27f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5c4b503bff6217bd31bf2e886699b321b8489c06dc9169aafa65033505db6bf6bb4de022a2cca5ce4068eca466723772170f422a98b2745133f38afa173da5f5
|
7
|
+
data.tar.gz: 52ba45c2ba1aedeb56db2853a8fb879c1de6c7ee089e92b3e37192cdbf6821efea7bb1587a52036542d69c997d14083e4811c4b49591b1ff56fff06fc497d1f2
|
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.27.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:
|
@@ -352,16 +354,214 @@ module Aws::QuickSight
|
|
352
354
|
req.send_request(options)
|
353
355
|
end
|
354
356
|
|
357
|
+
# Creates Amazon QuickSight customizations the current AWS Region.
|
358
|
+
# Currently, you can add a custom default theme by using the
|
359
|
+
# `CreateAccountCustomization` or `UpdateAccountCustomization` API
|
360
|
+
# operation. To further customize QuickSight by removing QuickSight
|
361
|
+
# sample assets and videos for all new users, see [Customizing
|
362
|
+
# QuickSight][1] in the Amazon QuickSight User Guide.
|
363
|
+
#
|
364
|
+
# You can create customizations for your AWS account or, if you specify
|
365
|
+
# a namespace, for a QuickSight namespace instead. Customizations that
|
366
|
+
# apply to a namespace always override customizations that apply to an
|
367
|
+
# AWS account. To find out which customizations apply, use the
|
368
|
+
# `DescribeAccountCustomization` API operation.
|
369
|
+
#
|
370
|
+
# Before you add a theme as the namespace default, make sure that you
|
371
|
+
# first share the theme with the namespace. If you don't share it with
|
372
|
+
# the namespace, the theme won't be visible to your users even if you
|
373
|
+
# use this API operation to make it the default theme.
|
374
|
+
#
|
375
|
+
#
|
376
|
+
#
|
377
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html
|
378
|
+
#
|
379
|
+
# @option params [required, String] :aws_account_id
|
380
|
+
# The ID for the AWS account that you want to customize QuickSight for.
|
381
|
+
#
|
382
|
+
# @option params [String] :namespace
|
383
|
+
# The QuickSight namespace that you want to add customizations to.
|
384
|
+
#
|
385
|
+
# @option params [required, Types::AccountCustomization] :account_customization
|
386
|
+
# The QuickSight customizations you're adding in the current AWS
|
387
|
+
# Region. You can add these to an AWS account and a QuickSight
|
388
|
+
# namespace.
|
389
|
+
#
|
390
|
+
# For example, you could add a default theme by setting
|
391
|
+
# `AccountCustomization` to the midnight theme: `"AccountCustomization":
|
392
|
+
# \{ "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" \}. `. Or,
|
393
|
+
# you could add a custom theme by specifying `"AccountCustomization": \{
|
394
|
+
# "DefaultTheme":
|
395
|
+
# "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639"
|
396
|
+
# \}`.
|
397
|
+
#
|
398
|
+
# @return [Types::CreateAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
399
|
+
#
|
400
|
+
# * {Types::CreateAccountCustomizationResponse#aws_account_id #aws_account_id} => String
|
401
|
+
# * {Types::CreateAccountCustomizationResponse#namespace #namespace} => String
|
402
|
+
# * {Types::CreateAccountCustomizationResponse#account_customization #account_customization} => Types::AccountCustomization
|
403
|
+
# * {Types::CreateAccountCustomizationResponse#request_id #request_id} => String
|
404
|
+
# * {Types::CreateAccountCustomizationResponse#status #status} => Integer
|
405
|
+
#
|
406
|
+
# @example Request syntax with placeholder values
|
407
|
+
#
|
408
|
+
# resp = client.create_account_customization({
|
409
|
+
# aws_account_id: "AwsAccountId", # required
|
410
|
+
# namespace: "Namespace",
|
411
|
+
# account_customization: { # required
|
412
|
+
# default_theme: "Arn",
|
413
|
+
# },
|
414
|
+
# })
|
415
|
+
#
|
416
|
+
# @example Response structure
|
417
|
+
#
|
418
|
+
# resp.aws_account_id #=> String
|
419
|
+
# resp.namespace #=> String
|
420
|
+
# resp.account_customization.default_theme #=> String
|
421
|
+
# resp.request_id #=> String
|
422
|
+
# resp.status #=> Integer
|
423
|
+
#
|
424
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAccountCustomization AWS API Documentation
|
425
|
+
#
|
426
|
+
# @overload create_account_customization(params = {})
|
427
|
+
# @param [Hash] params ({})
|
428
|
+
def create_account_customization(params = {}, options = {})
|
429
|
+
req = build_request(:create_account_customization, params)
|
430
|
+
req.send_request(options)
|
431
|
+
end
|
432
|
+
|
433
|
+
# Creates an analysis in Amazon QuickSight.
|
434
|
+
#
|
435
|
+
# @option params [required, String] :aws_account_id
|
436
|
+
# The ID of the AWS account where you are creating an analysis.
|
437
|
+
#
|
438
|
+
# @option params [required, String] :analysis_id
|
439
|
+
# The ID for the analysis that you're creating. This ID displays in the
|
440
|
+
# URL of the analysis.
|
441
|
+
#
|
442
|
+
# @option params [required, String] :name
|
443
|
+
# A descriptive name for the analysis that you're creating. This name
|
444
|
+
# displays for the analysis in the QuickSight console.
|
445
|
+
#
|
446
|
+
# @option params [Types::Parameters] :parameters
|
447
|
+
# The parameter names and override values that you want to use. An
|
448
|
+
# analysis can have any parameter type, and some parameters might accept
|
449
|
+
# multiple values.
|
450
|
+
#
|
451
|
+
# @option params [Array<Types::ResourcePermission>] :permissions
|
452
|
+
# A structure that describes the principals and the resource-level
|
453
|
+
# permissions on an analysis. You can use the `Permissions` structure to
|
454
|
+
# grant permissions by providing a list of AWS Identity and Access
|
455
|
+
# Management (IAM) action information for each principal listed by
|
456
|
+
# Amazon Resource Name (ARN).
|
457
|
+
#
|
458
|
+
# To specify no permissions, omit `Permissions`.
|
459
|
+
#
|
460
|
+
# @option params [required, Types::AnalysisSourceEntity] :source_entity
|
461
|
+
# A source entity to use for the analysis that you're creating. This
|
462
|
+
# metadata structure contains details that describe a source template
|
463
|
+
# and one or more datasets.
|
464
|
+
#
|
465
|
+
# @option params [String] :theme_arn
|
466
|
+
# The ARN for the theme to apply to the analysis that you're creating.
|
467
|
+
# To see the theme in the QuickSight console, make sure that you have
|
468
|
+
# access to it.
|
469
|
+
#
|
470
|
+
# @option params [Array<Types::Tag>] :tags
|
471
|
+
# Contains a map of the key-value pairs for the resource tag or tags
|
472
|
+
# assigned to the analysis.
|
473
|
+
#
|
474
|
+
# @return [Types::CreateAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
475
|
+
#
|
476
|
+
# * {Types::CreateAnalysisResponse#arn #arn} => String
|
477
|
+
# * {Types::CreateAnalysisResponse#analysis_id #analysis_id} => String
|
478
|
+
# * {Types::CreateAnalysisResponse#creation_status #creation_status} => String
|
479
|
+
# * {Types::CreateAnalysisResponse#status #status} => Integer
|
480
|
+
# * {Types::CreateAnalysisResponse#request_id #request_id} => String
|
481
|
+
#
|
482
|
+
# @example Request syntax with placeholder values
|
483
|
+
#
|
484
|
+
# resp = client.create_analysis({
|
485
|
+
# aws_account_id: "AwsAccountId", # required
|
486
|
+
# analysis_id: "RestrictiveResourceId", # required
|
487
|
+
# name: "AnalysisName", # required
|
488
|
+
# parameters: {
|
489
|
+
# string_parameters: [
|
490
|
+
# {
|
491
|
+
# name: "NonEmptyString", # required
|
492
|
+
# values: ["String"], # required
|
493
|
+
# },
|
494
|
+
# ],
|
495
|
+
# integer_parameters: [
|
496
|
+
# {
|
497
|
+
# name: "NonEmptyString", # required
|
498
|
+
# values: [1], # required
|
499
|
+
# },
|
500
|
+
# ],
|
501
|
+
# decimal_parameters: [
|
502
|
+
# {
|
503
|
+
# name: "NonEmptyString", # required
|
504
|
+
# values: [1.0], # required
|
505
|
+
# },
|
506
|
+
# ],
|
507
|
+
# date_time_parameters: [
|
508
|
+
# {
|
509
|
+
# name: "NonEmptyString", # required
|
510
|
+
# values: [Time.now], # required
|
511
|
+
# },
|
512
|
+
# ],
|
513
|
+
# },
|
514
|
+
# permissions: [
|
515
|
+
# {
|
516
|
+
# principal: "Principal", # required
|
517
|
+
# actions: ["String"], # required
|
518
|
+
# },
|
519
|
+
# ],
|
520
|
+
# source_entity: { # required
|
521
|
+
# source_template: {
|
522
|
+
# data_set_references: [ # required
|
523
|
+
# {
|
524
|
+
# data_set_placeholder: "NonEmptyString", # required
|
525
|
+
# data_set_arn: "Arn", # required
|
526
|
+
# },
|
527
|
+
# ],
|
528
|
+
# arn: "Arn", # required
|
529
|
+
# },
|
530
|
+
# },
|
531
|
+
# theme_arn: "Arn",
|
532
|
+
# tags: [
|
533
|
+
# {
|
534
|
+
# key: "TagKey", # required
|
535
|
+
# value: "TagValue", # required
|
536
|
+
# },
|
537
|
+
# ],
|
538
|
+
# })
|
539
|
+
#
|
540
|
+
# @example Response structure
|
541
|
+
#
|
542
|
+
# resp.arn #=> String
|
543
|
+
# resp.analysis_id #=> String
|
544
|
+
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
545
|
+
# resp.status #=> Integer
|
546
|
+
# resp.request_id #=> String
|
547
|
+
#
|
548
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAnalysis AWS API Documentation
|
549
|
+
#
|
550
|
+
# @overload create_analysis(params = {})
|
551
|
+
# @param [Hash] params ({})
|
552
|
+
def create_analysis(params = {}, options = {})
|
553
|
+
req = build_request(:create_analysis, params)
|
554
|
+
req.send_request(options)
|
555
|
+
end
|
556
|
+
|
355
557
|
# Creates a dashboard from a template. To first create a template, see
|
356
|
-
# the CreateTemplate API operation.
|
558
|
+
# the ` CreateTemplate ` API operation.
|
357
559
|
#
|
358
560
|
# A dashboard is an entity in QuickSight that identifies QuickSight
|
359
561
|
# reports, created from analyses. You can share QuickSight dashboards.
|
360
562
|
# With the right permissions, you can create scheduled email reports
|
361
|
-
# from them.
|
362
|
-
#
|
363
|
-
# you have the correct permissions, you can create a dashboard from a
|
364
|
-
# template that exists in a different AWS account.
|
563
|
+
# from them. If you have the correct permissions, you can create a
|
564
|
+
# dashboard from a template that exists in a different AWS account.
|
365
565
|
#
|
366
566
|
# @option params [required, String] :aws_account_id
|
367
567
|
# The ID of the AWS account where you want to create the dashboard.
|
@@ -373,27 +573,31 @@ module Aws::QuickSight
|
|
373
573
|
# The display name of the dashboard.
|
374
574
|
#
|
375
575
|
# @option params [Types::Parameters] :parameters
|
376
|
-
#
|
377
|
-
#
|
378
|
-
# parameters, and some parameters might accept multiple values.
|
379
|
-
# use the dashboard permissions structure described following to
|
380
|
-
# override two string parameters that accept multiple values.
|
576
|
+
# The parameters for the creation of the dashboard, which you want to
|
577
|
+
# use to override the default settings. A dashboard can have any type of
|
578
|
+
# parameters, and some parameters might accept multiple values.
|
381
579
|
#
|
382
580
|
# @option params [Array<Types::ResourcePermission>] :permissions
|
383
581
|
# A structure that contains the permissions of the dashboard. You can
|
384
|
-
# use this structure for granting permissions
|
385
|
-
# information.
|
582
|
+
# use this structure for granting permissions by providing a list of IAM
|
583
|
+
# action information for each principal ARN.
|
386
584
|
#
|
387
|
-
#
|
388
|
-
# The source entity from which the dashboard is created. The source
|
389
|
-
# entity accepts the Amazon Resource Name (ARN) of the source template
|
390
|
-
# or analysis and also references the replacement datasets for the
|
391
|
-
# placeholders set when creating the template. The replacement datasets
|
392
|
-
# need to follow the same schema as the datasets for which placeholders
|
393
|
-
# were created when creating the template.
|
585
|
+
# To specify no permissions, omit the permissions list.
|
394
586
|
#
|
395
|
-
#
|
396
|
-
#
|
587
|
+
# @option params [required, Types::DashboardSourceEntity] :source_entity
|
588
|
+
# The entity that you are using as a source when you create the
|
589
|
+
# dashboard. In `SourceEntity`, you specify the type of object you're
|
590
|
+
# using as source. You can only create a dashboard from a template, so
|
591
|
+
# you use a `SourceTemplate` entity. If you need to create a dashboard
|
592
|
+
# from an analysis, first convert the analysis to a template by using
|
593
|
+
# the CreateTemplate API operation. For `SourceTemplate`, specify the
|
594
|
+
# Amazon Resource Name (ARN) of the source template. The
|
595
|
+
# `SourceTemplate`ARN can contain any AWS Account and any
|
596
|
+
# QuickSight-supported AWS Region.
|
597
|
+
#
|
598
|
+
# Use the `DataSetReferences` entity within `SourceTemplate` to list the
|
599
|
+
# replacement datasets for the placeholders listed in the original. The
|
600
|
+
# schema in each dataset must match its placeholder.
|
397
601
|
#
|
398
602
|
# @option params [Array<Types::Tag>] :tags
|
399
603
|
# Contains a map of the key-value pairs for the resource tag or tags
|
@@ -413,13 +617,18 @@ module Aws::QuickSight
|
|
413
617
|
#
|
414
618
|
# * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
|
415
619
|
# either `ENABLED` or `DISABLED`. The visual option to export data to
|
416
|
-
# .
|
620
|
+
# .CSV format isn't enabled when this is set to `DISABLED`. This
|
417
621
|
# option is `ENABLED` by default.
|
418
622
|
#
|
419
623
|
# * `VisibilityState` for `SheetControlsOption` - This visibility state
|
420
|
-
# can be either `COLLAPSED` or `EXPANDED`.
|
421
|
-
#
|
422
|
-
#
|
624
|
+
# can be either `COLLAPSED` or `EXPANDED`. This option is `COLLAPSED`
|
625
|
+
# by default.
|
626
|
+
#
|
627
|
+
# @option params [String] :theme_arn
|
628
|
+
# The Amazon Resource Name (ARN) of the theme that is being used for
|
629
|
+
# this dashboard. If you add a value for this field, it overrides the
|
630
|
+
# value that is used in the source entity. The theme ARN must exist in
|
631
|
+
# the same AWS account where you create the dashboard.
|
423
632
|
#
|
424
633
|
# @return [Types::CreateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
425
634
|
#
|
@@ -497,6 +706,7 @@ module Aws::QuickSight
|
|
497
706
|
# visibility_state: "EXPANDED", # accepts EXPANDED, COLLAPSED
|
498
707
|
# },
|
499
708
|
# },
|
709
|
+
# theme_arn: "Arn",
|
500
710
|
# })
|
501
711
|
#
|
502
712
|
# @example Response structure
|
@@ -504,7 +714,7 @@ module Aws::QuickSight
|
|
504
714
|
# resp.arn #=> String
|
505
715
|
# resp.version_arn #=> String
|
506
716
|
# resp.dashboard_id #=> String
|
507
|
-
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
717
|
+
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
508
718
|
# resp.status #=> Integer
|
509
719
|
# resp.request_id #=> String
|
510
720
|
#
|
@@ -679,6 +889,7 @@ module Aws::QuickSight
|
|
679
889
|
# },
|
680
890
|
# ],
|
681
891
|
# row_level_permission_data_set: {
|
892
|
+
# namespace: "Namespace",
|
682
893
|
# arn: "Arn", # required
|
683
894
|
# permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
|
684
895
|
# },
|
@@ -855,7 +1066,96 @@ module Aws::QuickSight
|
|
855
1066
|
# credential_pair: {
|
856
1067
|
# username: "Username", # required
|
857
1068
|
# password: "Password", # required
|
1069
|
+
# alternate_data_source_parameters: [
|
1070
|
+
# {
|
1071
|
+
# amazon_elasticsearch_parameters: {
|
1072
|
+
# domain: "Domain", # required
|
1073
|
+
# },
|
1074
|
+
# athena_parameters: {
|
1075
|
+
# work_group: "WorkGroup",
|
1076
|
+
# },
|
1077
|
+
# aurora_parameters: {
|
1078
|
+
# host: "Host", # required
|
1079
|
+
# port: 1, # required
|
1080
|
+
# database: "Database", # required
|
1081
|
+
# },
|
1082
|
+
# aurora_postgre_sql_parameters: {
|
1083
|
+
# host: "Host", # required
|
1084
|
+
# port: 1, # required
|
1085
|
+
# database: "Database", # required
|
1086
|
+
# },
|
1087
|
+
# aws_iot_analytics_parameters: {
|
1088
|
+
# data_set_name: "DataSetName", # required
|
1089
|
+
# },
|
1090
|
+
# jira_parameters: {
|
1091
|
+
# site_base_url: "SiteBaseUrl", # required
|
1092
|
+
# },
|
1093
|
+
# maria_db_parameters: {
|
1094
|
+
# host: "Host", # required
|
1095
|
+
# port: 1, # required
|
1096
|
+
# database: "Database", # required
|
1097
|
+
# },
|
1098
|
+
# my_sql_parameters: {
|
1099
|
+
# host: "Host", # required
|
1100
|
+
# port: 1, # required
|
1101
|
+
# database: "Database", # required
|
1102
|
+
# },
|
1103
|
+
# postgre_sql_parameters: {
|
1104
|
+
# host: "Host", # required
|
1105
|
+
# port: 1, # required
|
1106
|
+
# database: "Database", # required
|
1107
|
+
# },
|
1108
|
+
# presto_parameters: {
|
1109
|
+
# host: "Host", # required
|
1110
|
+
# port: 1, # required
|
1111
|
+
# catalog: "Catalog", # required
|
1112
|
+
# },
|
1113
|
+
# rds_parameters: {
|
1114
|
+
# instance_id: "InstanceId", # required
|
1115
|
+
# database: "Database", # required
|
1116
|
+
# },
|
1117
|
+
# redshift_parameters: {
|
1118
|
+
# host: "Host",
|
1119
|
+
# port: 1,
|
1120
|
+
# database: "Database", # required
|
1121
|
+
# cluster_id: "ClusterId",
|
1122
|
+
# },
|
1123
|
+
# s3_parameters: {
|
1124
|
+
# manifest_file_location: { # required
|
1125
|
+
# bucket: "S3Bucket", # required
|
1126
|
+
# key: "S3Key", # required
|
1127
|
+
# },
|
1128
|
+
# },
|
1129
|
+
# service_now_parameters: {
|
1130
|
+
# site_base_url: "SiteBaseUrl", # required
|
1131
|
+
# },
|
1132
|
+
# snowflake_parameters: {
|
1133
|
+
# host: "Host", # required
|
1134
|
+
# database: "Database", # required
|
1135
|
+
# warehouse: "Warehouse", # required
|
1136
|
+
# },
|
1137
|
+
# spark_parameters: {
|
1138
|
+
# host: "Host", # required
|
1139
|
+
# port: 1, # required
|
1140
|
+
# },
|
1141
|
+
# sql_server_parameters: {
|
1142
|
+
# host: "Host", # required
|
1143
|
+
# port: 1, # required
|
1144
|
+
# database: "Database", # required
|
1145
|
+
# },
|
1146
|
+
# teradata_parameters: {
|
1147
|
+
# host: "Host", # required
|
1148
|
+
# port: 1, # required
|
1149
|
+
# database: "Database", # required
|
1150
|
+
# },
|
1151
|
+
# twitter_parameters: {
|
1152
|
+
# query: "Query", # required
|
1153
|
+
# max_rows: 1, # required
|
1154
|
+
# },
|
1155
|
+
# },
|
1156
|
+
# ],
|
858
1157
|
# },
|
1158
|
+
# copy_source_arn: "CopySourceArn",
|
859
1159
|
# },
|
860
1160
|
# permissions: [
|
861
1161
|
# {
|
@@ -881,7 +1181,7 @@ module Aws::QuickSight
|
|
881
1181
|
#
|
882
1182
|
# resp.arn #=> String
|
883
1183
|
# resp.data_source_id #=> String
|
884
|
-
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
1184
|
+
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
885
1185
|
# resp.request_id #=> String
|
886
1186
|
# resp.status #=> Integer
|
887
1187
|
#
|
@@ -1129,6 +1429,76 @@ module Aws::QuickSight
|
|
1129
1429
|
req.send_request(options)
|
1130
1430
|
end
|
1131
1431
|
|
1432
|
+
# (Enterprise edition only) Creates a new namespace for you to use with
|
1433
|
+
# Amazon QuickSight.
|
1434
|
+
#
|
1435
|
+
# A namespace allows you to isolate the QuickSight users and groups that
|
1436
|
+
# are registered for that namespace. Users that access the namespace can
|
1437
|
+
# share assets only with other users or groups in the same namespace.
|
1438
|
+
# They can't see users and groups in other namespaces. You can create a
|
1439
|
+
# namespace after your AWS account is subscribed to QuickSight. The
|
1440
|
+
# namespace must be unique within the AWS account. By default, there is
|
1441
|
+
# a limit of 100 namespaces per AWS account. To increase your limit,
|
1442
|
+
# create a ticket with AWS Support.
|
1443
|
+
#
|
1444
|
+
# @option params [required, String] :aws_account_id
|
1445
|
+
# The ID for the AWS account that you want to create the QuickSight
|
1446
|
+
# namespace in.
|
1447
|
+
#
|
1448
|
+
# @option params [required, String] :namespace
|
1449
|
+
# The name that you want to use to describe the new namespace.
|
1450
|
+
#
|
1451
|
+
# @option params [required, String] :identity_store
|
1452
|
+
# Specifies the type of your user identity directory. Currently, this
|
1453
|
+
# supports users with an identity type of `QUICKSIGHT`.
|
1454
|
+
#
|
1455
|
+
# @option params [Array<Types::Tag>] :tags
|
1456
|
+
# The tags that you want to associate with the namespace that you're
|
1457
|
+
# creating.
|
1458
|
+
#
|
1459
|
+
# @return [Types::CreateNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1460
|
+
#
|
1461
|
+
# * {Types::CreateNamespaceResponse#arn #arn} => String
|
1462
|
+
# * {Types::CreateNamespaceResponse#name #name} => String
|
1463
|
+
# * {Types::CreateNamespaceResponse#capacity_region #capacity_region} => String
|
1464
|
+
# * {Types::CreateNamespaceResponse#creation_status #creation_status} => String
|
1465
|
+
# * {Types::CreateNamespaceResponse#identity_store #identity_store} => String
|
1466
|
+
# * {Types::CreateNamespaceResponse#request_id #request_id} => String
|
1467
|
+
# * {Types::CreateNamespaceResponse#status #status} => Integer
|
1468
|
+
#
|
1469
|
+
# @example Request syntax with placeholder values
|
1470
|
+
#
|
1471
|
+
# resp = client.create_namespace({
|
1472
|
+
# aws_account_id: "AwsAccountId", # required
|
1473
|
+
# namespace: "Namespace", # required
|
1474
|
+
# identity_store: "QUICKSIGHT", # required, accepts QUICKSIGHT
|
1475
|
+
# tags: [
|
1476
|
+
# {
|
1477
|
+
# key: "TagKey", # required
|
1478
|
+
# value: "TagValue", # required
|
1479
|
+
# },
|
1480
|
+
# ],
|
1481
|
+
# })
|
1482
|
+
#
|
1483
|
+
# @example Response structure
|
1484
|
+
#
|
1485
|
+
# resp.arn #=> String
|
1486
|
+
# resp.name #=> String
|
1487
|
+
# resp.capacity_region #=> String
|
1488
|
+
# resp.creation_status #=> String, one of "CREATED", "CREATING", "DELETING", "RETRYABLE_FAILURE", "NON_RETRYABLE_FAILURE"
|
1489
|
+
# resp.identity_store #=> String, one of "QUICKSIGHT"
|
1490
|
+
# resp.request_id #=> String
|
1491
|
+
# resp.status #=> Integer
|
1492
|
+
#
|
1493
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateNamespace AWS API Documentation
|
1494
|
+
#
|
1495
|
+
# @overload create_namespace(params = {})
|
1496
|
+
# @param [Hash] params ({})
|
1497
|
+
def create_namespace(params = {}, options = {})
|
1498
|
+
req = build_request(:create_namespace, params)
|
1499
|
+
req.send_request(options)
|
1500
|
+
end
|
1501
|
+
|
1132
1502
|
# Creates a template from an existing QuickSight analysis or template.
|
1133
1503
|
# You can use the resulting template to create a dashboard.
|
1134
1504
|
#
|
@@ -1156,10 +1526,19 @@ module Aws::QuickSight
|
|
1156
1526
|
# A list of resource permissions to be set on the template.
|
1157
1527
|
#
|
1158
1528
|
# @option params [required, Types::TemplateSourceEntity] :source_entity
|
1159
|
-
# The
|
1160
|
-
# template
|
1161
|
-
#
|
1162
|
-
#
|
1529
|
+
# The entity that you are using as a source when you create the
|
1530
|
+
# template. In `SourceEntity`, you specify the type of object you're
|
1531
|
+
# using as source: `SourceTemplate` for a template or `SourceAnalysis`
|
1532
|
+
# for an analysis. Both of these require an Amazon Resource Name (ARN).
|
1533
|
+
# For `SourceTemplate`, specify the ARN of the source template. For
|
1534
|
+
# `SourceAnalysis`, specify the ARN of the source analysis. The
|
1535
|
+
# `SourceTemplate` ARN can contain any AWS Account and any
|
1536
|
+
# QuickSight-supported AWS Region.
|
1537
|
+
#
|
1538
|
+
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
1539
|
+
# `SourceAnalysis` to list the replacement datasets for the placeholders
|
1540
|
+
# listed in the original. The schema in each dataset must match its
|
1541
|
+
# placeholder.
|
1163
1542
|
#
|
1164
1543
|
# @option params [Array<Types::Tag>] :tags
|
1165
1544
|
# Contains a map of the key-value pairs for the resource tag or tags
|
@@ -1221,7 +1600,7 @@ module Aws::QuickSight
|
|
1221
1600
|
# resp.arn #=> String
|
1222
1601
|
# resp.version_arn #=> String
|
1223
1602
|
# resp.template_id #=> String
|
1224
|
-
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
1603
|
+
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
1225
1604
|
# resp.status #=> Integer
|
1226
1605
|
# resp.request_id #=> String
|
1227
1606
|
#
|
@@ -1283,90 +1662,375 @@ module Aws::QuickSight
|
|
1283
1662
|
req.send_request(options)
|
1284
1663
|
end
|
1285
1664
|
|
1286
|
-
#
|
1665
|
+
# Creates a theme.
|
1666
|
+
#
|
1667
|
+
# A *theme* is set of configuration options for color and layout. Themes
|
1668
|
+
# apply to analyses and dashboards. For more information, see [Using
|
1669
|
+
# Themes in Amazon QuickSight][1] in the *Amazon QuickSight User Guide*.
|
1670
|
+
#
|
1671
|
+
#
|
1672
|
+
#
|
1673
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html
|
1287
1674
|
#
|
1288
1675
|
# @option params [required, String] :aws_account_id
|
1289
|
-
# The ID of the AWS account
|
1290
|
-
# deleting.
|
1676
|
+
# The ID of the AWS account where you want to store the new theme.
|
1291
1677
|
#
|
1292
|
-
# @option params [required, String] :
|
1293
|
-
#
|
1678
|
+
# @option params [required, String] :theme_id
|
1679
|
+
# An ID for the theme that you want to create. The theme ID is unique
|
1680
|
+
# per AWS Region in each AWS account.
|
1294
1681
|
#
|
1295
|
-
# @option params [
|
1296
|
-
#
|
1297
|
-
# provided, only the specified version of the dashboard is deleted.
|
1682
|
+
# @option params [required, String] :name
|
1683
|
+
# A display name for the theme.
|
1298
1684
|
#
|
1299
|
-
# @
|
1685
|
+
# @option params [required, String] :base_theme_id
|
1686
|
+
# The ID of the theme that a custom theme will inherit from. All themes
|
1687
|
+
# inherit from one of the starting themes defined by Amazon QuickSight.
|
1688
|
+
# For a list of the starting themes, use `ListThemes` or choose
|
1689
|
+
# **Themes** from within a QuickSight analysis.
|
1300
1690
|
#
|
1301
|
-
#
|
1302
|
-
#
|
1303
|
-
#
|
1304
|
-
#
|
1691
|
+
# @option params [String] :version_description
|
1692
|
+
# A description of the first version of the theme that you're creating.
|
1693
|
+
# Every time `UpdateTheme` is called, a new version is created. Each
|
1694
|
+
# version of the theme has a description of the version in the
|
1695
|
+
# `VersionDescription` field.
|
1696
|
+
#
|
1697
|
+
# @option params [required, Types::ThemeConfiguration] :configuration
|
1698
|
+
# The theme configuration, which contains the theme display properties.
|
1699
|
+
#
|
1700
|
+
# @option params [Array<Types::ResourcePermission>] :permissions
|
1701
|
+
# A valid grouping of resource permissions to apply to the new theme.
|
1702
|
+
#
|
1703
|
+
# @option params [Array<Types::Tag>] :tags
|
1704
|
+
# A map of the key-value pairs for the resource tag or tags that you
|
1705
|
+
# want to add to the resource.
|
1706
|
+
#
|
1707
|
+
# @return [Types::CreateThemeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1708
|
+
#
|
1709
|
+
# * {Types::CreateThemeResponse#arn #arn} => String
|
1710
|
+
# * {Types::CreateThemeResponse#version_arn #version_arn} => String
|
1711
|
+
# * {Types::CreateThemeResponse#theme_id #theme_id} => String
|
1712
|
+
# * {Types::CreateThemeResponse#creation_status #creation_status} => String
|
1713
|
+
# * {Types::CreateThemeResponse#status #status} => Integer
|
1714
|
+
# * {Types::CreateThemeResponse#request_id #request_id} => String
|
1305
1715
|
#
|
1306
1716
|
# @example Request syntax with placeholder values
|
1307
1717
|
#
|
1308
|
-
# resp = client.
|
1718
|
+
# resp = client.create_theme({
|
1309
1719
|
# aws_account_id: "AwsAccountId", # required
|
1310
|
-
#
|
1311
|
-
#
|
1720
|
+
# theme_id: "RestrictiveResourceId", # required
|
1721
|
+
# name: "ThemeName", # required
|
1722
|
+
# base_theme_id: "RestrictiveResourceId", # required
|
1723
|
+
# version_description: "VersionDescription",
|
1724
|
+
# configuration: { # required
|
1725
|
+
# data_color_palette: {
|
1726
|
+
# colors: ["HexColor"],
|
1727
|
+
# min_max_gradient: ["HexColor"],
|
1728
|
+
# empty_fill_color: "HexColor",
|
1729
|
+
# },
|
1730
|
+
# ui_color_palette: {
|
1731
|
+
# primary_foreground: "HexColor",
|
1732
|
+
# primary_background: "HexColor",
|
1733
|
+
# secondary_foreground: "HexColor",
|
1734
|
+
# secondary_background: "HexColor",
|
1735
|
+
# accent: "HexColor",
|
1736
|
+
# accent_foreground: "HexColor",
|
1737
|
+
# danger: "HexColor",
|
1738
|
+
# danger_foreground: "HexColor",
|
1739
|
+
# warning: "HexColor",
|
1740
|
+
# warning_foreground: "HexColor",
|
1741
|
+
# success: "HexColor",
|
1742
|
+
# success_foreground: "HexColor",
|
1743
|
+
# dimension: "HexColor",
|
1744
|
+
# dimension_foreground: "HexColor",
|
1745
|
+
# measure: "HexColor",
|
1746
|
+
# measure_foreground: "HexColor",
|
1747
|
+
# },
|
1748
|
+
# sheet: {
|
1749
|
+
# tile: {
|
1750
|
+
# border: {
|
1751
|
+
# show: false,
|
1752
|
+
# },
|
1753
|
+
# },
|
1754
|
+
# tile_layout: {
|
1755
|
+
# gutter: {
|
1756
|
+
# show: false,
|
1757
|
+
# },
|
1758
|
+
# margin: {
|
1759
|
+
# show: false,
|
1760
|
+
# },
|
1761
|
+
# },
|
1762
|
+
# },
|
1763
|
+
# },
|
1764
|
+
# permissions: [
|
1765
|
+
# {
|
1766
|
+
# principal: "Principal", # required
|
1767
|
+
# actions: ["String"], # required
|
1768
|
+
# },
|
1769
|
+
# ],
|
1770
|
+
# tags: [
|
1771
|
+
# {
|
1772
|
+
# key: "TagKey", # required
|
1773
|
+
# value: "TagValue", # required
|
1774
|
+
# },
|
1775
|
+
# ],
|
1312
1776
|
# })
|
1313
1777
|
#
|
1314
1778
|
# @example Response structure
|
1315
1779
|
#
|
1316
|
-
# resp.status #=> Integer
|
1317
1780
|
# resp.arn #=> String
|
1318
|
-
# resp.
|
1781
|
+
# resp.version_arn #=> String
|
1782
|
+
# resp.theme_id #=> String
|
1783
|
+
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
1784
|
+
# resp.status #=> Integer
|
1319
1785
|
# resp.request_id #=> String
|
1320
1786
|
#
|
1321
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
1787
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateTheme AWS API Documentation
|
1322
1788
|
#
|
1323
|
-
# @overload
|
1789
|
+
# @overload create_theme(params = {})
|
1324
1790
|
# @param [Hash] params ({})
|
1325
|
-
def
|
1326
|
-
req = build_request(:
|
1791
|
+
def create_theme(params = {}, options = {})
|
1792
|
+
req = build_request(:create_theme, params)
|
1327
1793
|
req.send_request(options)
|
1328
1794
|
end
|
1329
1795
|
|
1330
|
-
#
|
1796
|
+
# Creates a theme alias for a theme.
|
1331
1797
|
#
|
1332
1798
|
# @option params [required, String] :aws_account_id
|
1333
|
-
# The AWS account
|
1799
|
+
# The ID of the AWS account that contains the theme for the new theme
|
1800
|
+
# alias.
|
1334
1801
|
#
|
1335
|
-
# @option params [required, String] :
|
1336
|
-
#
|
1337
|
-
# AWS Region for each AWS account.
|
1802
|
+
# @option params [required, String] :theme_id
|
1803
|
+
# An ID for the theme alias.
|
1338
1804
|
#
|
1339
|
-
# @
|
1805
|
+
# @option params [required, String] :alias_name
|
1806
|
+
# The name that you want to give to the theme alias that you are
|
1807
|
+
# creating. The alias name can't begin with a `$`. Alias names that
|
1808
|
+
# start with `$` are reserved by Amazon QuickSight.
|
1340
1809
|
#
|
1341
|
-
#
|
1342
|
-
#
|
1343
|
-
#
|
1344
|
-
#
|
1810
|
+
# @option params [required, Integer] :theme_version_number
|
1811
|
+
# The version number of the theme.
|
1812
|
+
#
|
1813
|
+
# @return [Types::CreateThemeAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1814
|
+
#
|
1815
|
+
# * {Types::CreateThemeAliasResponse#theme_alias #theme_alias} => Types::ThemeAlias
|
1816
|
+
# * {Types::CreateThemeAliasResponse#status #status} => Integer
|
1817
|
+
# * {Types::CreateThemeAliasResponse#request_id #request_id} => String
|
1345
1818
|
#
|
1346
1819
|
# @example Request syntax with placeholder values
|
1347
1820
|
#
|
1348
|
-
# resp = client.
|
1821
|
+
# resp = client.create_theme_alias({
|
1349
1822
|
# aws_account_id: "AwsAccountId", # required
|
1350
|
-
#
|
1823
|
+
# theme_id: "RestrictiveResourceId", # required
|
1824
|
+
# alias_name: "AliasName", # required
|
1825
|
+
# theme_version_number: 1, # required
|
1351
1826
|
# })
|
1352
1827
|
#
|
1353
1828
|
# @example Response structure
|
1354
1829
|
#
|
1355
|
-
# resp.arn #=> String
|
1356
|
-
# resp.
|
1357
|
-
# resp.
|
1830
|
+
# resp.theme_alias.arn #=> String
|
1831
|
+
# resp.theme_alias.alias_name #=> String
|
1832
|
+
# resp.theme_alias.theme_version_number #=> Integer
|
1358
1833
|
# resp.status #=> Integer
|
1834
|
+
# resp.request_id #=> String
|
1359
1835
|
#
|
1360
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
1836
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateThemeAlias AWS API Documentation
|
1361
1837
|
#
|
1362
|
-
# @overload
|
1838
|
+
# @overload create_theme_alias(params = {})
|
1363
1839
|
# @param [Hash] params ({})
|
1364
|
-
def
|
1840
|
+
def create_theme_alias(params = {}, options = {})
|
1841
|
+
req = build_request(:create_theme_alias, params)
|
1842
|
+
req.send_request(options)
|
1843
|
+
end
|
1844
|
+
|
1845
|
+
# Deletes all Amazon QuickSight customizations in this AWS Region for
|
1846
|
+
# the specified AWS Account and QuickSight namespace.
|
1847
|
+
#
|
1848
|
+
# @option params [required, String] :aws_account_id
|
1849
|
+
# The ID for the AWS account that you want to delete QuickSight
|
1850
|
+
# customizations from in this AWS Region.
|
1851
|
+
#
|
1852
|
+
# @option params [String] :namespace
|
1853
|
+
# The QuickSight namespace that you're deleting the customizations
|
1854
|
+
# from.
|
1855
|
+
#
|
1856
|
+
# @return [Types::DeleteAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1857
|
+
#
|
1858
|
+
# * {Types::DeleteAccountCustomizationResponse#request_id #request_id} => String
|
1859
|
+
# * {Types::DeleteAccountCustomizationResponse#status #status} => Integer
|
1860
|
+
#
|
1861
|
+
# @example Request syntax with placeholder values
|
1862
|
+
#
|
1863
|
+
# resp = client.delete_account_customization({
|
1864
|
+
# aws_account_id: "AwsAccountId", # required
|
1865
|
+
# namespace: "Namespace",
|
1866
|
+
# })
|
1867
|
+
#
|
1868
|
+
# @example Response structure
|
1869
|
+
#
|
1870
|
+
# resp.request_id #=> String
|
1871
|
+
# resp.status #=> Integer
|
1872
|
+
#
|
1873
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAccountCustomization AWS API Documentation
|
1874
|
+
#
|
1875
|
+
# @overload delete_account_customization(params = {})
|
1876
|
+
# @param [Hash] params ({})
|
1877
|
+
def delete_account_customization(params = {}, options = {})
|
1878
|
+
req = build_request(:delete_account_customization, params)
|
1879
|
+
req.send_request(options)
|
1880
|
+
end
|
1881
|
+
|
1882
|
+
# Deletes an analysis from Amazon QuickSight. You can optionally include
|
1883
|
+
# a recovery window during which you can restore the analysis. If you
|
1884
|
+
# don't specify a recovery window value, the operation defaults to 30
|
1885
|
+
# days. QuickSight attaches a `DeletionTime` stamp to the response that
|
1886
|
+
# specifies the end of the recovery window. At the end of the recovery
|
1887
|
+
# window, QuickSight deletes the analysis permanently.
|
1888
|
+
#
|
1889
|
+
# At any time before recovery window ends, you can use the
|
1890
|
+
# `RestoreAnalysis` API operation to remove the `DeletionTime` stamp and
|
1891
|
+
# cancel the deletion of the analysis. The analysis remains visible in
|
1892
|
+
# the API until it's deleted, so you can describe it but you can't
|
1893
|
+
# make a template from it.
|
1894
|
+
#
|
1895
|
+
# An analysis that's scheduled for deletion isn't accessible in the
|
1896
|
+
# QuickSight console. To access it in the console, restore it. Deleting
|
1897
|
+
# an analysis doesn't delete the dashboards that you publish from it.
|
1898
|
+
#
|
1899
|
+
# @option params [required, String] :aws_account_id
|
1900
|
+
# The ID of the AWS account where you want to delete an analysis.
|
1901
|
+
#
|
1902
|
+
# @option params [required, String] :analysis_id
|
1903
|
+
# The ID of the analysis that you're deleting.
|
1904
|
+
#
|
1905
|
+
# @option params [Integer] :recovery_window_in_days
|
1906
|
+
# A value that specifies the number of days that QuickSight waits before
|
1907
|
+
# it deletes the analysis. You can't use this parameter with the
|
1908
|
+
# `ForceDeleteWithoutRecovery` option in the same API call. The default
|
1909
|
+
# value is 30.
|
1910
|
+
#
|
1911
|
+
# @option params [Boolean] :force_delete_without_recovery
|
1912
|
+
# This option defaults to the value `NoForceDeleteWithoutRecovery`. To
|
1913
|
+
# immediately delete the analysis, add the `ForceDeleteWithoutRecovery`
|
1914
|
+
# option. You can't restore an analysis after it's deleted.
|
1915
|
+
#
|
1916
|
+
# @return [Types::DeleteAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1917
|
+
#
|
1918
|
+
# * {Types::DeleteAnalysisResponse#status #status} => Integer
|
1919
|
+
# * {Types::DeleteAnalysisResponse#arn #arn} => String
|
1920
|
+
# * {Types::DeleteAnalysisResponse#analysis_id #analysis_id} => String
|
1921
|
+
# * {Types::DeleteAnalysisResponse#deletion_time #deletion_time} => Time
|
1922
|
+
# * {Types::DeleteAnalysisResponse#request_id #request_id} => String
|
1923
|
+
#
|
1924
|
+
# @example Request syntax with placeholder values
|
1925
|
+
#
|
1926
|
+
# resp = client.delete_analysis({
|
1927
|
+
# aws_account_id: "AwsAccountId", # required
|
1928
|
+
# analysis_id: "RestrictiveResourceId", # required
|
1929
|
+
# recovery_window_in_days: 1,
|
1930
|
+
# force_delete_without_recovery: false,
|
1931
|
+
# })
|
1932
|
+
#
|
1933
|
+
# @example Response structure
|
1934
|
+
#
|
1935
|
+
# resp.status #=> Integer
|
1936
|
+
# resp.arn #=> String
|
1937
|
+
# resp.analysis_id #=> String
|
1938
|
+
# resp.deletion_time #=> Time
|
1939
|
+
# resp.request_id #=> String
|
1940
|
+
#
|
1941
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAnalysis AWS API Documentation
|
1942
|
+
#
|
1943
|
+
# @overload delete_analysis(params = {})
|
1944
|
+
# @param [Hash] params ({})
|
1945
|
+
def delete_analysis(params = {}, options = {})
|
1946
|
+
req = build_request(:delete_analysis, params)
|
1947
|
+
req.send_request(options)
|
1948
|
+
end
|
1949
|
+
|
1950
|
+
# Deletes a dashboard.
|
1951
|
+
#
|
1952
|
+
# @option params [required, String] :aws_account_id
|
1953
|
+
# The ID of the AWS account that contains the dashboard that you're
|
1954
|
+
# deleting.
|
1955
|
+
#
|
1956
|
+
# @option params [required, String] :dashboard_id
|
1957
|
+
# The ID for the dashboard.
|
1958
|
+
#
|
1959
|
+
# @option params [Integer] :version_number
|
1960
|
+
# The version number of the dashboard. If the version number property is
|
1961
|
+
# provided, only the specified version of the dashboard is deleted.
|
1962
|
+
#
|
1963
|
+
# @return [Types::DeleteDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1964
|
+
#
|
1965
|
+
# * {Types::DeleteDashboardResponse#status #status} => Integer
|
1966
|
+
# * {Types::DeleteDashboardResponse#arn #arn} => String
|
1967
|
+
# * {Types::DeleteDashboardResponse#dashboard_id #dashboard_id} => String
|
1968
|
+
# * {Types::DeleteDashboardResponse#request_id #request_id} => String
|
1969
|
+
#
|
1970
|
+
# @example Request syntax with placeholder values
|
1971
|
+
#
|
1972
|
+
# resp = client.delete_dashboard({
|
1973
|
+
# aws_account_id: "AwsAccountId", # required
|
1974
|
+
# dashboard_id: "RestrictiveResourceId", # required
|
1975
|
+
# version_number: 1,
|
1976
|
+
# })
|
1977
|
+
#
|
1978
|
+
# @example Response structure
|
1979
|
+
#
|
1980
|
+
# resp.status #=> Integer
|
1981
|
+
# resp.arn #=> String
|
1982
|
+
# resp.dashboard_id #=> String
|
1983
|
+
# resp.request_id #=> String
|
1984
|
+
#
|
1985
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDashboard AWS API Documentation
|
1986
|
+
#
|
1987
|
+
# @overload delete_dashboard(params = {})
|
1988
|
+
# @param [Hash] params ({})
|
1989
|
+
def delete_dashboard(params = {}, options = {})
|
1990
|
+
req = build_request(:delete_dashboard, params)
|
1991
|
+
req.send_request(options)
|
1992
|
+
end
|
1993
|
+
|
1994
|
+
# Deletes a dataset.
|
1995
|
+
#
|
1996
|
+
# @option params [required, String] :aws_account_id
|
1997
|
+
# The AWS account ID.
|
1998
|
+
#
|
1999
|
+
# @option params [required, String] :data_set_id
|
2000
|
+
# The ID for the dataset that you want to create. This ID is unique per
|
2001
|
+
# AWS Region for each AWS account.
|
2002
|
+
#
|
2003
|
+
# @return [Types::DeleteDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2004
|
+
#
|
2005
|
+
# * {Types::DeleteDataSetResponse#arn #arn} => String
|
2006
|
+
# * {Types::DeleteDataSetResponse#data_set_id #data_set_id} => String
|
2007
|
+
# * {Types::DeleteDataSetResponse#request_id #request_id} => String
|
2008
|
+
# * {Types::DeleteDataSetResponse#status #status} => Integer
|
2009
|
+
#
|
2010
|
+
# @example Request syntax with placeholder values
|
2011
|
+
#
|
2012
|
+
# resp = client.delete_data_set({
|
2013
|
+
# aws_account_id: "AwsAccountId", # required
|
2014
|
+
# data_set_id: "ResourceId", # required
|
2015
|
+
# })
|
2016
|
+
#
|
2017
|
+
# @example Response structure
|
2018
|
+
#
|
2019
|
+
# resp.arn #=> String
|
2020
|
+
# resp.data_set_id #=> String
|
2021
|
+
# resp.request_id #=> String
|
2022
|
+
# resp.status #=> Integer
|
2023
|
+
#
|
2024
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDataSet AWS API Documentation
|
2025
|
+
#
|
2026
|
+
# @overload delete_data_set(params = {})
|
2027
|
+
# @param [Hash] params ({})
|
2028
|
+
def delete_data_set(params = {}, options = {})
|
1365
2029
|
req = build_request(:delete_data_set, params)
|
1366
2030
|
req.send_request(options)
|
1367
2031
|
end
|
1368
2032
|
|
1369
|
-
# Deletes the data source permanently. This
|
2033
|
+
# Deletes the data source permanently. This operation breaks all the
|
1370
2034
|
# datasets that reference the deleted data source.
|
1371
2035
|
#
|
1372
2036
|
# @option params [required, String] :aws_account_id
|
@@ -1532,6 +2196,45 @@ module Aws::QuickSight
|
|
1532
2196
|
req.send_request(options)
|
1533
2197
|
end
|
1534
2198
|
|
2199
|
+
# Deletes a namespace and the users and groups that are associated with
|
2200
|
+
# the namespace. This is an asynchronous process. Assets including
|
2201
|
+
# dashboards, analyses, datasets and data sources are not deleted. To
|
2202
|
+
# delete these assets, you use the API operations for the relevant
|
2203
|
+
# asset.
|
2204
|
+
#
|
2205
|
+
# @option params [required, String] :aws_account_id
|
2206
|
+
# The ID for the AWS account that you want to delete the QuickSight
|
2207
|
+
# namespace from.
|
2208
|
+
#
|
2209
|
+
# @option params [required, String] :namespace
|
2210
|
+
# The namespace that you want to delete.
|
2211
|
+
#
|
2212
|
+
# @return [Types::DeleteNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2213
|
+
#
|
2214
|
+
# * {Types::DeleteNamespaceResponse#request_id #request_id} => String
|
2215
|
+
# * {Types::DeleteNamespaceResponse#status #status} => Integer
|
2216
|
+
#
|
2217
|
+
# @example Request syntax with placeholder values
|
2218
|
+
#
|
2219
|
+
# resp = client.delete_namespace({
|
2220
|
+
# aws_account_id: "AwsAccountId", # required
|
2221
|
+
# namespace: "Namespace", # required
|
2222
|
+
# })
|
2223
|
+
#
|
2224
|
+
# @example Response structure
|
2225
|
+
#
|
2226
|
+
# resp.request_id #=> String
|
2227
|
+
# resp.status #=> Integer
|
2228
|
+
#
|
2229
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteNamespace AWS API Documentation
|
2230
|
+
#
|
2231
|
+
# @overload delete_namespace(params = {})
|
2232
|
+
# @param [Hash] params ({})
|
2233
|
+
def delete_namespace(params = {}, options = {})
|
2234
|
+
req = build_request(:delete_namespace, params)
|
2235
|
+
req.send_request(options)
|
2236
|
+
end
|
2237
|
+
|
1535
2238
|
# Deletes a template.
|
1536
2239
|
#
|
1537
2240
|
# @option params [required, String] :aws_account_id
|
@@ -1588,10 +2291,10 @@ module Aws::QuickSight
|
|
1588
2291
|
# The ID for the template that the specified alias is for.
|
1589
2292
|
#
|
1590
2293
|
# @option params [required, String] :alias_name
|
1591
|
-
# The name for the template alias.
|
1592
|
-
# delete the version that the alias points to. You can specify the
|
1593
|
-
# latest version of the template by providing the
|
1594
|
-
# the `AliasName` parameter.
|
2294
|
+
# The name for the template alias. To delete a specific alias, you
|
2295
|
+
# delete the version that the alias points to. You can specify the alias
|
2296
|
+
# name, or specify the latest version of the template by providing the
|
2297
|
+
# keyword `$LATEST` in the `AliasName` parameter.
|
1595
2298
|
#
|
1596
2299
|
# @return [Types::DeleteTemplateAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1597
2300
|
#
|
@@ -1626,6 +2329,98 @@ module Aws::QuickSight
|
|
1626
2329
|
req.send_request(options)
|
1627
2330
|
end
|
1628
2331
|
|
2332
|
+
# Deletes a theme.
|
2333
|
+
#
|
2334
|
+
# @option params [required, String] :aws_account_id
|
2335
|
+
# The ID of the AWS account that contains the theme that you're
|
2336
|
+
# deleting.
|
2337
|
+
#
|
2338
|
+
# @option params [required, String] :theme_id
|
2339
|
+
# An ID for the theme that you want to delete.
|
2340
|
+
#
|
2341
|
+
# @option params [Integer] :version_number
|
2342
|
+
# The version of the theme that you want to delete.
|
2343
|
+
#
|
2344
|
+
# **Note:** If you don't provide a version number, you're using this
|
2345
|
+
# call to `DeleteTheme` to delete all versions of the theme.
|
2346
|
+
#
|
2347
|
+
# @return [Types::DeleteThemeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2348
|
+
#
|
2349
|
+
# * {Types::DeleteThemeResponse#arn #arn} => String
|
2350
|
+
# * {Types::DeleteThemeResponse#request_id #request_id} => String
|
2351
|
+
# * {Types::DeleteThemeResponse#status #status} => Integer
|
2352
|
+
# * {Types::DeleteThemeResponse#theme_id #theme_id} => String
|
2353
|
+
#
|
2354
|
+
# @example Request syntax with placeholder values
|
2355
|
+
#
|
2356
|
+
# resp = client.delete_theme({
|
2357
|
+
# aws_account_id: "AwsAccountId", # required
|
2358
|
+
# theme_id: "RestrictiveResourceId", # required
|
2359
|
+
# version_number: 1,
|
2360
|
+
# })
|
2361
|
+
#
|
2362
|
+
# @example Response structure
|
2363
|
+
#
|
2364
|
+
# resp.arn #=> String
|
2365
|
+
# resp.request_id #=> String
|
2366
|
+
# resp.status #=> Integer
|
2367
|
+
# resp.theme_id #=> String
|
2368
|
+
#
|
2369
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteTheme AWS API Documentation
|
2370
|
+
#
|
2371
|
+
# @overload delete_theme(params = {})
|
2372
|
+
# @param [Hash] params ({})
|
2373
|
+
def delete_theme(params = {}, options = {})
|
2374
|
+
req = build_request(:delete_theme, params)
|
2375
|
+
req.send_request(options)
|
2376
|
+
end
|
2377
|
+
|
2378
|
+
# Deletes the version of the theme that the specified theme alias points
|
2379
|
+
# to. If you provide a specific alias, you delete the version of the
|
2380
|
+
# theme that the alias points to.
|
2381
|
+
#
|
2382
|
+
# @option params [required, String] :aws_account_id
|
2383
|
+
# The ID of the AWS account that contains the theme alias to delete.
|
2384
|
+
#
|
2385
|
+
# @option params [required, String] :theme_id
|
2386
|
+
# The ID for the theme that the specified alias is for.
|
2387
|
+
#
|
2388
|
+
# @option params [required, String] :alias_name
|
2389
|
+
# The unique name for the theme alias to delete.
|
2390
|
+
#
|
2391
|
+
# @return [Types::DeleteThemeAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2392
|
+
#
|
2393
|
+
# * {Types::DeleteThemeAliasResponse#alias_name #alias_name} => String
|
2394
|
+
# * {Types::DeleteThemeAliasResponse#arn #arn} => String
|
2395
|
+
# * {Types::DeleteThemeAliasResponse#request_id #request_id} => String
|
2396
|
+
# * {Types::DeleteThemeAliasResponse#status #status} => Integer
|
2397
|
+
# * {Types::DeleteThemeAliasResponse#theme_id #theme_id} => String
|
2398
|
+
#
|
2399
|
+
# @example Request syntax with placeholder values
|
2400
|
+
#
|
2401
|
+
# resp = client.delete_theme_alias({
|
2402
|
+
# aws_account_id: "AwsAccountId", # required
|
2403
|
+
# theme_id: "RestrictiveResourceId", # required
|
2404
|
+
# alias_name: "AliasName", # required
|
2405
|
+
# })
|
2406
|
+
#
|
2407
|
+
# @example Response structure
|
2408
|
+
#
|
2409
|
+
# resp.alias_name #=> String
|
2410
|
+
# resp.arn #=> String
|
2411
|
+
# resp.request_id #=> String
|
2412
|
+
# resp.status #=> Integer
|
2413
|
+
# resp.theme_id #=> String
|
2414
|
+
#
|
2415
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteThemeAlias AWS API Documentation
|
2416
|
+
#
|
2417
|
+
# @overload delete_theme_alias(params = {})
|
2418
|
+
# @param [Hash] params ({})
|
2419
|
+
def delete_theme_alias(params = {}, options = {})
|
2420
|
+
req = build_request(:delete_theme_alias, params)
|
2421
|
+
req.send_request(options)
|
2422
|
+
end
|
2423
|
+
|
1629
2424
|
# Deletes the Amazon QuickSight user that is associated with the
|
1630
2425
|
# identity of the AWS Identity and Access Management (IAM) user or role
|
1631
2426
|
# that's making the call. The IAM user isn't deleted as a result of
|
@@ -1707,6 +2502,241 @@ module Aws::QuickSight
|
|
1707
2502
|
req.send_request(options)
|
1708
2503
|
end
|
1709
2504
|
|
2505
|
+
# Describes the customizations associated with the provided AWS account
|
2506
|
+
# and Amazon QuickSight namespace in an AWS Region. The QuickSight
|
2507
|
+
# console evaluates which customizations to apply by running this API
|
2508
|
+
# operation with the `Resolved` flag included.
|
2509
|
+
#
|
2510
|
+
# To determine what customizations display when you run this command, it
|
2511
|
+
# can help to visualize the relationship of the entities involved.
|
2512
|
+
#
|
2513
|
+
# * `AWS Account` - The AWS account exists at the top of the hierarchy.
|
2514
|
+
# It has the potential to use all of the AWS Regions and AWS Services.
|
2515
|
+
# When you subscribe to QuickSight, you choose one AWS Region to use
|
2516
|
+
# as your home region. That's where your free SPICE capacity is
|
2517
|
+
# located. You can use QuickSight in any supported AWS Region.
|
2518
|
+
#
|
2519
|
+
# * `AWS Region` - In each AWS Region where you sign in to QuickSight at
|
2520
|
+
# least once, QuickSight acts as a separate instance of the same
|
2521
|
+
# service. If you have a user directory, it resides in us-east-1,
|
2522
|
+
# which is the US East (N. Virginia). Generally speaking, these users
|
2523
|
+
# have access to QuickSight in any AWS Region, unless they are
|
2524
|
+
# constrained to a namespace.
|
2525
|
+
#
|
2526
|
+
# To run the command in a different AWS Region, you change your region
|
2527
|
+
# settings. If you're using the AWS CLI, you can use one of the
|
2528
|
+
# following options:
|
2529
|
+
#
|
2530
|
+
# * Use [command line options][1].
|
2531
|
+
#
|
2532
|
+
# * Use [named profiles][2].
|
2533
|
+
#
|
2534
|
+
# * Run `aws configure` to change your default AWS Region. Use Enter
|
2535
|
+
# to key the same settings for your keys. For more information, see
|
2536
|
+
# [Configuring the AWS CLI][3].
|
2537
|
+
#
|
2538
|
+
# * `Namespace` - A QuickSight namespace is a partition that contains
|
2539
|
+
# users and assets (data sources, datasets, dashboards, and so on). To
|
2540
|
+
# access assets that are in a specific namespace, users and groups
|
2541
|
+
# must also be part of the same namespace. People who share a
|
2542
|
+
# namespace are completely isolated from users and assets in other
|
2543
|
+
# namespaces, even if they are in the same AWS account and AWS Region.
|
2544
|
+
#
|
2545
|
+
# * `Applied customizations` - Within an AWS Region, a set of QuickSight
|
2546
|
+
# customizations can apply to an AWS account or to a namespace.
|
2547
|
+
# Settings that you apply to a namespace override settings that you
|
2548
|
+
# apply to an AWS Account. All settings are isolated to a single AWS
|
2549
|
+
# Region. To apply them in other AWS Regions, run the
|
2550
|
+
# `CreateAccountCustomization` command in each AWS Region where you
|
2551
|
+
# want to apply the same customizations.
|
2552
|
+
#
|
2553
|
+
#
|
2554
|
+
#
|
2555
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html
|
2556
|
+
# [2]: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html
|
2557
|
+
# [3]: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html
|
2558
|
+
#
|
2559
|
+
# @option params [required, String] :aws_account_id
|
2560
|
+
# The ID for the AWS account that you want to describe QuickSight
|
2561
|
+
# customizations for.
|
2562
|
+
#
|
2563
|
+
# @option params [String] :namespace
|
2564
|
+
# The QuickSight namespace that you want to describe QuickSight
|
2565
|
+
# customizations for.
|
2566
|
+
#
|
2567
|
+
# @option params [Boolean] :resolved
|
2568
|
+
# The `Resolved` flag works with the other parameters to determine which
|
2569
|
+
# view of QuickSight customizations is returned. You can add this flag
|
2570
|
+
# to your command to use the same view that QuickSight uses to identify
|
2571
|
+
# which customizations to apply to the console. Omit this flag, or set
|
2572
|
+
# it to `no-resolved`, to reveal customizations that are configured at
|
2573
|
+
# different levels.
|
2574
|
+
#
|
2575
|
+
# @return [Types::DescribeAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2576
|
+
#
|
2577
|
+
# * {Types::DescribeAccountCustomizationResponse#aws_account_id #aws_account_id} => String
|
2578
|
+
# * {Types::DescribeAccountCustomizationResponse#namespace #namespace} => String
|
2579
|
+
# * {Types::DescribeAccountCustomizationResponse#account_customization #account_customization} => Types::AccountCustomization
|
2580
|
+
# * {Types::DescribeAccountCustomizationResponse#request_id #request_id} => String
|
2581
|
+
# * {Types::DescribeAccountCustomizationResponse#status #status} => Integer
|
2582
|
+
#
|
2583
|
+
# @example Request syntax with placeholder values
|
2584
|
+
#
|
2585
|
+
# resp = client.describe_account_customization({
|
2586
|
+
# aws_account_id: "AwsAccountId", # required
|
2587
|
+
# namespace: "Namespace",
|
2588
|
+
# resolved: false,
|
2589
|
+
# })
|
2590
|
+
#
|
2591
|
+
# @example Response structure
|
2592
|
+
#
|
2593
|
+
# resp.aws_account_id #=> String
|
2594
|
+
# resp.namespace #=> String
|
2595
|
+
# resp.account_customization.default_theme #=> String
|
2596
|
+
# resp.request_id #=> String
|
2597
|
+
# resp.status #=> Integer
|
2598
|
+
#
|
2599
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountCustomization AWS API Documentation
|
2600
|
+
#
|
2601
|
+
# @overload describe_account_customization(params = {})
|
2602
|
+
# @param [Hash] params ({})
|
2603
|
+
def describe_account_customization(params = {}, options = {})
|
2604
|
+
req = build_request(:describe_account_customization, params)
|
2605
|
+
req.send_request(options)
|
2606
|
+
end
|
2607
|
+
|
2608
|
+
# Describes the settings that were used when your QuickSight
|
2609
|
+
# subscription was first created in this AWS Account.
|
2610
|
+
#
|
2611
|
+
# @option params [required, String] :aws_account_id
|
2612
|
+
# The ID for the AWS account that contains the settings that you want to
|
2613
|
+
# list.
|
2614
|
+
#
|
2615
|
+
# @return [Types::DescribeAccountSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2616
|
+
#
|
2617
|
+
# * {Types::DescribeAccountSettingsResponse#account_settings #account_settings} => Types::AccountSettings
|
2618
|
+
# * {Types::DescribeAccountSettingsResponse#request_id #request_id} => String
|
2619
|
+
# * {Types::DescribeAccountSettingsResponse#status #status} => Integer
|
2620
|
+
#
|
2621
|
+
# @example Request syntax with placeholder values
|
2622
|
+
#
|
2623
|
+
# resp = client.describe_account_settings({
|
2624
|
+
# aws_account_id: "AwsAccountId", # required
|
2625
|
+
# })
|
2626
|
+
#
|
2627
|
+
# @example Response structure
|
2628
|
+
#
|
2629
|
+
# resp.account_settings.account_name #=> String
|
2630
|
+
# resp.account_settings.edition #=> String, one of "STANDARD", "ENTERPRISE"
|
2631
|
+
# resp.account_settings.default_namespace #=> String
|
2632
|
+
# resp.account_settings.notification_email #=> String
|
2633
|
+
# resp.request_id #=> String
|
2634
|
+
# resp.status #=> Integer
|
2635
|
+
#
|
2636
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountSettings AWS API Documentation
|
2637
|
+
#
|
2638
|
+
# @overload describe_account_settings(params = {})
|
2639
|
+
# @param [Hash] params ({})
|
2640
|
+
def describe_account_settings(params = {}, options = {})
|
2641
|
+
req = build_request(:describe_account_settings, params)
|
2642
|
+
req.send_request(options)
|
2643
|
+
end
|
2644
|
+
|
2645
|
+
# Provides a summary of the metadata for an analysis.
|
2646
|
+
#
|
2647
|
+
# @option params [required, String] :aws_account_id
|
2648
|
+
# The ID of the AWS account that contains the analysis. You must be
|
2649
|
+
# using the AWS account that the analysis is in.
|
2650
|
+
#
|
2651
|
+
# @option params [required, String] :analysis_id
|
2652
|
+
# The ID of the analysis that you're describing. The ID is part of the
|
2653
|
+
# URL of the analysis.
|
2654
|
+
#
|
2655
|
+
# @return [Types::DescribeAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2656
|
+
#
|
2657
|
+
# * {Types::DescribeAnalysisResponse#analysis #analysis} => Types::Analysis
|
2658
|
+
# * {Types::DescribeAnalysisResponse#status #status} => Integer
|
2659
|
+
# * {Types::DescribeAnalysisResponse#request_id #request_id} => String
|
2660
|
+
#
|
2661
|
+
# @example Request syntax with placeholder values
|
2662
|
+
#
|
2663
|
+
# resp = client.describe_analysis({
|
2664
|
+
# aws_account_id: "AwsAccountId", # required
|
2665
|
+
# analysis_id: "RestrictiveResourceId", # required
|
2666
|
+
# })
|
2667
|
+
#
|
2668
|
+
# @example Response structure
|
2669
|
+
#
|
2670
|
+
# resp.analysis.analysis_id #=> String
|
2671
|
+
# resp.analysis.arn #=> String
|
2672
|
+
# resp.analysis.name #=> String
|
2673
|
+
# resp.analysis.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
2674
|
+
# resp.analysis.errors #=> Array
|
2675
|
+
# resp.analysis.errors[0].type #=> String, one of "ACCESS_DENIED", "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE", "PARAMETER_VALUE_INCOMPATIBLE", "PARAMETER_TYPE_INVALID", "PARAMETER_NOT_FOUND", "COLUMN_TYPE_MISMATCH", "COLUMN_GEOGRAPHIC_ROLE_MISMATCH", "COLUMN_REPLACEMENT_MISSING"
|
2676
|
+
# resp.analysis.errors[0].message #=> String
|
2677
|
+
# resp.analysis.data_set_arns #=> Array
|
2678
|
+
# resp.analysis.data_set_arns[0] #=> String
|
2679
|
+
# resp.analysis.theme_arn #=> String
|
2680
|
+
# resp.analysis.created_time #=> Time
|
2681
|
+
# resp.analysis.last_updated_time #=> Time
|
2682
|
+
# resp.status #=> Integer
|
2683
|
+
# resp.request_id #=> String
|
2684
|
+
#
|
2685
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysis AWS API Documentation
|
2686
|
+
#
|
2687
|
+
# @overload describe_analysis(params = {})
|
2688
|
+
# @param [Hash] params ({})
|
2689
|
+
def describe_analysis(params = {}, options = {})
|
2690
|
+
req = build_request(:describe_analysis, params)
|
2691
|
+
req.send_request(options)
|
2692
|
+
end
|
2693
|
+
|
2694
|
+
# Provides the read and write permissions for an analysis.
|
2695
|
+
#
|
2696
|
+
# @option params [required, String] :aws_account_id
|
2697
|
+
# The ID of the AWS account that contains the analysis whose permissions
|
2698
|
+
# you're describing. You must be using the AWS account that the
|
2699
|
+
# analysis is in.
|
2700
|
+
#
|
2701
|
+
# @option params [required, String] :analysis_id
|
2702
|
+
# The ID of the analysis whose permissions you're describing. The ID is
|
2703
|
+
# part of the analysis URL.
|
2704
|
+
#
|
2705
|
+
# @return [Types::DescribeAnalysisPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2706
|
+
#
|
2707
|
+
# * {Types::DescribeAnalysisPermissionsResponse#analysis_id #analysis_id} => String
|
2708
|
+
# * {Types::DescribeAnalysisPermissionsResponse#analysis_arn #analysis_arn} => String
|
2709
|
+
# * {Types::DescribeAnalysisPermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission>
|
2710
|
+
# * {Types::DescribeAnalysisPermissionsResponse#status #status} => Integer
|
2711
|
+
# * {Types::DescribeAnalysisPermissionsResponse#request_id #request_id} => String
|
2712
|
+
#
|
2713
|
+
# @example Request syntax with placeholder values
|
2714
|
+
#
|
2715
|
+
# resp = client.describe_analysis_permissions({
|
2716
|
+
# aws_account_id: "AwsAccountId", # required
|
2717
|
+
# analysis_id: "RestrictiveResourceId", # required
|
2718
|
+
# })
|
2719
|
+
#
|
2720
|
+
# @example Response structure
|
2721
|
+
#
|
2722
|
+
# resp.analysis_id #=> String
|
2723
|
+
# resp.analysis_arn #=> String
|
2724
|
+
# resp.permissions #=> Array
|
2725
|
+
# resp.permissions[0].principal #=> String
|
2726
|
+
# resp.permissions[0].actions #=> Array
|
2727
|
+
# resp.permissions[0].actions[0] #=> String
|
2728
|
+
# resp.status #=> Integer
|
2729
|
+
# resp.request_id #=> String
|
2730
|
+
#
|
2731
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysisPermissions AWS API Documentation
|
2732
|
+
#
|
2733
|
+
# @overload describe_analysis_permissions(params = {})
|
2734
|
+
# @param [Hash] params ({})
|
2735
|
+
def describe_analysis_permissions(params = {}, options = {})
|
2736
|
+
req = build_request(:describe_analysis_permissions, params)
|
2737
|
+
req.send_request(options)
|
2738
|
+
end
|
2739
|
+
|
1710
2740
|
# Provides a summary for a dashboard.
|
1711
2741
|
#
|
1712
2742
|
# @option params [required, String] :aws_account_id
|
@@ -1748,12 +2778,13 @@ module Aws::QuickSight
|
|
1748
2778
|
# resp.dashboard.version.errors[0].type #=> String, one of "ACCESS_DENIED", "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE", "PARAMETER_VALUE_INCOMPATIBLE", "PARAMETER_TYPE_INVALID", "PARAMETER_NOT_FOUND", "COLUMN_TYPE_MISMATCH", "COLUMN_GEOGRAPHIC_ROLE_MISMATCH", "COLUMN_REPLACEMENT_MISSING"
|
1749
2779
|
# resp.dashboard.version.errors[0].message #=> String
|
1750
2780
|
# resp.dashboard.version.version_number #=> Integer
|
1751
|
-
# resp.dashboard.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
2781
|
+
# resp.dashboard.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
1752
2782
|
# resp.dashboard.version.arn #=> String
|
1753
2783
|
# resp.dashboard.version.source_entity_arn #=> String
|
1754
2784
|
# resp.dashboard.version.data_set_arns #=> Array
|
1755
2785
|
# resp.dashboard.version.data_set_arns[0] #=> String
|
1756
2786
|
# resp.dashboard.version.description #=> String
|
2787
|
+
# resp.dashboard.version.theme_arn #=> String
|
1757
2788
|
# resp.dashboard.created_time #=> Time
|
1758
2789
|
# resp.dashboard.last_published_time #=> Time
|
1759
2790
|
# resp.dashboard.last_updated_time #=> Time
|
@@ -1897,6 +2928,7 @@ module Aws::QuickSight
|
|
1897
2928
|
# resp.data_set.column_groups[0].geo_spatial_column_group.country_code #=> String, one of "US"
|
1898
2929
|
# resp.data_set.column_groups[0].geo_spatial_column_group.columns #=> Array
|
1899
2930
|
# resp.data_set.column_groups[0].geo_spatial_column_group.columns[0] #=> String
|
2931
|
+
# resp.data_set.row_level_permission_data_set.namespace #=> String
|
1900
2932
|
# resp.data_set.row_level_permission_data_set.arn #=> String
|
1901
2933
|
# resp.data_set.row_level_permission_data_set.permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS"
|
1902
2934
|
# resp.request_id #=> String
|
@@ -1986,7 +3018,7 @@ module Aws::QuickSight
|
|
1986
3018
|
# resp.data_source.data_source_id #=> String
|
1987
3019
|
# resp.data_source.name #=> String
|
1988
3020
|
# resp.data_source.type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER"
|
1989
|
-
# resp.data_source.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
3021
|
+
# resp.data_source.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
1990
3022
|
# resp.data_source.created_time #=> Time
|
1991
3023
|
# resp.data_source.last_updated_time #=> Time
|
1992
3024
|
# resp.data_source.data_source_parameters.amazon_elasticsearch_parameters.domain #=> String
|
@@ -2033,9 +3065,54 @@ module Aws::QuickSight
|
|
2033
3065
|
# resp.data_source.data_source_parameters.teradata_parameters.database #=> String
|
2034
3066
|
# resp.data_source.data_source_parameters.twitter_parameters.query #=> String
|
2035
3067
|
# resp.data_source.data_source_parameters.twitter_parameters.max_rows #=> Integer
|
3068
|
+
# resp.data_source.alternate_data_source_parameters #=> Array
|
3069
|
+
# resp.data_source.alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
|
3070
|
+
# resp.data_source.alternate_data_source_parameters[0].athena_parameters.work_group #=> String
|
3071
|
+
# resp.data_source.alternate_data_source_parameters[0].aurora_parameters.host #=> String
|
3072
|
+
# resp.data_source.alternate_data_source_parameters[0].aurora_parameters.port #=> Integer
|
3073
|
+
# resp.data_source.alternate_data_source_parameters[0].aurora_parameters.database #=> String
|
3074
|
+
# resp.data_source.alternate_data_source_parameters[0].aurora_postgre_sql_parameters.host #=> String
|
3075
|
+
# resp.data_source.alternate_data_source_parameters[0].aurora_postgre_sql_parameters.port #=> Integer
|
3076
|
+
# resp.data_source.alternate_data_source_parameters[0].aurora_postgre_sql_parameters.database #=> String
|
3077
|
+
# resp.data_source.alternate_data_source_parameters[0].aws_iot_analytics_parameters.data_set_name #=> String
|
3078
|
+
# resp.data_source.alternate_data_source_parameters[0].jira_parameters.site_base_url #=> String
|
3079
|
+
# resp.data_source.alternate_data_source_parameters[0].maria_db_parameters.host #=> String
|
3080
|
+
# resp.data_source.alternate_data_source_parameters[0].maria_db_parameters.port #=> Integer
|
3081
|
+
# resp.data_source.alternate_data_source_parameters[0].maria_db_parameters.database #=> String
|
3082
|
+
# resp.data_source.alternate_data_source_parameters[0].my_sql_parameters.host #=> String
|
3083
|
+
# resp.data_source.alternate_data_source_parameters[0].my_sql_parameters.port #=> Integer
|
3084
|
+
# resp.data_source.alternate_data_source_parameters[0].my_sql_parameters.database #=> String
|
3085
|
+
# resp.data_source.alternate_data_source_parameters[0].postgre_sql_parameters.host #=> String
|
3086
|
+
# resp.data_source.alternate_data_source_parameters[0].postgre_sql_parameters.port #=> Integer
|
3087
|
+
# resp.data_source.alternate_data_source_parameters[0].postgre_sql_parameters.database #=> String
|
3088
|
+
# resp.data_source.alternate_data_source_parameters[0].presto_parameters.host #=> String
|
3089
|
+
# resp.data_source.alternate_data_source_parameters[0].presto_parameters.port #=> Integer
|
3090
|
+
# resp.data_source.alternate_data_source_parameters[0].presto_parameters.catalog #=> String
|
3091
|
+
# resp.data_source.alternate_data_source_parameters[0].rds_parameters.instance_id #=> String
|
3092
|
+
# resp.data_source.alternate_data_source_parameters[0].rds_parameters.database #=> String
|
3093
|
+
# resp.data_source.alternate_data_source_parameters[0].redshift_parameters.host #=> String
|
3094
|
+
# resp.data_source.alternate_data_source_parameters[0].redshift_parameters.port #=> Integer
|
3095
|
+
# resp.data_source.alternate_data_source_parameters[0].redshift_parameters.database #=> String
|
3096
|
+
# resp.data_source.alternate_data_source_parameters[0].redshift_parameters.cluster_id #=> String
|
3097
|
+
# resp.data_source.alternate_data_source_parameters[0].s3_parameters.manifest_file_location.bucket #=> String
|
3098
|
+
# resp.data_source.alternate_data_source_parameters[0].s3_parameters.manifest_file_location.key #=> String
|
3099
|
+
# resp.data_source.alternate_data_source_parameters[0].service_now_parameters.site_base_url #=> String
|
3100
|
+
# resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.host #=> String
|
3101
|
+
# resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.database #=> String
|
3102
|
+
# resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.warehouse #=> String
|
3103
|
+
# resp.data_source.alternate_data_source_parameters[0].spark_parameters.host #=> String
|
3104
|
+
# resp.data_source.alternate_data_source_parameters[0].spark_parameters.port #=> Integer
|
3105
|
+
# resp.data_source.alternate_data_source_parameters[0].sql_server_parameters.host #=> String
|
3106
|
+
# resp.data_source.alternate_data_source_parameters[0].sql_server_parameters.port #=> Integer
|
3107
|
+
# resp.data_source.alternate_data_source_parameters[0].sql_server_parameters.database #=> String
|
3108
|
+
# resp.data_source.alternate_data_source_parameters[0].teradata_parameters.host #=> String
|
3109
|
+
# resp.data_source.alternate_data_source_parameters[0].teradata_parameters.port #=> Integer
|
3110
|
+
# resp.data_source.alternate_data_source_parameters[0].teradata_parameters.database #=> String
|
3111
|
+
# resp.data_source.alternate_data_source_parameters[0].twitter_parameters.query #=> String
|
3112
|
+
# resp.data_source.alternate_data_source_parameters[0].twitter_parameters.max_rows #=> Integer
|
2036
3113
|
# resp.data_source.vpc_connection_properties.vpc_connection_arn #=> String
|
2037
3114
|
# resp.data_source.ssl_properties.disable_ssl #=> Boolean
|
2038
|
-
# resp.data_source.error_info.type #=> String, one of "TIMEOUT", "ENGINE_VERSION_NOT_SUPPORTED", "UNKNOWN_HOST", "GENERIC_SQL_FAILURE", "CONFLICT", "UNKNOWN"
|
3115
|
+
# 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"
|
2039
3116
|
# resp.data_source.error_info.message #=> String
|
2040
3117
|
# resp.request_id #=> String
|
2041
3118
|
# resp.status #=> Integer
|
@@ -2241,6 +3318,49 @@ module Aws::QuickSight
|
|
2241
3318
|
req.send_request(options)
|
2242
3319
|
end
|
2243
3320
|
|
3321
|
+
# Describes the current namespace.
|
3322
|
+
#
|
3323
|
+
# @option params [required, String] :aws_account_id
|
3324
|
+
# The ID for the AWS account that contains the QuickSight namespace that
|
3325
|
+
# you want to describe.
|
3326
|
+
#
|
3327
|
+
# @option params [required, String] :namespace
|
3328
|
+
# The namespace that you want to describe.
|
3329
|
+
#
|
3330
|
+
# @return [Types::DescribeNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3331
|
+
#
|
3332
|
+
# * {Types::DescribeNamespaceResponse#namespace #namespace} => Types::NamespaceInfoV2
|
3333
|
+
# * {Types::DescribeNamespaceResponse#request_id #request_id} => String
|
3334
|
+
# * {Types::DescribeNamespaceResponse#status #status} => Integer
|
3335
|
+
#
|
3336
|
+
# @example Request syntax with placeholder values
|
3337
|
+
#
|
3338
|
+
# resp = client.describe_namespace({
|
3339
|
+
# aws_account_id: "AwsAccountId", # required
|
3340
|
+
# namespace: "Namespace", # required
|
3341
|
+
# })
|
3342
|
+
#
|
3343
|
+
# @example Response structure
|
3344
|
+
#
|
3345
|
+
# resp.namespace.name #=> String
|
3346
|
+
# resp.namespace.arn #=> String
|
3347
|
+
# resp.namespace.capacity_region #=> String
|
3348
|
+
# resp.namespace.creation_status #=> String, one of "CREATED", "CREATING", "DELETING", "RETRYABLE_FAILURE", "NON_RETRYABLE_FAILURE"
|
3349
|
+
# resp.namespace.identity_store #=> String, one of "QUICKSIGHT"
|
3350
|
+
# resp.namespace.namespace_error.type #=> String, one of "PERMISSION_DENIED", "INTERNAL_SERVICE_ERROR"
|
3351
|
+
# resp.namespace.namespace_error.message #=> String
|
3352
|
+
# resp.request_id #=> String
|
3353
|
+
# resp.status #=> Integer
|
3354
|
+
#
|
3355
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeNamespace AWS API Documentation
|
3356
|
+
#
|
3357
|
+
# @overload describe_namespace(params = {})
|
3358
|
+
# @param [Hash] params ({})
|
3359
|
+
def describe_namespace(params = {}, options = {})
|
3360
|
+
req = build_request(:describe_namespace, params)
|
3361
|
+
req.send_request(options)
|
3362
|
+
end
|
3363
|
+
|
2244
3364
|
# Describes a template's metadata.
|
2245
3365
|
#
|
2246
3366
|
# @option params [required, String] :aws_account_id
|
@@ -2266,6 +3386,7 @@ module Aws::QuickSight
|
|
2266
3386
|
#
|
2267
3387
|
# * {Types::DescribeTemplateResponse#template #template} => Types::Template
|
2268
3388
|
# * {Types::DescribeTemplateResponse#status #status} => Integer
|
3389
|
+
# * {Types::DescribeTemplateResponse#request_id #request_id} => String
|
2269
3390
|
#
|
2270
3391
|
# @example Request syntax with placeholder values
|
2271
3392
|
#
|
@@ -2282,10 +3403,10 @@ module Aws::QuickSight
|
|
2282
3403
|
# resp.template.name #=> String
|
2283
3404
|
# resp.template.version.created_time #=> Time
|
2284
3405
|
# resp.template.version.errors #=> Array
|
2285
|
-
# resp.template.version.errors[0].type #=> String, one of "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE"
|
3406
|
+
# resp.template.version.errors[0].type #=> String, one of "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE", "ACCESS_DENIED"
|
2286
3407
|
# resp.template.version.errors[0].message #=> String
|
2287
3408
|
# resp.template.version.version_number #=> Integer
|
2288
|
-
# resp.template.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
3409
|
+
# resp.template.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
2289
3410
|
# resp.template.version.data_set_configurations #=> Array
|
2290
3411
|
# resp.template.version.data_set_configurations[0].placeholder #=> String
|
2291
3412
|
# resp.template.version.data_set_configurations[0].data_set_schema.column_schema_list #=> Array
|
@@ -2298,10 +3419,12 @@ module Aws::QuickSight
|
|
2298
3419
|
# resp.template.version.data_set_configurations[0].column_group_schema_list[0].column_group_column_schema_list[0].name #=> String
|
2299
3420
|
# resp.template.version.description #=> String
|
2300
3421
|
# resp.template.version.source_entity_arn #=> String
|
3422
|
+
# resp.template.version.theme_arn #=> String
|
2301
3423
|
# resp.template.template_id #=> String
|
2302
3424
|
# resp.template.last_updated_time #=> Time
|
2303
3425
|
# resp.template.created_time #=> Time
|
2304
3426
|
# resp.status #=> Integer
|
3427
|
+
# resp.request_id #=> String
|
2305
3428
|
#
|
2306
3429
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTemplate AWS API Documentation
|
2307
3430
|
#
|
@@ -2403,6 +3526,182 @@ module Aws::QuickSight
|
|
2403
3526
|
req.send_request(options)
|
2404
3527
|
end
|
2405
3528
|
|
3529
|
+
# Describes a theme.
|
3530
|
+
#
|
3531
|
+
# @option params [required, String] :aws_account_id
|
3532
|
+
# The ID of the AWS account that contains the theme that you're
|
3533
|
+
# describing.
|
3534
|
+
#
|
3535
|
+
# @option params [required, String] :theme_id
|
3536
|
+
# The ID for the theme.
|
3537
|
+
#
|
3538
|
+
# @option params [Integer] :version_number
|
3539
|
+
# The version number for the version to describe. If a `VersionNumber`
|
3540
|
+
# parameter value isn't provided, the latest version of the theme is
|
3541
|
+
# described.
|
3542
|
+
#
|
3543
|
+
# @option params [String] :alias_name
|
3544
|
+
# The alias of the theme that you want to describe. If you name a
|
3545
|
+
# specific alias, you describe the version that the alias points to. You
|
3546
|
+
# can specify the latest version of the theme by providing the keyword
|
3547
|
+
# `$LATEST` in the `AliasName` parameter. The keyword `$PUBLISHED`
|
3548
|
+
# doesn't apply to themes.
|
3549
|
+
#
|
3550
|
+
# @return [Types::DescribeThemeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3551
|
+
#
|
3552
|
+
# * {Types::DescribeThemeResponse#theme #theme} => Types::Theme
|
3553
|
+
# * {Types::DescribeThemeResponse#status #status} => Integer
|
3554
|
+
# * {Types::DescribeThemeResponse#request_id #request_id} => String
|
3555
|
+
#
|
3556
|
+
# @example Request syntax with placeholder values
|
3557
|
+
#
|
3558
|
+
# resp = client.describe_theme({
|
3559
|
+
# aws_account_id: "AwsAndAccountId", # required
|
3560
|
+
# theme_id: "RestrictiveResourceId", # required
|
3561
|
+
# version_number: 1,
|
3562
|
+
# alias_name: "AliasName",
|
3563
|
+
# })
|
3564
|
+
#
|
3565
|
+
# @example Response structure
|
3566
|
+
#
|
3567
|
+
# resp.theme.arn #=> String
|
3568
|
+
# resp.theme.name #=> String
|
3569
|
+
# resp.theme.theme_id #=> String
|
3570
|
+
# resp.theme.version.version_number #=> Integer
|
3571
|
+
# resp.theme.version.arn #=> String
|
3572
|
+
# resp.theme.version.description #=> String
|
3573
|
+
# resp.theme.version.base_theme_id #=> String
|
3574
|
+
# resp.theme.version.created_time #=> Time
|
3575
|
+
# resp.theme.version.configuration.data_color_palette.colors #=> Array
|
3576
|
+
# resp.theme.version.configuration.data_color_palette.colors[0] #=> String
|
3577
|
+
# resp.theme.version.configuration.data_color_palette.min_max_gradient #=> Array
|
3578
|
+
# resp.theme.version.configuration.data_color_palette.min_max_gradient[0] #=> String
|
3579
|
+
# resp.theme.version.configuration.data_color_palette.empty_fill_color #=> String
|
3580
|
+
# resp.theme.version.configuration.ui_color_palette.primary_foreground #=> String
|
3581
|
+
# resp.theme.version.configuration.ui_color_palette.primary_background #=> String
|
3582
|
+
# resp.theme.version.configuration.ui_color_palette.secondary_foreground #=> String
|
3583
|
+
# resp.theme.version.configuration.ui_color_palette.secondary_background #=> String
|
3584
|
+
# resp.theme.version.configuration.ui_color_palette.accent #=> String
|
3585
|
+
# resp.theme.version.configuration.ui_color_palette.accent_foreground #=> String
|
3586
|
+
# resp.theme.version.configuration.ui_color_palette.danger #=> String
|
3587
|
+
# resp.theme.version.configuration.ui_color_palette.danger_foreground #=> String
|
3588
|
+
# resp.theme.version.configuration.ui_color_palette.warning #=> String
|
3589
|
+
# resp.theme.version.configuration.ui_color_palette.warning_foreground #=> String
|
3590
|
+
# resp.theme.version.configuration.ui_color_palette.success #=> String
|
3591
|
+
# resp.theme.version.configuration.ui_color_palette.success_foreground #=> String
|
3592
|
+
# resp.theme.version.configuration.ui_color_palette.dimension #=> String
|
3593
|
+
# resp.theme.version.configuration.ui_color_palette.dimension_foreground #=> String
|
3594
|
+
# resp.theme.version.configuration.ui_color_palette.measure #=> String
|
3595
|
+
# resp.theme.version.configuration.ui_color_palette.measure_foreground #=> String
|
3596
|
+
# resp.theme.version.configuration.sheet.tile.border.show #=> Boolean
|
3597
|
+
# resp.theme.version.configuration.sheet.tile_layout.gutter.show #=> Boolean
|
3598
|
+
# resp.theme.version.configuration.sheet.tile_layout.margin.show #=> Boolean
|
3599
|
+
# resp.theme.version.errors #=> Array
|
3600
|
+
# resp.theme.version.errors[0].type #=> String, one of "INTERNAL_FAILURE"
|
3601
|
+
# resp.theme.version.errors[0].message #=> String
|
3602
|
+
# resp.theme.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
3603
|
+
# resp.theme.created_time #=> Time
|
3604
|
+
# resp.theme.last_updated_time #=> Time
|
3605
|
+
# resp.theme.type #=> String, one of "QUICKSIGHT", "CUSTOM", "ALL"
|
3606
|
+
# resp.status #=> Integer
|
3607
|
+
# resp.request_id #=> String
|
3608
|
+
#
|
3609
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTheme AWS API Documentation
|
3610
|
+
#
|
3611
|
+
# @overload describe_theme(params = {})
|
3612
|
+
# @param [Hash] params ({})
|
3613
|
+
def describe_theme(params = {}, options = {})
|
3614
|
+
req = build_request(:describe_theme, params)
|
3615
|
+
req.send_request(options)
|
3616
|
+
end
|
3617
|
+
|
3618
|
+
# Describes the alias for a theme.
|
3619
|
+
#
|
3620
|
+
# @option params [required, String] :aws_account_id
|
3621
|
+
# The ID of the AWS account that contains the theme alias that you're
|
3622
|
+
# describing.
|
3623
|
+
#
|
3624
|
+
# @option params [required, String] :theme_id
|
3625
|
+
# The ID for the theme.
|
3626
|
+
#
|
3627
|
+
# @option params [required, String] :alias_name
|
3628
|
+
# The name of the theme alias that you want to describe.
|
3629
|
+
#
|
3630
|
+
# @return [Types::DescribeThemeAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3631
|
+
#
|
3632
|
+
# * {Types::DescribeThemeAliasResponse#theme_alias #theme_alias} => Types::ThemeAlias
|
3633
|
+
# * {Types::DescribeThemeAliasResponse#status #status} => Integer
|
3634
|
+
# * {Types::DescribeThemeAliasResponse#request_id #request_id} => String
|
3635
|
+
#
|
3636
|
+
# @example Request syntax with placeholder values
|
3637
|
+
#
|
3638
|
+
# resp = client.describe_theme_alias({
|
3639
|
+
# aws_account_id: "AwsAccountId", # required
|
3640
|
+
# theme_id: "RestrictiveResourceId", # required
|
3641
|
+
# alias_name: "AliasName", # required
|
3642
|
+
# })
|
3643
|
+
#
|
3644
|
+
# @example Response structure
|
3645
|
+
#
|
3646
|
+
# resp.theme_alias.arn #=> String
|
3647
|
+
# resp.theme_alias.alias_name #=> String
|
3648
|
+
# resp.theme_alias.theme_version_number #=> Integer
|
3649
|
+
# resp.status #=> Integer
|
3650
|
+
# resp.request_id #=> String
|
3651
|
+
#
|
3652
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeThemeAlias AWS API Documentation
|
3653
|
+
#
|
3654
|
+
# @overload describe_theme_alias(params = {})
|
3655
|
+
# @param [Hash] params ({})
|
3656
|
+
def describe_theme_alias(params = {}, options = {})
|
3657
|
+
req = build_request(:describe_theme_alias, params)
|
3658
|
+
req.send_request(options)
|
3659
|
+
end
|
3660
|
+
|
3661
|
+
# Describes the read and write permissions for a theme.
|
3662
|
+
#
|
3663
|
+
# @option params [required, String] :aws_account_id
|
3664
|
+
# The ID of the AWS account that contains the theme that you're
|
3665
|
+
# describing.
|
3666
|
+
#
|
3667
|
+
# @option params [required, String] :theme_id
|
3668
|
+
# The ID for the theme that you want to describe permissions for.
|
3669
|
+
#
|
3670
|
+
# @return [Types::DescribeThemePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3671
|
+
#
|
3672
|
+
# * {Types::DescribeThemePermissionsResponse#theme_id #theme_id} => String
|
3673
|
+
# * {Types::DescribeThemePermissionsResponse#theme_arn #theme_arn} => String
|
3674
|
+
# * {Types::DescribeThemePermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission>
|
3675
|
+
# * {Types::DescribeThemePermissionsResponse#request_id #request_id} => String
|
3676
|
+
# * {Types::DescribeThemePermissionsResponse#status #status} => Integer
|
3677
|
+
#
|
3678
|
+
# @example Request syntax with placeholder values
|
3679
|
+
#
|
3680
|
+
# resp = client.describe_theme_permissions({
|
3681
|
+
# aws_account_id: "AwsAccountId", # required
|
3682
|
+
# theme_id: "RestrictiveResourceId", # required
|
3683
|
+
# })
|
3684
|
+
#
|
3685
|
+
# @example Response structure
|
3686
|
+
#
|
3687
|
+
# resp.theme_id #=> String
|
3688
|
+
# resp.theme_arn #=> String
|
3689
|
+
# resp.permissions #=> Array
|
3690
|
+
# resp.permissions[0].principal #=> String
|
3691
|
+
# resp.permissions[0].actions #=> Array
|
3692
|
+
# resp.permissions[0].actions[0] #=> String
|
3693
|
+
# resp.request_id #=> String
|
3694
|
+
# resp.status #=> Integer
|
3695
|
+
#
|
3696
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeThemePermissions AWS API Documentation
|
3697
|
+
#
|
3698
|
+
# @overload describe_theme_permissions(params = {})
|
3699
|
+
# @param [Hash] params ({})
|
3700
|
+
def describe_theme_permissions(params = {}, options = {})
|
3701
|
+
req = build_request(:describe_theme_permissions, params)
|
3702
|
+
req.send_request(options)
|
3703
|
+
end
|
3704
|
+
|
2406
3705
|
# Returns information about a user, given the user name.
|
2407
3706
|
#
|
2408
3707
|
# @option params [required, String] :user_name
|
@@ -2438,6 +3737,7 @@ module Aws::QuickSight
|
|
2438
3737
|
# resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
|
2439
3738
|
# resp.user.active #=> Boolean
|
2440
3739
|
# resp.user.principal_id #=> String
|
3740
|
+
# resp.user.custom_permissions_name #=> String
|
2441
3741
|
# resp.request_id #=> String
|
2442
3742
|
# resp.status #=> Integer
|
2443
3743
|
#
|
@@ -2450,72 +3750,178 @@ module Aws::QuickSight
|
|
2450
3750
|
req.send_request(options)
|
2451
3751
|
end
|
2452
3752
|
|
2453
|
-
# Generates a
|
2454
|
-
#
|
2455
|
-
#
|
2456
|
-
#
|
2457
|
-
# Amazon QuickSight Dashboards][2] in the *Amazon QuickSight API
|
2458
|
-
# Reference*.
|
3753
|
+
# Generates a session URL and authorization code that you can use to
|
3754
|
+
# embed an Amazon QuickSight read-only dashboard in your web server
|
3755
|
+
# code. Before you use this command, make sure that you have configured
|
3756
|
+
# the dashboards and permissions.
|
2459
3757
|
#
|
2460
3758
|
# Currently, you can use `GetDashboardEmbedURL` only from the server,
|
2461
|
-
# not from the user
|
3759
|
+
# not from the user's browser. The following rules apply to the
|
3760
|
+
# combination of URL and authorization code:
|
3761
|
+
#
|
3762
|
+
# * They must be used together.
|
3763
|
+
#
|
3764
|
+
# * They can be used one time only.
|
3765
|
+
#
|
3766
|
+
# * They are valid for 5 minutes after you run this command.
|
3767
|
+
#
|
3768
|
+
# * The resulting user session is valid for 10 hours.
|
3769
|
+
#
|
3770
|
+
# For more information, see [Embedding Amazon QuickSight][1] in the
|
3771
|
+
# *Amazon QuickSight User Guide* .
|
2462
3772
|
#
|
2463
3773
|
#
|
2464
3774
|
#
|
2465
3775
|
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedding-dashboards.html
|
2466
|
-
# [2]: https://docs.aws.amazon.com/quicksight/latest/APIReference/qs-dev-embedded-dashboards.html
|
2467
3776
|
#
|
2468
3777
|
# @option params [required, String] :aws_account_id
|
2469
3778
|
# The ID for the AWS account that contains the dashboard that you're
|
2470
3779
|
# embedding.
|
2471
3780
|
#
|
2472
|
-
# @option params [required, String] :dashboard_id
|
2473
|
-
# The ID for the dashboard, also added to the IAM policy.
|
3781
|
+
# @option params [required, String] :dashboard_id
|
3782
|
+
# The ID for the dashboard, also added to the IAM policy.
|
3783
|
+
#
|
3784
|
+
# @option params [required, String] :identity_type
|
3785
|
+
# The authentication method that the user uses to sign in.
|
3786
|
+
#
|
3787
|
+
# @option params [Integer] :session_lifetime_in_minutes
|
3788
|
+
# How many minutes the session is valid. The session lifetime must be
|
3789
|
+
# 15-600 minutes.
|
3790
|
+
#
|
3791
|
+
# @option params [Boolean] :undo_redo_disabled
|
3792
|
+
# Remove the undo/redo button on the embedded dashboard. The default is
|
3793
|
+
# FALSE, which enables the undo/redo button.
|
3794
|
+
#
|
3795
|
+
# @option params [Boolean] :reset_disabled
|
3796
|
+
# Remove the reset button on the embedded dashboard. The default is
|
3797
|
+
# FALSE, which enables the reset button.
|
3798
|
+
#
|
3799
|
+
# @option params [String] :user_arn
|
3800
|
+
# The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
|
3801
|
+
# `QUICKSIGHT` identity type. You can use this for any Amazon QuickSight
|
3802
|
+
# users in your account (readers, authors, or admins) authenticated as
|
3803
|
+
# one of the following:
|
3804
|
+
#
|
3805
|
+
# * Active Directory (AD) users or group members
|
3806
|
+
#
|
3807
|
+
# * Invited nonfederated users
|
3808
|
+
#
|
3809
|
+
# * IAM users and IAM role-based sessions authenticated through
|
3810
|
+
# Federated Single Sign-On using SAML, OpenID Connect, or IAM
|
3811
|
+
# federation.
|
3812
|
+
#
|
3813
|
+
# Omit this parameter for users in the third group – IAM users and IAM
|
3814
|
+
# role-based sessions.
|
3815
|
+
#
|
3816
|
+
# @return [Types::GetDashboardEmbedUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3817
|
+
#
|
3818
|
+
# * {Types::GetDashboardEmbedUrlResponse#embed_url #embed_url} => String
|
3819
|
+
# * {Types::GetDashboardEmbedUrlResponse#status #status} => Integer
|
3820
|
+
# * {Types::GetDashboardEmbedUrlResponse#request_id #request_id} => String
|
3821
|
+
#
|
3822
|
+
# @example Request syntax with placeholder values
|
3823
|
+
#
|
3824
|
+
# resp = client.get_dashboard_embed_url({
|
3825
|
+
# aws_account_id: "AwsAccountId", # required
|
3826
|
+
# dashboard_id: "RestrictiveResourceId", # required
|
3827
|
+
# identity_type: "IAM", # required, accepts IAM, QUICKSIGHT
|
3828
|
+
# session_lifetime_in_minutes: 1,
|
3829
|
+
# undo_redo_disabled: false,
|
3830
|
+
# reset_disabled: false,
|
3831
|
+
# user_arn: "Arn",
|
3832
|
+
# })
|
3833
|
+
#
|
3834
|
+
# @example Response structure
|
3835
|
+
#
|
3836
|
+
# resp.embed_url #=> String
|
3837
|
+
# resp.status #=> Integer
|
3838
|
+
# resp.request_id #=> String
|
3839
|
+
#
|
3840
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetDashboardEmbedUrl AWS API Documentation
|
3841
|
+
#
|
3842
|
+
# @overload get_dashboard_embed_url(params = {})
|
3843
|
+
# @param [Hash] params ({})
|
3844
|
+
def get_dashboard_embed_url(params = {}, options = {})
|
3845
|
+
req = build_request(:get_dashboard_embed_url, params)
|
3846
|
+
req.send_request(options)
|
3847
|
+
end
|
3848
|
+
|
3849
|
+
# Generates a session URL and authorization code that you can use to
|
3850
|
+
# embed the Amazon QuickSight console in your web server code. Use
|
3851
|
+
# `GetSessionEmbedUrl` where you want to provide an authoring portal
|
3852
|
+
# that allows users to create data sources, datasets, analyses, and
|
3853
|
+
# dashboards. The users who access an embedded QuickSight console need
|
3854
|
+
# belong to the author or admin security cohort. If you want to restrict
|
3855
|
+
# permissions to some of these features, add a custom permissions
|
3856
|
+
# profile to the user with the ` UpdateUser ` API operation. Use `
|
3857
|
+
# RegisterUser ` API operation to add a new user with a custom
|
3858
|
+
# permission profile attached. For more information, see the following
|
3859
|
+
# sections in the *Amazon QuickSight User Guide*\:
|
3860
|
+
#
|
3861
|
+
# * [Embedding the Amazon QuickSight Console][1]
|
3862
|
+
#
|
3863
|
+
# * [Customizing Access to the Amazon QuickSight Console][2]
|
3864
|
+
#
|
3865
|
+
#
|
3866
|
+
#
|
3867
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedding-the-quicksight-console.html
|
3868
|
+
# [2]: https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html
|
3869
|
+
#
|
3870
|
+
# @option params [required, String] :aws_account_id
|
3871
|
+
# The ID for the AWS account associated with your QuickSight
|
3872
|
+
# subscription.
|
3873
|
+
#
|
3874
|
+
# @option params [String] :entry_point
|
3875
|
+
# The URL you use to access the embedded session. The entry point URL is
|
3876
|
+
# constrained to the following paths:
|
3877
|
+
#
|
3878
|
+
# * `/start`
|
3879
|
+
#
|
3880
|
+
# * `/start/analyses`
|
3881
|
+
#
|
3882
|
+
# * `/start/dashboards`
|
2474
3883
|
#
|
2475
|
-
#
|
2476
|
-
#
|
3884
|
+
# * `/start/favorites`
|
3885
|
+
#
|
3886
|
+
# * `/dashboards/DashboardId ` - where `DashboardId` is the actual ID
|
3887
|
+
# key from the QuickSight console URL of the dashboard
|
3888
|
+
#
|
3889
|
+
# * `/analyses/AnalysisId ` - where `AnalysisId` is the actual ID key
|
3890
|
+
# from the QuickSight console URL of the analysis
|
2477
3891
|
#
|
2478
3892
|
# @option params [Integer] :session_lifetime_in_minutes
|
2479
3893
|
# How many minutes the session is valid. The session lifetime must be
|
2480
3894
|
# 15-600 minutes.
|
2481
3895
|
#
|
2482
|
-
# @option params [Boolean] :undo_redo_disabled
|
2483
|
-
# Remove the undo/redo button on the embedded dashboard. The default is
|
2484
|
-
# FALSE, which enables the undo/redo button.
|
2485
|
-
#
|
2486
|
-
# @option params [Boolean] :reset_disabled
|
2487
|
-
# Remove the reset button on the embedded dashboard. The default is
|
2488
|
-
# FALSE, which enables the reset button.
|
2489
|
-
#
|
2490
3896
|
# @option params [String] :user_arn
|
2491
3897
|
# The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
|
2492
|
-
# `QUICKSIGHT` identity type. You can use this for any Amazon
|
2493
|
-
# users in your account (readers, authors, or admins)
|
2494
|
-
# one of the following:
|
3898
|
+
# `QUICKSIGHT` identity type. You can use this for any type of Amazon
|
3899
|
+
# QuickSight users in your account (readers, authors, or admins). They
|
3900
|
+
# need to be authenticated as one of the following:
|
2495
3901
|
#
|
2496
|
-
#
|
3902
|
+
# 1. Active Directory (AD) users or group members
|
2497
3903
|
#
|
2498
|
-
#
|
3904
|
+
# 2. Invited nonfederated users
|
2499
3905
|
#
|
2500
|
-
#
|
2501
|
-
#
|
2502
|
-
#
|
3906
|
+
# 3. IAM users and IAM role-based sessions authenticated through
|
3907
|
+
# Federated Single Sign-On using SAML, OpenID Connect, or IAM
|
3908
|
+
# federation
|
2503
3909
|
#
|
2504
|
-
#
|
3910
|
+
# Omit this parameter for users in the third group – IAM users and IAM
|
3911
|
+
# role-based sessions.
|
2505
3912
|
#
|
2506
|
-
#
|
2507
|
-
#
|
2508
|
-
# * {Types::
|
3913
|
+
# @return [Types::GetSessionEmbedUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3914
|
+
#
|
3915
|
+
# * {Types::GetSessionEmbedUrlResponse#embed_url #embed_url} => String
|
3916
|
+
# * {Types::GetSessionEmbedUrlResponse#status #status} => Integer
|
3917
|
+
# * {Types::GetSessionEmbedUrlResponse#request_id #request_id} => String
|
2509
3918
|
#
|
2510
3919
|
# @example Request syntax with placeholder values
|
2511
3920
|
#
|
2512
|
-
# resp = client.
|
3921
|
+
# resp = client.get_session_embed_url({
|
2513
3922
|
# aws_account_id: "AwsAccountId", # required
|
2514
|
-
#
|
2515
|
-
# identity_type: "IAM", # required, accepts IAM, QUICKSIGHT
|
3923
|
+
# entry_point: "EntryPoint",
|
2516
3924
|
# session_lifetime_in_minutes: 1,
|
2517
|
-
# undo_redo_disabled: false,
|
2518
|
-
# reset_disabled: false,
|
2519
3925
|
# user_arn: "Arn",
|
2520
3926
|
# })
|
2521
3927
|
#
|
@@ -2525,12 +3931,63 @@ module Aws::QuickSight
|
|
2525
3931
|
# resp.status #=> Integer
|
2526
3932
|
# resp.request_id #=> String
|
2527
3933
|
#
|
2528
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
3934
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetSessionEmbedUrl AWS API Documentation
|
2529
3935
|
#
|
2530
|
-
# @overload
|
3936
|
+
# @overload get_session_embed_url(params = {})
|
2531
3937
|
# @param [Hash] params ({})
|
2532
|
-
def
|
2533
|
-
req = build_request(:
|
3938
|
+
def get_session_embed_url(params = {}, options = {})
|
3939
|
+
req = build_request(:get_session_embed_url, params)
|
3940
|
+
req.send_request(options)
|
3941
|
+
end
|
3942
|
+
|
3943
|
+
# Lists Amazon QuickSight analyses that exist in the specified AWS
|
3944
|
+
# account.
|
3945
|
+
#
|
3946
|
+
# @option params [required, String] :aws_account_id
|
3947
|
+
# The ID of the AWS account that contains the analyses.
|
3948
|
+
#
|
3949
|
+
# @option params [String] :next_token
|
3950
|
+
# A pagination token that can be used in a subsequent request.
|
3951
|
+
#
|
3952
|
+
# @option params [Integer] :max_results
|
3953
|
+
# The maximum number of results to return.
|
3954
|
+
#
|
3955
|
+
# @return [Types::ListAnalysesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3956
|
+
#
|
3957
|
+
# * {Types::ListAnalysesResponse#analysis_summary_list #analysis_summary_list} => Array<Types::AnalysisSummary>
|
3958
|
+
# * {Types::ListAnalysesResponse#next_token #next_token} => String
|
3959
|
+
# * {Types::ListAnalysesResponse#status #status} => Integer
|
3960
|
+
# * {Types::ListAnalysesResponse#request_id #request_id} => String
|
3961
|
+
#
|
3962
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3963
|
+
#
|
3964
|
+
# @example Request syntax with placeholder values
|
3965
|
+
#
|
3966
|
+
# resp = client.list_analyses({
|
3967
|
+
# aws_account_id: "AwsAccountId", # required
|
3968
|
+
# next_token: "String",
|
3969
|
+
# max_results: 1,
|
3970
|
+
# })
|
3971
|
+
#
|
3972
|
+
# @example Response structure
|
3973
|
+
#
|
3974
|
+
# resp.analysis_summary_list #=> Array
|
3975
|
+
# resp.analysis_summary_list[0].arn #=> String
|
3976
|
+
# resp.analysis_summary_list[0].analysis_id #=> String
|
3977
|
+
# resp.analysis_summary_list[0].name #=> String
|
3978
|
+
# resp.analysis_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
3979
|
+
# resp.analysis_summary_list[0].created_time #=> Time
|
3980
|
+
# resp.analysis_summary_list[0].last_updated_time #=> Time
|
3981
|
+
# resp.next_token #=> String
|
3982
|
+
# resp.status #=> Integer
|
3983
|
+
# resp.request_id #=> String
|
3984
|
+
#
|
3985
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListAnalyses AWS API Documentation
|
3986
|
+
#
|
3987
|
+
# @overload list_analyses(params = {})
|
3988
|
+
# @param [Hash] params ({})
|
3989
|
+
def list_analyses(params = {}, options = {})
|
3990
|
+
req = build_request(:list_analyses, params)
|
2534
3991
|
req.send_request(options)
|
2535
3992
|
end
|
2536
3993
|
|
@@ -2575,7 +4032,7 @@ module Aws::QuickSight
|
|
2575
4032
|
# resp.dashboard_version_summary_list[0].arn #=> String
|
2576
4033
|
# resp.dashboard_version_summary_list[0].created_time #=> Time
|
2577
4034
|
# resp.dashboard_version_summary_list[0].version_number #=> Integer
|
2578
|
-
# resp.dashboard_version_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
4035
|
+
# resp.dashboard_version_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
2579
4036
|
# resp.dashboard_version_summary_list[0].source_entity_arn #=> String
|
2580
4037
|
# resp.dashboard_version_summary_list[0].description #=> String
|
2581
4038
|
# resp.next_token #=> String
|
@@ -2686,6 +4143,7 @@ module Aws::QuickSight
|
|
2686
4143
|
# resp.data_set_summaries[0].created_time #=> Time
|
2687
4144
|
# resp.data_set_summaries[0].last_updated_time #=> Time
|
2688
4145
|
# resp.data_set_summaries[0].import_mode #=> String, one of "SPICE", "DIRECT_QUERY"
|
4146
|
+
# resp.data_set_summaries[0].row_level_permission_data_set.namespace #=> String
|
2689
4147
|
# resp.data_set_summaries[0].row_level_permission_data_set.arn #=> String
|
2690
4148
|
# resp.data_set_summaries[0].row_level_permission_data_set.permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS"
|
2691
4149
|
# resp.next_token #=> String
|
@@ -2738,7 +4196,7 @@ module Aws::QuickSight
|
|
2738
4196
|
# resp.data_sources[0].data_source_id #=> String
|
2739
4197
|
# resp.data_sources[0].name #=> String
|
2740
4198
|
# resp.data_sources[0].type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER"
|
2741
|
-
# resp.data_sources[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
4199
|
+
# resp.data_sources[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
2742
4200
|
# resp.data_sources[0].created_time #=> Time
|
2743
4201
|
# resp.data_sources[0].last_updated_time #=> Time
|
2744
4202
|
# resp.data_sources[0].data_source_parameters.amazon_elasticsearch_parameters.domain #=> String
|
@@ -2785,9 +4243,54 @@ module Aws::QuickSight
|
|
2785
4243
|
# resp.data_sources[0].data_source_parameters.teradata_parameters.database #=> String
|
2786
4244
|
# resp.data_sources[0].data_source_parameters.twitter_parameters.query #=> String
|
2787
4245
|
# resp.data_sources[0].data_source_parameters.twitter_parameters.max_rows #=> Integer
|
4246
|
+
# resp.data_sources[0].alternate_data_source_parameters #=> Array
|
4247
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
|
4248
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].athena_parameters.work_group #=> String
|
4249
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].aurora_parameters.host #=> String
|
4250
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].aurora_parameters.port #=> Integer
|
4251
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].aurora_parameters.database #=> String
|
4252
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].aurora_postgre_sql_parameters.host #=> String
|
4253
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].aurora_postgre_sql_parameters.port #=> Integer
|
4254
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].aurora_postgre_sql_parameters.database #=> String
|
4255
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].aws_iot_analytics_parameters.data_set_name #=> String
|
4256
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].jira_parameters.site_base_url #=> String
|
4257
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].maria_db_parameters.host #=> String
|
4258
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].maria_db_parameters.port #=> Integer
|
4259
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].maria_db_parameters.database #=> String
|
4260
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].my_sql_parameters.host #=> String
|
4261
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].my_sql_parameters.port #=> Integer
|
4262
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].my_sql_parameters.database #=> String
|
4263
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].postgre_sql_parameters.host #=> String
|
4264
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].postgre_sql_parameters.port #=> Integer
|
4265
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].postgre_sql_parameters.database #=> String
|
4266
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].presto_parameters.host #=> String
|
4267
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].presto_parameters.port #=> Integer
|
4268
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].presto_parameters.catalog #=> String
|
4269
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].rds_parameters.instance_id #=> String
|
4270
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].rds_parameters.database #=> String
|
4271
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.host #=> String
|
4272
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.port #=> Integer
|
4273
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.database #=> String
|
4274
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.cluster_id #=> String
|
4275
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].s3_parameters.manifest_file_location.bucket #=> String
|
4276
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].s3_parameters.manifest_file_location.key #=> String
|
4277
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].service_now_parameters.site_base_url #=> String
|
4278
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.host #=> String
|
4279
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.database #=> String
|
4280
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.warehouse #=> String
|
4281
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].spark_parameters.host #=> String
|
4282
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].spark_parameters.port #=> Integer
|
4283
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].sql_server_parameters.host #=> String
|
4284
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].sql_server_parameters.port #=> Integer
|
4285
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].sql_server_parameters.database #=> String
|
4286
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].teradata_parameters.host #=> String
|
4287
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].teradata_parameters.port #=> Integer
|
4288
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].teradata_parameters.database #=> String
|
4289
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].twitter_parameters.query #=> String
|
4290
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].twitter_parameters.max_rows #=> Integer
|
2788
4291
|
# resp.data_sources[0].vpc_connection_properties.vpc_connection_arn #=> String
|
2789
4292
|
# resp.data_sources[0].ssl_properties.disable_ssl #=> Boolean
|
2790
|
-
# resp.data_sources[0].error_info.type #=> String, one of "TIMEOUT", "ENGINE_VERSION_NOT_SUPPORTED", "UNKNOWN_HOST", "GENERIC_SQL_FAILURE", "CONFLICT", "UNKNOWN"
|
4293
|
+
# 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"
|
2791
4294
|
# resp.data_sources[0].error_info.message #=> String
|
2792
4295
|
# resp.next_token #=> String
|
2793
4296
|
# resp.request_id #=> String
|
@@ -3079,6 +4582,58 @@ module Aws::QuickSight
|
|
3079
4582
|
req.send_request(options)
|
3080
4583
|
end
|
3081
4584
|
|
4585
|
+
# Lists the namespaces for the specified AWS account.
|
4586
|
+
#
|
4587
|
+
# @option params [required, String] :aws_account_id
|
4588
|
+
# The ID for the AWS account that contains the QuickSight namespaces
|
4589
|
+
# that you want to list.
|
4590
|
+
#
|
4591
|
+
# @option params [String] :next_token
|
4592
|
+
# A pagination token that can be used in a subsequent request.
|
4593
|
+
#
|
4594
|
+
# @option params [Integer] :max_results
|
4595
|
+
# The maximum number of results to return.
|
4596
|
+
#
|
4597
|
+
# @return [Types::ListNamespacesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4598
|
+
#
|
4599
|
+
# * {Types::ListNamespacesResponse#namespaces #namespaces} => Array<Types::NamespaceInfoV2>
|
4600
|
+
# * {Types::ListNamespacesResponse#next_token #next_token} => String
|
4601
|
+
# * {Types::ListNamespacesResponse#request_id #request_id} => String
|
4602
|
+
# * {Types::ListNamespacesResponse#status #status} => Integer
|
4603
|
+
#
|
4604
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4605
|
+
#
|
4606
|
+
# @example Request syntax with placeholder values
|
4607
|
+
#
|
4608
|
+
# resp = client.list_namespaces({
|
4609
|
+
# aws_account_id: "AwsAccountId", # required
|
4610
|
+
# next_token: "String",
|
4611
|
+
# max_results: 1,
|
4612
|
+
# })
|
4613
|
+
#
|
4614
|
+
# @example Response structure
|
4615
|
+
#
|
4616
|
+
# resp.namespaces #=> Array
|
4617
|
+
# resp.namespaces[0].name #=> String
|
4618
|
+
# resp.namespaces[0].arn #=> String
|
4619
|
+
# resp.namespaces[0].capacity_region #=> String
|
4620
|
+
# resp.namespaces[0].creation_status #=> String, one of "CREATED", "CREATING", "DELETING", "RETRYABLE_FAILURE", "NON_RETRYABLE_FAILURE"
|
4621
|
+
# resp.namespaces[0].identity_store #=> String, one of "QUICKSIGHT"
|
4622
|
+
# resp.namespaces[0].namespace_error.type #=> String, one of "PERMISSION_DENIED", "INTERNAL_SERVICE_ERROR"
|
4623
|
+
# resp.namespaces[0].namespace_error.message #=> String
|
4624
|
+
# resp.next_token #=> String
|
4625
|
+
# resp.request_id #=> String
|
4626
|
+
# resp.status #=> Integer
|
4627
|
+
#
|
4628
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListNamespaces AWS API Documentation
|
4629
|
+
#
|
4630
|
+
# @overload list_namespaces(params = {})
|
4631
|
+
# @param [Hash] params ({})
|
4632
|
+
def list_namespaces(params = {}, options = {})
|
4633
|
+
req = build_request(:list_namespaces, params)
|
4634
|
+
req.send_request(options)
|
4635
|
+
end
|
4636
|
+
|
3082
4637
|
# Lists the tags assigned to a resource.
|
3083
4638
|
#
|
3084
4639
|
# @option params [required, String] :resource_arn
|
@@ -3120,8 +4675,169 @@ module Aws::QuickSight
|
|
3120
4675
|
# The ID of the AWS account that contains the template aliases that
|
3121
4676
|
# you're listing.
|
3122
4677
|
#
|
3123
|
-
# @option params [required, String] :template_id
|
3124
|
-
# The ID for the template.
|
4678
|
+
# @option params [required, String] :template_id
|
4679
|
+
# The ID for the template.
|
4680
|
+
#
|
4681
|
+
# @option params [String] :next_token
|
4682
|
+
# The token for the next set of results, or null if there are no more
|
4683
|
+
# results.
|
4684
|
+
#
|
4685
|
+
# @option params [Integer] :max_results
|
4686
|
+
# The maximum number of results to be returned per request.
|
4687
|
+
#
|
4688
|
+
# @return [Types::ListTemplateAliasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4689
|
+
#
|
4690
|
+
# * {Types::ListTemplateAliasesResponse#template_alias_list #template_alias_list} => Array<Types::TemplateAlias>
|
4691
|
+
# * {Types::ListTemplateAliasesResponse#status #status} => Integer
|
4692
|
+
# * {Types::ListTemplateAliasesResponse#request_id #request_id} => String
|
4693
|
+
# * {Types::ListTemplateAliasesResponse#next_token #next_token} => String
|
4694
|
+
#
|
4695
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4696
|
+
#
|
4697
|
+
# @example Request syntax with placeholder values
|
4698
|
+
#
|
4699
|
+
# resp = client.list_template_aliases({
|
4700
|
+
# aws_account_id: "AwsAccountId", # required
|
4701
|
+
# template_id: "RestrictiveResourceId", # required
|
4702
|
+
# next_token: "String",
|
4703
|
+
# max_results: 1,
|
4704
|
+
# })
|
4705
|
+
#
|
4706
|
+
# @example Response structure
|
4707
|
+
#
|
4708
|
+
# resp.template_alias_list #=> Array
|
4709
|
+
# resp.template_alias_list[0].alias_name #=> String
|
4710
|
+
# resp.template_alias_list[0].arn #=> String
|
4711
|
+
# resp.template_alias_list[0].template_version_number #=> Integer
|
4712
|
+
# resp.status #=> Integer
|
4713
|
+
# resp.request_id #=> String
|
4714
|
+
# resp.next_token #=> String
|
4715
|
+
#
|
4716
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTemplateAliases AWS API Documentation
|
4717
|
+
#
|
4718
|
+
# @overload list_template_aliases(params = {})
|
4719
|
+
# @param [Hash] params ({})
|
4720
|
+
def list_template_aliases(params = {}, options = {})
|
4721
|
+
req = build_request(:list_template_aliases, params)
|
4722
|
+
req.send_request(options)
|
4723
|
+
end
|
4724
|
+
|
4725
|
+
# Lists all the versions of the templates in the current Amazon
|
4726
|
+
# QuickSight account.
|
4727
|
+
#
|
4728
|
+
# @option params [required, String] :aws_account_id
|
4729
|
+
# The ID of the AWS account that contains the templates that you're
|
4730
|
+
# listing.
|
4731
|
+
#
|
4732
|
+
# @option params [required, String] :template_id
|
4733
|
+
# The ID for the template.
|
4734
|
+
#
|
4735
|
+
# @option params [String] :next_token
|
4736
|
+
# The token for the next set of results, or null if there are no more
|
4737
|
+
# results.
|
4738
|
+
#
|
4739
|
+
# @option params [Integer] :max_results
|
4740
|
+
# The maximum number of results to be returned per request.
|
4741
|
+
#
|
4742
|
+
# @return [Types::ListTemplateVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4743
|
+
#
|
4744
|
+
# * {Types::ListTemplateVersionsResponse#template_version_summary_list #template_version_summary_list} => Array<Types::TemplateVersionSummary>
|
4745
|
+
# * {Types::ListTemplateVersionsResponse#next_token #next_token} => String
|
4746
|
+
# * {Types::ListTemplateVersionsResponse#status #status} => Integer
|
4747
|
+
# * {Types::ListTemplateVersionsResponse#request_id #request_id} => String
|
4748
|
+
#
|
4749
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4750
|
+
#
|
4751
|
+
# @example Request syntax with placeholder values
|
4752
|
+
#
|
4753
|
+
# resp = client.list_template_versions({
|
4754
|
+
# aws_account_id: "AwsAccountId", # required
|
4755
|
+
# template_id: "RestrictiveResourceId", # required
|
4756
|
+
# next_token: "String",
|
4757
|
+
# max_results: 1,
|
4758
|
+
# })
|
4759
|
+
#
|
4760
|
+
# @example Response structure
|
4761
|
+
#
|
4762
|
+
# resp.template_version_summary_list #=> Array
|
4763
|
+
# resp.template_version_summary_list[0].arn #=> String
|
4764
|
+
# resp.template_version_summary_list[0].version_number #=> Integer
|
4765
|
+
# resp.template_version_summary_list[0].created_time #=> Time
|
4766
|
+
# resp.template_version_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
4767
|
+
# resp.template_version_summary_list[0].description #=> String
|
4768
|
+
# resp.next_token #=> String
|
4769
|
+
# resp.status #=> Integer
|
4770
|
+
# resp.request_id #=> String
|
4771
|
+
#
|
4772
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTemplateVersions AWS API Documentation
|
4773
|
+
#
|
4774
|
+
# @overload list_template_versions(params = {})
|
4775
|
+
# @param [Hash] params ({})
|
4776
|
+
def list_template_versions(params = {}, options = {})
|
4777
|
+
req = build_request(:list_template_versions, params)
|
4778
|
+
req.send_request(options)
|
4779
|
+
end
|
4780
|
+
|
4781
|
+
# Lists all the templates in the current Amazon QuickSight account.
|
4782
|
+
#
|
4783
|
+
# @option params [required, String] :aws_account_id
|
4784
|
+
# The ID of the AWS account that contains the templates that you're
|
4785
|
+
# listing.
|
4786
|
+
#
|
4787
|
+
# @option params [String] :next_token
|
4788
|
+
# The token for the next set of results, or null if there are no more
|
4789
|
+
# results.
|
4790
|
+
#
|
4791
|
+
# @option params [Integer] :max_results
|
4792
|
+
# The maximum number of results to be returned per request.
|
4793
|
+
#
|
4794
|
+
# @return [Types::ListTemplatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4795
|
+
#
|
4796
|
+
# * {Types::ListTemplatesResponse#template_summary_list #template_summary_list} => Array<Types::TemplateSummary>
|
4797
|
+
# * {Types::ListTemplatesResponse#next_token #next_token} => String
|
4798
|
+
# * {Types::ListTemplatesResponse#status #status} => Integer
|
4799
|
+
# * {Types::ListTemplatesResponse#request_id #request_id} => String
|
4800
|
+
#
|
4801
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4802
|
+
#
|
4803
|
+
# @example Request syntax with placeholder values
|
4804
|
+
#
|
4805
|
+
# resp = client.list_templates({
|
4806
|
+
# aws_account_id: "AwsAccountId", # required
|
4807
|
+
# next_token: "String",
|
4808
|
+
# max_results: 1,
|
4809
|
+
# })
|
4810
|
+
#
|
4811
|
+
# @example Response structure
|
4812
|
+
#
|
4813
|
+
# resp.template_summary_list #=> Array
|
4814
|
+
# resp.template_summary_list[0].arn #=> String
|
4815
|
+
# resp.template_summary_list[0].template_id #=> String
|
4816
|
+
# resp.template_summary_list[0].name #=> String
|
4817
|
+
# resp.template_summary_list[0].latest_version_number #=> Integer
|
4818
|
+
# resp.template_summary_list[0].created_time #=> Time
|
4819
|
+
# resp.template_summary_list[0].last_updated_time #=> Time
|
4820
|
+
# resp.next_token #=> String
|
4821
|
+
# resp.status #=> Integer
|
4822
|
+
# resp.request_id #=> String
|
4823
|
+
#
|
4824
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTemplates AWS API Documentation
|
4825
|
+
#
|
4826
|
+
# @overload list_templates(params = {})
|
4827
|
+
# @param [Hash] params ({})
|
4828
|
+
def list_templates(params = {}, options = {})
|
4829
|
+
req = build_request(:list_templates, params)
|
4830
|
+
req.send_request(options)
|
4831
|
+
end
|
4832
|
+
|
4833
|
+
# Lists all the aliases of a theme.
|
4834
|
+
#
|
4835
|
+
# @option params [required, String] :aws_account_id
|
4836
|
+
# The ID of the AWS account that contains the theme aliases that you're
|
4837
|
+
# listing.
|
4838
|
+
#
|
4839
|
+
# @option params [required, String] :theme_id
|
4840
|
+
# The ID for the theme.
|
3125
4841
|
#
|
3126
4842
|
# @option params [String] :next_token
|
3127
4843
|
# The token for the next set of results, or null if there are no more
|
@@ -3130,52 +4846,49 @@ module Aws::QuickSight
|
|
3130
4846
|
# @option params [Integer] :max_results
|
3131
4847
|
# The maximum number of results to be returned per request.
|
3132
4848
|
#
|
3133
|
-
# @return [Types::
|
3134
|
-
#
|
3135
|
-
# * {Types::ListTemplateAliasesResponse#template_alias_list #template_alias_list} => Array<Types::TemplateAlias>
|
3136
|
-
# * {Types::ListTemplateAliasesResponse#status #status} => Integer
|
3137
|
-
# * {Types::ListTemplateAliasesResponse#request_id #request_id} => String
|
3138
|
-
# * {Types::ListTemplateAliasesResponse#next_token #next_token} => String
|
4849
|
+
# @return [Types::ListThemeAliasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3139
4850
|
#
|
3140
|
-
#
|
4851
|
+
# * {Types::ListThemeAliasesResponse#theme_alias_list #theme_alias_list} => Array<Types::ThemeAlias>
|
4852
|
+
# * {Types::ListThemeAliasesResponse#status #status} => Integer
|
4853
|
+
# * {Types::ListThemeAliasesResponse#request_id #request_id} => String
|
4854
|
+
# * {Types::ListThemeAliasesResponse#next_token #next_token} => String
|
3141
4855
|
#
|
3142
4856
|
# @example Request syntax with placeholder values
|
3143
4857
|
#
|
3144
|
-
# resp = client.
|
4858
|
+
# resp = client.list_theme_aliases({
|
3145
4859
|
# aws_account_id: "AwsAccountId", # required
|
3146
|
-
#
|
4860
|
+
# theme_id: "RestrictiveResourceId", # required
|
3147
4861
|
# next_token: "String",
|
3148
4862
|
# max_results: 1,
|
3149
4863
|
# })
|
3150
4864
|
#
|
3151
4865
|
# @example Response structure
|
3152
4866
|
#
|
3153
|
-
# resp.
|
3154
|
-
# resp.
|
3155
|
-
# resp.
|
3156
|
-
# resp.
|
4867
|
+
# resp.theme_alias_list #=> Array
|
4868
|
+
# resp.theme_alias_list[0].arn #=> String
|
4869
|
+
# resp.theme_alias_list[0].alias_name #=> String
|
4870
|
+
# resp.theme_alias_list[0].theme_version_number #=> Integer
|
3157
4871
|
# resp.status #=> Integer
|
3158
4872
|
# resp.request_id #=> String
|
3159
4873
|
# resp.next_token #=> String
|
3160
4874
|
#
|
3161
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
4875
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListThemeAliases AWS API Documentation
|
3162
4876
|
#
|
3163
|
-
# @overload
|
4877
|
+
# @overload list_theme_aliases(params = {})
|
3164
4878
|
# @param [Hash] params ({})
|
3165
|
-
def
|
3166
|
-
req = build_request(:
|
4879
|
+
def list_theme_aliases(params = {}, options = {})
|
4880
|
+
req = build_request(:list_theme_aliases, params)
|
3167
4881
|
req.send_request(options)
|
3168
4882
|
end
|
3169
4883
|
|
3170
|
-
# Lists all the versions of the
|
3171
|
-
# QuickSight account.
|
4884
|
+
# Lists all the versions of the themes in the current AWS account.
|
3172
4885
|
#
|
3173
4886
|
# @option params [required, String] :aws_account_id
|
3174
|
-
# The ID of the AWS account that contains the
|
4887
|
+
# The ID of the AWS account that contains the themes that you're
|
3175
4888
|
# listing.
|
3176
4889
|
#
|
3177
|
-
# @option params [required, String] :
|
3178
|
-
# The ID for the
|
4890
|
+
# @option params [required, String] :theme_id
|
4891
|
+
# The ID for the theme.
|
3179
4892
|
#
|
3180
4893
|
# @option params [String] :next_token
|
3181
4894
|
# The token for the next set of results, or null if there are no more
|
@@ -3184,49 +4897,47 @@ module Aws::QuickSight
|
|
3184
4897
|
# @option params [Integer] :max_results
|
3185
4898
|
# The maximum number of results to be returned per request.
|
3186
4899
|
#
|
3187
|
-
# @return [Types::
|
3188
|
-
#
|
3189
|
-
# * {Types::ListTemplateVersionsResponse#template_version_summary_list #template_version_summary_list} => Array<Types::TemplateVersionSummary>
|
3190
|
-
# * {Types::ListTemplateVersionsResponse#next_token #next_token} => String
|
3191
|
-
# * {Types::ListTemplateVersionsResponse#status #status} => Integer
|
3192
|
-
# * {Types::ListTemplateVersionsResponse#request_id #request_id} => String
|
4900
|
+
# @return [Types::ListThemeVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3193
4901
|
#
|
3194
|
-
#
|
4902
|
+
# * {Types::ListThemeVersionsResponse#theme_version_summary_list #theme_version_summary_list} => Array<Types::ThemeVersionSummary>
|
4903
|
+
# * {Types::ListThemeVersionsResponse#next_token #next_token} => String
|
4904
|
+
# * {Types::ListThemeVersionsResponse#status #status} => Integer
|
4905
|
+
# * {Types::ListThemeVersionsResponse#request_id #request_id} => String
|
3195
4906
|
#
|
3196
4907
|
# @example Request syntax with placeholder values
|
3197
4908
|
#
|
3198
|
-
# resp = client.
|
4909
|
+
# resp = client.list_theme_versions({
|
3199
4910
|
# aws_account_id: "AwsAccountId", # required
|
3200
|
-
#
|
4911
|
+
# theme_id: "RestrictiveResourceId", # required
|
3201
4912
|
# next_token: "String",
|
3202
4913
|
# max_results: 1,
|
3203
4914
|
# })
|
3204
4915
|
#
|
3205
4916
|
# @example Response structure
|
3206
4917
|
#
|
3207
|
-
# resp.
|
3208
|
-
# resp.
|
3209
|
-
# resp.
|
3210
|
-
# resp.
|
3211
|
-
# resp.
|
3212
|
-
# resp.
|
4918
|
+
# resp.theme_version_summary_list #=> Array
|
4919
|
+
# resp.theme_version_summary_list[0].version_number #=> Integer
|
4920
|
+
# resp.theme_version_summary_list[0].arn #=> String
|
4921
|
+
# resp.theme_version_summary_list[0].description #=> String
|
4922
|
+
# resp.theme_version_summary_list[0].created_time #=> Time
|
4923
|
+
# resp.theme_version_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
3213
4924
|
# resp.next_token #=> String
|
3214
4925
|
# resp.status #=> Integer
|
3215
4926
|
# resp.request_id #=> String
|
3216
4927
|
#
|
3217
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
4928
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListThemeVersions AWS API Documentation
|
3218
4929
|
#
|
3219
|
-
# @overload
|
4930
|
+
# @overload list_theme_versions(params = {})
|
3220
4931
|
# @param [Hash] params ({})
|
3221
|
-
def
|
3222
|
-
req = build_request(:
|
4932
|
+
def list_theme_versions(params = {}, options = {})
|
4933
|
+
req = build_request(:list_theme_versions, params)
|
3223
4934
|
req.send_request(options)
|
3224
4935
|
end
|
3225
4936
|
|
3226
|
-
# Lists all the
|
4937
|
+
# Lists all the themes in the current AWS account.
|
3227
4938
|
#
|
3228
4939
|
# @option params [required, String] :aws_account_id
|
3229
|
-
# The ID of the AWS account that contains the
|
4940
|
+
# The ID of the AWS account that contains the themes that you're
|
3230
4941
|
# listing.
|
3231
4942
|
#
|
3232
4943
|
# @option params [String] :next_token
|
@@ -3236,42 +4947,53 @@ module Aws::QuickSight
|
|
3236
4947
|
# @option params [Integer] :max_results
|
3237
4948
|
# The maximum number of results to be returned per request.
|
3238
4949
|
#
|
3239
|
-
# @
|
4950
|
+
# @option params [String] :type
|
4951
|
+
# The type of themes that you want to list. Valid options include the
|
4952
|
+
# following:
|
3240
4953
|
#
|
3241
|
-
# *
|
3242
|
-
# * {Types::ListTemplatesResponse#next_token #next_token} => String
|
3243
|
-
# * {Types::ListTemplatesResponse#status #status} => Integer
|
3244
|
-
# * {Types::ListTemplatesResponse#request_id #request_id} => String
|
4954
|
+
# * `ALL (default)`- Display all existing themes.
|
3245
4955
|
#
|
3246
|
-
#
|
4956
|
+
# * `CUSTOM` - Display only the themes created by people using Amazon
|
4957
|
+
# QuickSight.
|
4958
|
+
#
|
4959
|
+
# * `QUICKSIGHT` - Display only the starting themes defined by
|
4960
|
+
# QuickSight.
|
4961
|
+
#
|
4962
|
+
# @return [Types::ListThemesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4963
|
+
#
|
4964
|
+
# * {Types::ListThemesResponse#theme_summary_list #theme_summary_list} => Array<Types::ThemeSummary>
|
4965
|
+
# * {Types::ListThemesResponse#next_token #next_token} => String
|
4966
|
+
# * {Types::ListThemesResponse#status #status} => Integer
|
4967
|
+
# * {Types::ListThemesResponse#request_id #request_id} => String
|
3247
4968
|
#
|
3248
4969
|
# @example Request syntax with placeholder values
|
3249
4970
|
#
|
3250
|
-
# resp = client.
|
4971
|
+
# resp = client.list_themes({
|
3251
4972
|
# aws_account_id: "AwsAccountId", # required
|
3252
4973
|
# next_token: "String",
|
3253
4974
|
# max_results: 1,
|
4975
|
+
# type: "QUICKSIGHT", # accepts QUICKSIGHT, CUSTOM, ALL
|
3254
4976
|
# })
|
3255
4977
|
#
|
3256
4978
|
# @example Response structure
|
3257
4979
|
#
|
3258
|
-
# resp.
|
3259
|
-
# resp.
|
3260
|
-
# resp.
|
3261
|
-
# resp.
|
3262
|
-
# resp.
|
3263
|
-
# resp.
|
3264
|
-
# resp.
|
4980
|
+
# resp.theme_summary_list #=> Array
|
4981
|
+
# resp.theme_summary_list[0].arn #=> String
|
4982
|
+
# resp.theme_summary_list[0].name #=> String
|
4983
|
+
# resp.theme_summary_list[0].theme_id #=> String
|
4984
|
+
# resp.theme_summary_list[0].latest_version_number #=> Integer
|
4985
|
+
# resp.theme_summary_list[0].created_time #=> Time
|
4986
|
+
# resp.theme_summary_list[0].last_updated_time #=> Time
|
3265
4987
|
# resp.next_token #=> String
|
3266
4988
|
# resp.status #=> Integer
|
3267
4989
|
# resp.request_id #=> String
|
3268
4990
|
#
|
3269
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
4991
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListThemes AWS API Documentation
|
3270
4992
|
#
|
3271
|
-
# @overload
|
4993
|
+
# @overload list_themes(params = {})
|
3272
4994
|
# @param [Hash] params ({})
|
3273
|
-
def
|
3274
|
-
req = build_request(:
|
4995
|
+
def list_themes(params = {}, options = {})
|
4996
|
+
req = build_request(:list_themes, params)
|
3275
4997
|
req.send_request(options)
|
3276
4998
|
end
|
3277
4999
|
|
@@ -3374,6 +5096,7 @@ module Aws::QuickSight
|
|
3374
5096
|
# resp.user_list[0].identity_type #=> String, one of "IAM", "QUICKSIGHT"
|
3375
5097
|
# resp.user_list[0].active #=> Boolean
|
3376
5098
|
# resp.user_list[0].principal_id #=> String
|
5099
|
+
# resp.user_list[0].custom_permissions_name #=> String
|
3377
5100
|
# resp.next_token #=> String
|
3378
5101
|
# resp.request_id #=> String
|
3379
5102
|
# resp.status #=> Integer
|
@@ -3447,6 +5170,38 @@ module Aws::QuickSight
|
|
3447
5170
|
# The Amazon QuickSight user name that you want to create for the user
|
3448
5171
|
# you are registering.
|
3449
5172
|
#
|
5173
|
+
# @option params [String] :custom_permissions_name
|
5174
|
+
# (Enterprise edition only) The name of the custom permissions profile
|
5175
|
+
# that you want to assign to this user. Customized permissions allows
|
5176
|
+
# you to control a user's access by restricting access the following
|
5177
|
+
# operations:
|
5178
|
+
#
|
5179
|
+
# * Create and update data sources
|
5180
|
+
#
|
5181
|
+
# * Create and update datasets
|
5182
|
+
#
|
5183
|
+
# * Create and update email reports
|
5184
|
+
#
|
5185
|
+
# * Subscribe to email reports
|
5186
|
+
#
|
5187
|
+
# To add custom permissions to an existing user, use ` UpdateUser `
|
5188
|
+
# instead.
|
5189
|
+
#
|
5190
|
+
# A set of custom permissions includes any combination of these
|
5191
|
+
# restrictions. Currently, you need to create the profile names for
|
5192
|
+
# custom permission sets by using the QuickSight console. Then, you use
|
5193
|
+
# the `RegisterUser` API operation to assign the named set of
|
5194
|
+
# permissions to a QuickSight user.
|
5195
|
+
#
|
5196
|
+
# QuickSight custom permissions are applied through IAM policies.
|
5197
|
+
# Therefore, they override the permissions typically granted by
|
5198
|
+
# assigning QuickSight users to one of the default security cohorts in
|
5199
|
+
# QuickSight (admin, author, reader).
|
5200
|
+
#
|
5201
|
+
# This feature is available only to QuickSight Enterprise edition
|
5202
|
+
# subscriptions that use SAML 2.0-Based Federation for Single Sign-On
|
5203
|
+
# (SSO).
|
5204
|
+
#
|
3450
5205
|
# @return [Types::RegisterUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3451
5206
|
#
|
3452
5207
|
# * {Types::RegisterUserResponse#user #user} => Types::User
|
@@ -3465,6 +5220,7 @@ module Aws::QuickSight
|
|
3465
5220
|
# aws_account_id: "AwsAccountId", # required
|
3466
5221
|
# namespace: "Namespace", # required
|
3467
5222
|
# user_name: "UserName",
|
5223
|
+
# custom_permissions_name: "RoleName",
|
3468
5224
|
# })
|
3469
5225
|
#
|
3470
5226
|
# @example Response structure
|
@@ -3476,6 +5232,7 @@ module Aws::QuickSight
|
|
3476
5232
|
# resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
|
3477
5233
|
# resp.user.active #=> Boolean
|
3478
5234
|
# resp.user.principal_id #=> String
|
5235
|
+
# resp.user.custom_permissions_name #=> String
|
3479
5236
|
# resp.user_invitation_url #=> String
|
3480
5237
|
# resp.request_id #=> String
|
3481
5238
|
# resp.status #=> Integer
|
@@ -3489,7 +5246,107 @@ module Aws::QuickSight
|
|
3489
5246
|
req.send_request(options)
|
3490
5247
|
end
|
3491
5248
|
|
3492
|
-
#
|
5249
|
+
# Restores an analysis.
|
5250
|
+
#
|
5251
|
+
# @option params [required, String] :aws_account_id
|
5252
|
+
# The ID of the AWS account that contains the analysis.
|
5253
|
+
#
|
5254
|
+
# @option params [required, String] :analysis_id
|
5255
|
+
# The ID of the analysis that you're restoring.
|
5256
|
+
#
|
5257
|
+
# @return [Types::RestoreAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5258
|
+
#
|
5259
|
+
# * {Types::RestoreAnalysisResponse#status #status} => Integer
|
5260
|
+
# * {Types::RestoreAnalysisResponse#arn #arn} => String
|
5261
|
+
# * {Types::RestoreAnalysisResponse#analysis_id #analysis_id} => String
|
5262
|
+
# * {Types::RestoreAnalysisResponse#request_id #request_id} => String
|
5263
|
+
#
|
5264
|
+
# @example Request syntax with placeholder values
|
5265
|
+
#
|
5266
|
+
# resp = client.restore_analysis({
|
5267
|
+
# aws_account_id: "AwsAccountId", # required
|
5268
|
+
# analysis_id: "RestrictiveResourceId", # required
|
5269
|
+
# })
|
5270
|
+
#
|
5271
|
+
# @example Response structure
|
5272
|
+
#
|
5273
|
+
# resp.status #=> Integer
|
5274
|
+
# resp.arn #=> String
|
5275
|
+
# resp.analysis_id #=> String
|
5276
|
+
# resp.request_id #=> String
|
5277
|
+
#
|
5278
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RestoreAnalysis AWS API Documentation
|
5279
|
+
#
|
5280
|
+
# @overload restore_analysis(params = {})
|
5281
|
+
# @param [Hash] params ({})
|
5282
|
+
def restore_analysis(params = {}, options = {})
|
5283
|
+
req = build_request(:restore_analysis, params)
|
5284
|
+
req.send_request(options)
|
5285
|
+
end
|
5286
|
+
|
5287
|
+
# Searches for analyses that belong to the user specified in the filter.
|
5288
|
+
#
|
5289
|
+
# @option params [required, String] :aws_account_id
|
5290
|
+
# The ID of the AWS account that contains the analyses that you're
|
5291
|
+
# searching for.
|
5292
|
+
#
|
5293
|
+
# @option params [required, Array<Types::AnalysisSearchFilter>] :filters
|
5294
|
+
# The structure for the search filters that you want to apply to your
|
5295
|
+
# search.
|
5296
|
+
#
|
5297
|
+
# @option params [String] :next_token
|
5298
|
+
# A pagination token that can be used in a subsequent request.
|
5299
|
+
#
|
5300
|
+
# @option params [Integer] :max_results
|
5301
|
+
# The maximum number of results to return.
|
5302
|
+
#
|
5303
|
+
# @return [Types::SearchAnalysesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5304
|
+
#
|
5305
|
+
# * {Types::SearchAnalysesResponse#analysis_summary_list #analysis_summary_list} => Array<Types::AnalysisSummary>
|
5306
|
+
# * {Types::SearchAnalysesResponse#next_token #next_token} => String
|
5307
|
+
# * {Types::SearchAnalysesResponse#status #status} => Integer
|
5308
|
+
# * {Types::SearchAnalysesResponse#request_id #request_id} => String
|
5309
|
+
#
|
5310
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5311
|
+
#
|
5312
|
+
# @example Request syntax with placeholder values
|
5313
|
+
#
|
5314
|
+
# resp = client.search_analyses({
|
5315
|
+
# aws_account_id: "AwsAccountId", # required
|
5316
|
+
# filters: [ # required
|
5317
|
+
# {
|
5318
|
+
# operator: "StringEquals", # accepts StringEquals
|
5319
|
+
# name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER
|
5320
|
+
# value: "String",
|
5321
|
+
# },
|
5322
|
+
# ],
|
5323
|
+
# next_token: "String",
|
5324
|
+
# max_results: 1,
|
5325
|
+
# })
|
5326
|
+
#
|
5327
|
+
# @example Response structure
|
5328
|
+
#
|
5329
|
+
# resp.analysis_summary_list #=> Array
|
5330
|
+
# resp.analysis_summary_list[0].arn #=> String
|
5331
|
+
# resp.analysis_summary_list[0].analysis_id #=> String
|
5332
|
+
# resp.analysis_summary_list[0].name #=> String
|
5333
|
+
# resp.analysis_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
5334
|
+
# resp.analysis_summary_list[0].created_time #=> Time
|
5335
|
+
# resp.analysis_summary_list[0].last_updated_time #=> Time
|
5336
|
+
# resp.next_token #=> String
|
5337
|
+
# resp.status #=> Integer
|
5338
|
+
# resp.request_id #=> String
|
5339
|
+
#
|
5340
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchAnalyses AWS API Documentation
|
5341
|
+
#
|
5342
|
+
# @overload search_analyses(params = {})
|
5343
|
+
# @param [Hash] params ({})
|
5344
|
+
def search_analyses(params = {}, options = {})
|
5345
|
+
req = build_request(:search_analyses, params)
|
5346
|
+
req.send_request(options)
|
5347
|
+
end
|
5348
|
+
|
5349
|
+
# Searches for dashboards that belong to a user.
|
3493
5350
|
#
|
3494
5351
|
# @option params [required, String] :aws_account_id
|
3495
5352
|
# The ID of the AWS account that contains the user whose dashboards
|
@@ -3497,7 +5354,7 @@ module Aws::QuickSight
|
|
3497
5354
|
#
|
3498
5355
|
# @option params [required, Array<Types::DashboardSearchFilter>] :filters
|
3499
5356
|
# The filters to apply to the search. Currently, you can search only by
|
3500
|
-
# user name
|
5357
|
+
# user name, for example, `"Filters": [ \{ "Name": "QUICKSIGHT_USER",
|
3501
5358
|
# "Operator": "StringEquals", "Value":
|
3502
5359
|
# "arn:aws:quicksight:us-east-1:1:user/default/UserName1" \} ]`
|
3503
5360
|
#
|
@@ -3587,69 +5444,332 @@ module Aws::QuickSight
|
|
3587
5444
|
# Contains a map of the key-value pairs for the resource tag or tags
|
3588
5445
|
# assigned to the resource.
|
3589
5446
|
#
|
3590
|
-
# @return [Types::TagResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5447
|
+
# @return [Types::TagResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5448
|
+
#
|
5449
|
+
# * {Types::TagResourceResponse#request_id #request_id} => String
|
5450
|
+
# * {Types::TagResourceResponse#status #status} => Integer
|
5451
|
+
#
|
5452
|
+
# @example Request syntax with placeholder values
|
5453
|
+
#
|
5454
|
+
# resp = client.tag_resource({
|
5455
|
+
# resource_arn: "Arn", # required
|
5456
|
+
# tags: [ # required
|
5457
|
+
# {
|
5458
|
+
# key: "TagKey", # required
|
5459
|
+
# value: "TagValue", # required
|
5460
|
+
# },
|
5461
|
+
# ],
|
5462
|
+
# })
|
5463
|
+
#
|
5464
|
+
# @example Response structure
|
5465
|
+
#
|
5466
|
+
# resp.request_id #=> String
|
5467
|
+
# resp.status #=> Integer
|
5468
|
+
#
|
5469
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TagResource AWS API Documentation
|
5470
|
+
#
|
5471
|
+
# @overload tag_resource(params = {})
|
5472
|
+
# @param [Hash] params ({})
|
5473
|
+
def tag_resource(params = {}, options = {})
|
5474
|
+
req = build_request(:tag_resource, params)
|
5475
|
+
req.send_request(options)
|
5476
|
+
end
|
5477
|
+
|
5478
|
+
# Removes a tag or tags from a resource.
|
5479
|
+
#
|
5480
|
+
# @option params [required, String] :resource_arn
|
5481
|
+
# The Amazon Resource Name (ARN) of the resource that you want to untag.
|
5482
|
+
#
|
5483
|
+
# @option params [required, Array<String>] :tag_keys
|
5484
|
+
# The keys of the key-value pairs for the resource tag or tags assigned
|
5485
|
+
# to the resource.
|
5486
|
+
#
|
5487
|
+
# @return [Types::UntagResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5488
|
+
#
|
5489
|
+
# * {Types::UntagResourceResponse#request_id #request_id} => String
|
5490
|
+
# * {Types::UntagResourceResponse#status #status} => Integer
|
5491
|
+
#
|
5492
|
+
# @example Request syntax with placeholder values
|
5493
|
+
#
|
5494
|
+
# resp = client.untag_resource({
|
5495
|
+
# resource_arn: "Arn", # required
|
5496
|
+
# tag_keys: ["TagKey"], # required
|
5497
|
+
# })
|
5498
|
+
#
|
5499
|
+
# @example Response structure
|
5500
|
+
#
|
5501
|
+
# resp.request_id #=> String
|
5502
|
+
# resp.status #=> Integer
|
5503
|
+
#
|
5504
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UntagResource AWS API Documentation
|
5505
|
+
#
|
5506
|
+
# @overload untag_resource(params = {})
|
5507
|
+
# @param [Hash] params ({})
|
5508
|
+
def untag_resource(params = {}, options = {})
|
5509
|
+
req = build_request(:untag_resource, params)
|
5510
|
+
req.send_request(options)
|
5511
|
+
end
|
5512
|
+
|
5513
|
+
# Updates Amazon QuickSight customizations the current AWS Region.
|
5514
|
+
# Currently, the only customization you can use is a theme.
|
5515
|
+
#
|
5516
|
+
# You can use customizations for your AWS account or, if you specify a
|
5517
|
+
# namespace, for a QuickSight namespace instead. Customizations that
|
5518
|
+
# apply to a namespace override customizations that apply to an AWS
|
5519
|
+
# account. To find out which customizations apply, use the
|
5520
|
+
# `DescribeAccountCustomization` API operation.
|
5521
|
+
#
|
5522
|
+
# @option params [required, String] :aws_account_id
|
5523
|
+
# The ID for the AWS account that you want to update QuickSight
|
5524
|
+
# customizations for.
|
5525
|
+
#
|
5526
|
+
# @option params [String] :namespace
|
5527
|
+
# The namespace that you want to update QuickSight customizations for.
|
5528
|
+
#
|
5529
|
+
# @option params [required, Types::AccountCustomization] :account_customization
|
5530
|
+
# The QuickSight customizations you're updating in the current AWS
|
5531
|
+
# Region.
|
5532
|
+
#
|
5533
|
+
# @return [Types::UpdateAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5534
|
+
#
|
5535
|
+
# * {Types::UpdateAccountCustomizationResponse#aws_account_id #aws_account_id} => String
|
5536
|
+
# * {Types::UpdateAccountCustomizationResponse#namespace #namespace} => String
|
5537
|
+
# * {Types::UpdateAccountCustomizationResponse#account_customization #account_customization} => Types::AccountCustomization
|
5538
|
+
# * {Types::UpdateAccountCustomizationResponse#request_id #request_id} => String
|
5539
|
+
# * {Types::UpdateAccountCustomizationResponse#status #status} => Integer
|
5540
|
+
#
|
5541
|
+
# @example Request syntax with placeholder values
|
5542
|
+
#
|
5543
|
+
# resp = client.update_account_customization({
|
5544
|
+
# aws_account_id: "AwsAccountId", # required
|
5545
|
+
# namespace: "Namespace",
|
5546
|
+
# account_customization: { # required
|
5547
|
+
# default_theme: "Arn",
|
5548
|
+
# },
|
5549
|
+
# })
|
5550
|
+
#
|
5551
|
+
# @example Response structure
|
5552
|
+
#
|
5553
|
+
# resp.aws_account_id #=> String
|
5554
|
+
# resp.namespace #=> String
|
5555
|
+
# resp.account_customization.default_theme #=> String
|
5556
|
+
# resp.request_id #=> String
|
5557
|
+
# resp.status #=> Integer
|
5558
|
+
#
|
5559
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomization AWS API Documentation
|
5560
|
+
#
|
5561
|
+
# @overload update_account_customization(params = {})
|
5562
|
+
# @param [Hash] params ({})
|
5563
|
+
def update_account_customization(params = {}, options = {})
|
5564
|
+
req = build_request(:update_account_customization, params)
|
5565
|
+
req.send_request(options)
|
5566
|
+
end
|
5567
|
+
|
5568
|
+
# Updates the Amazon QuickSight settings in your AWS Account.
|
5569
|
+
#
|
5570
|
+
# @option params [required, String] :aws_account_id
|
5571
|
+
# The ID for the AWS account that contains the QuickSight settings that
|
5572
|
+
# you want to list.
|
5573
|
+
#
|
5574
|
+
# @option params [required, String] :default_namespace
|
5575
|
+
# The default namespace for this AWS Account. Currently, the default is
|
5576
|
+
# `default`. IAM users who register for the first time with QuickSight
|
5577
|
+
# provide an email that becomes associated with the default namespace.
|
5578
|
+
#
|
5579
|
+
# @option params [String] :notification_email
|
5580
|
+
# The email address that you want QuickSight to send notifications to
|
5581
|
+
# regarding your AWS account or QuickSight subscription.
|
5582
|
+
#
|
5583
|
+
# @return [Types::UpdateAccountSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5584
|
+
#
|
5585
|
+
# * {Types::UpdateAccountSettingsResponse#request_id #request_id} => String
|
5586
|
+
# * {Types::UpdateAccountSettingsResponse#status #status} => Integer
|
5587
|
+
#
|
5588
|
+
# @example Request syntax with placeholder values
|
5589
|
+
#
|
5590
|
+
# resp = client.update_account_settings({
|
5591
|
+
# aws_account_id: "AwsAccountId", # required
|
5592
|
+
# default_namespace: "Namespace", # required
|
5593
|
+
# notification_email: "String",
|
5594
|
+
# })
|
5595
|
+
#
|
5596
|
+
# @example Response structure
|
5597
|
+
#
|
5598
|
+
# resp.request_id #=> String
|
5599
|
+
# resp.status #=> Integer
|
5600
|
+
#
|
5601
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountSettings AWS API Documentation
|
5602
|
+
#
|
5603
|
+
# @overload update_account_settings(params = {})
|
5604
|
+
# @param [Hash] params ({})
|
5605
|
+
def update_account_settings(params = {}, options = {})
|
5606
|
+
req = build_request(:update_account_settings, params)
|
5607
|
+
req.send_request(options)
|
5608
|
+
end
|
5609
|
+
|
5610
|
+
# Updates an analysis in Amazon QuickSight
|
5611
|
+
#
|
5612
|
+
# @option params [required, String] :aws_account_id
|
5613
|
+
# The ID of the AWS account that contains the analysis that you're
|
5614
|
+
# updating.
|
5615
|
+
#
|
5616
|
+
# @option params [required, String] :analysis_id
|
5617
|
+
# The ID for the analysis that you're updating. This ID displays in the
|
5618
|
+
# URL of the analysis.
|
5619
|
+
#
|
5620
|
+
# @option params [required, String] :name
|
5621
|
+
# A descriptive name for the analysis that you're updating. This name
|
5622
|
+
# displays for the analysis in the QuickSight console.
|
5623
|
+
#
|
5624
|
+
# @option params [Types::Parameters] :parameters
|
5625
|
+
# The parameter names and override values that you want to use. An
|
5626
|
+
# analysis can have any parameter type, and some parameters might accept
|
5627
|
+
# multiple values.
|
5628
|
+
#
|
5629
|
+
# @option params [required, Types::AnalysisSourceEntity] :source_entity
|
5630
|
+
# A source entity to use for the analysis that you're updating. This
|
5631
|
+
# metadata structure contains details that describe a source template
|
5632
|
+
# and one or more datasets.
|
3591
5633
|
#
|
3592
|
-
#
|
3593
|
-
#
|
5634
|
+
# @option params [String] :theme_arn
|
5635
|
+
# The Amazon Resource Name (ARN) for the theme to apply to the analysis
|
5636
|
+
# that you're creating. To see the theme in the QuickSight console,
|
5637
|
+
# make sure that you have access to it.
|
5638
|
+
#
|
5639
|
+
# @return [Types::UpdateAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5640
|
+
#
|
5641
|
+
# * {Types::UpdateAnalysisResponse#arn #arn} => String
|
5642
|
+
# * {Types::UpdateAnalysisResponse#analysis_id #analysis_id} => String
|
5643
|
+
# * {Types::UpdateAnalysisResponse#update_status #update_status} => String
|
5644
|
+
# * {Types::UpdateAnalysisResponse#status #status} => Integer
|
5645
|
+
# * {Types::UpdateAnalysisResponse#request_id #request_id} => String
|
3594
5646
|
#
|
3595
5647
|
# @example Request syntax with placeholder values
|
3596
5648
|
#
|
3597
|
-
# resp = client.
|
3598
|
-
#
|
3599
|
-
#
|
3600
|
-
#
|
3601
|
-
#
|
3602
|
-
#
|
5649
|
+
# resp = client.update_analysis({
|
5650
|
+
# aws_account_id: "AwsAccountId", # required
|
5651
|
+
# analysis_id: "RestrictiveResourceId", # required
|
5652
|
+
# name: "AnalysisName", # required
|
5653
|
+
# parameters: {
|
5654
|
+
# string_parameters: [
|
5655
|
+
# {
|
5656
|
+
# name: "NonEmptyString", # required
|
5657
|
+
# values: ["String"], # required
|
5658
|
+
# },
|
5659
|
+
# ],
|
5660
|
+
# integer_parameters: [
|
5661
|
+
# {
|
5662
|
+
# name: "NonEmptyString", # required
|
5663
|
+
# values: [1], # required
|
5664
|
+
# },
|
5665
|
+
# ],
|
5666
|
+
# decimal_parameters: [
|
5667
|
+
# {
|
5668
|
+
# name: "NonEmptyString", # required
|
5669
|
+
# values: [1.0], # required
|
5670
|
+
# },
|
5671
|
+
# ],
|
5672
|
+
# date_time_parameters: [
|
5673
|
+
# {
|
5674
|
+
# name: "NonEmptyString", # required
|
5675
|
+
# values: [Time.now], # required
|
5676
|
+
# },
|
5677
|
+
# ],
|
5678
|
+
# },
|
5679
|
+
# source_entity: { # required
|
5680
|
+
# source_template: {
|
5681
|
+
# data_set_references: [ # required
|
5682
|
+
# {
|
5683
|
+
# data_set_placeholder: "NonEmptyString", # required
|
5684
|
+
# data_set_arn: "Arn", # required
|
5685
|
+
# },
|
5686
|
+
# ],
|
5687
|
+
# arn: "Arn", # required
|
3603
5688
|
# },
|
3604
|
-
#
|
5689
|
+
# },
|
5690
|
+
# theme_arn: "Arn",
|
3605
5691
|
# })
|
3606
5692
|
#
|
3607
5693
|
# @example Response structure
|
3608
5694
|
#
|
3609
|
-
# resp.
|
5695
|
+
# resp.arn #=> String
|
5696
|
+
# resp.analysis_id #=> String
|
5697
|
+
# resp.update_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
3610
5698
|
# resp.status #=> Integer
|
5699
|
+
# resp.request_id #=> String
|
3611
5700
|
#
|
3612
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
5701
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysis AWS API Documentation
|
3613
5702
|
#
|
3614
|
-
# @overload
|
5703
|
+
# @overload update_analysis(params = {})
|
3615
5704
|
# @param [Hash] params ({})
|
3616
|
-
def
|
3617
|
-
req = build_request(:
|
5705
|
+
def update_analysis(params = {}, options = {})
|
5706
|
+
req = build_request(:update_analysis, params)
|
3618
5707
|
req.send_request(options)
|
3619
5708
|
end
|
3620
5709
|
|
3621
|
-
#
|
5710
|
+
# Updates the read and write permissions for an analysis.
|
3622
5711
|
#
|
3623
|
-
# @option params [required, String] :
|
3624
|
-
# The
|
5712
|
+
# @option params [required, String] :aws_account_id
|
5713
|
+
# The ID of the AWS account that contains the analysis whose permissions
|
5714
|
+
# you're updating. You must be using the AWS account that the analysis
|
5715
|
+
# is in.
|
3625
5716
|
#
|
3626
|
-
# @option params [required,
|
3627
|
-
# The
|
3628
|
-
#
|
5717
|
+
# @option params [required, String] :analysis_id
|
5718
|
+
# The ID of the analysis whose permissions you're updating. The ID is
|
5719
|
+
# part of the analysis URL.
|
3629
5720
|
#
|
3630
|
-
# @
|
5721
|
+
# @option params [Array<Types::ResourcePermission>] :grant_permissions
|
5722
|
+
# A structure that describes the permissions to add and the principal to
|
5723
|
+
# add them to.
|
3631
5724
|
#
|
3632
|
-
#
|
3633
|
-
#
|
5725
|
+
# @option params [Array<Types::ResourcePermission>] :revoke_permissions
|
5726
|
+
# A structure that describes the permissions to remove and the principal
|
5727
|
+
# to remove them from.
|
5728
|
+
#
|
5729
|
+
# @return [Types::UpdateAnalysisPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5730
|
+
#
|
5731
|
+
# * {Types::UpdateAnalysisPermissionsResponse#analysis_arn #analysis_arn} => String
|
5732
|
+
# * {Types::UpdateAnalysisPermissionsResponse#analysis_id #analysis_id} => String
|
5733
|
+
# * {Types::UpdateAnalysisPermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission>
|
5734
|
+
# * {Types::UpdateAnalysisPermissionsResponse#request_id #request_id} => String
|
5735
|
+
# * {Types::UpdateAnalysisPermissionsResponse#status #status} => Integer
|
3634
5736
|
#
|
3635
5737
|
# @example Request syntax with placeholder values
|
3636
5738
|
#
|
3637
|
-
# resp = client.
|
3638
|
-
#
|
3639
|
-
#
|
5739
|
+
# resp = client.update_analysis_permissions({
|
5740
|
+
# aws_account_id: "AwsAccountId", # required
|
5741
|
+
# analysis_id: "RestrictiveResourceId", # required
|
5742
|
+
# grant_permissions: [
|
5743
|
+
# {
|
5744
|
+
# principal: "Principal", # required
|
5745
|
+
# actions: ["String"], # required
|
5746
|
+
# },
|
5747
|
+
# ],
|
5748
|
+
# revoke_permissions: [
|
5749
|
+
# {
|
5750
|
+
# principal: "Principal", # required
|
5751
|
+
# actions: ["String"], # required
|
5752
|
+
# },
|
5753
|
+
# ],
|
3640
5754
|
# })
|
3641
5755
|
#
|
3642
5756
|
# @example Response structure
|
3643
5757
|
#
|
5758
|
+
# resp.analysis_arn #=> String
|
5759
|
+
# resp.analysis_id #=> String
|
5760
|
+
# resp.permissions #=> Array
|
5761
|
+
# resp.permissions[0].principal #=> String
|
5762
|
+
# resp.permissions[0].actions #=> Array
|
5763
|
+
# resp.permissions[0].actions[0] #=> String
|
3644
5764
|
# resp.request_id #=> String
|
3645
5765
|
# resp.status #=> Integer
|
3646
5766
|
#
|
3647
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
5767
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysisPermissions AWS API Documentation
|
3648
5768
|
#
|
3649
|
-
# @overload
|
5769
|
+
# @overload update_analysis_permissions(params = {})
|
3650
5770
|
# @param [Hash] params ({})
|
3651
|
-
def
|
3652
|
-
req = build_request(:
|
5771
|
+
def update_analysis_permissions(params = {}, options = {})
|
5772
|
+
req = build_request(:update_analysis_permissions, params)
|
3653
5773
|
req.send_request(options)
|
3654
5774
|
end
|
3655
5775
|
|
@@ -3666,15 +5786,24 @@ module Aws::QuickSight
|
|
3666
5786
|
# The display name of the dashboard.
|
3667
5787
|
#
|
3668
5788
|
# @option params [required, Types::DashboardSourceEntity] :source_entity
|
3669
|
-
# The
|
3670
|
-
# `
|
3671
|
-
#
|
3672
|
-
#
|
3673
|
-
#
|
3674
|
-
#
|
5789
|
+
# The entity that you are using as a source when you update the
|
5790
|
+
# dashboard. In `SourceEntity`, you specify the type of object you're
|
5791
|
+
# using as source. You can only update a dashboard from a template, so
|
5792
|
+
# you use a `SourceTemplate` entity. If you need to update a dashboard
|
5793
|
+
# from an analysis, first convert the analysis to a template by using
|
5794
|
+
# the CreateTemplate API operation. For `SourceTemplate`, specify the
|
5795
|
+
# Amazon Resource Name (ARN) of the source template. The
|
5796
|
+
# `SourceTemplate` ARN can contain any AWS Account and any
|
5797
|
+
# QuickSight-supported AWS Region.
|
5798
|
+
#
|
5799
|
+
# Use the `DataSetReferences` entity within `SourceTemplate` to list the
|
5800
|
+
# replacement datasets for the placeholders listed in the original. The
|
5801
|
+
# schema in each dataset must match its placeholder.
|
3675
5802
|
#
|
3676
5803
|
# @option params [Types::Parameters] :parameters
|
3677
|
-
# A structure that contains the parameters of the dashboard.
|
5804
|
+
# A structure that contains the parameters of the dashboard. These are
|
5805
|
+
# parameter overrides for a dashboard. A dashboard can have any type of
|
5806
|
+
# parameters, and some parameters might accept multiple values.
|
3678
5807
|
#
|
3679
5808
|
# @option params [String] :version_description
|
3680
5809
|
# A description for the first version of the dashboard being created.
|
@@ -3690,13 +5819,18 @@ module Aws::QuickSight
|
|
3690
5819
|
#
|
3691
5820
|
# * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
|
3692
5821
|
# either `ENABLED` or `DISABLED`. The visual option to export data to
|
3693
|
-
# .
|
5822
|
+
# .CSV format isn't enabled when this is set to `DISABLED`. This
|
3694
5823
|
# option is `ENABLED` by default.
|
3695
5824
|
#
|
3696
5825
|
# * `VisibilityState` for `SheetControlsOption` - This visibility state
|
3697
|
-
# can be either `COLLAPSED` or `EXPANDED`.
|
3698
|
-
#
|
3699
|
-
#
|
5826
|
+
# can be either `COLLAPSED` or `EXPANDED`. This option is `COLLAPSED`
|
5827
|
+
# by default.
|
5828
|
+
#
|
5829
|
+
# @option params [String] :theme_arn
|
5830
|
+
# The Amazon Resource Name (ARN) of the theme that is being used for
|
5831
|
+
# this dashboard. If you add a value for this field, it overrides the
|
5832
|
+
# value that was originally associated with the entity. The theme ARN
|
5833
|
+
# must exist in the same AWS account where you create the dashboard.
|
3700
5834
|
#
|
3701
5835
|
# @return [Types::UpdateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3702
5836
|
#
|
@@ -3762,6 +5896,7 @@ module Aws::QuickSight
|
|
3762
5896
|
# visibility_state: "EXPANDED", # accepts EXPANDED, COLLAPSED
|
3763
5897
|
# },
|
3764
5898
|
# },
|
5899
|
+
# theme_arn: "Arn",
|
3765
5900
|
# })
|
3766
5901
|
#
|
3767
5902
|
# @example Response structure
|
@@ -3769,7 +5904,7 @@ module Aws::QuickSight
|
|
3769
5904
|
# resp.arn #=> String
|
3770
5905
|
# resp.version_arn #=> String
|
3771
5906
|
# resp.dashboard_id #=> String
|
3772
|
-
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
5907
|
+
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
3773
5908
|
# resp.status #=> Integer
|
3774
5909
|
# resp.request_id #=> String
|
3775
5910
|
#
|
@@ -4035,6 +6170,7 @@ module Aws::QuickSight
|
|
4035
6170
|
# },
|
4036
6171
|
# ],
|
4037
6172
|
# row_level_permission_data_set: {
|
6173
|
+
# namespace: "Namespace",
|
4038
6174
|
# arn: "Arn", # required
|
4039
6175
|
# permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
|
4040
6176
|
# },
|
@@ -4251,7 +6387,96 @@ module Aws::QuickSight
|
|
4251
6387
|
# credential_pair: {
|
4252
6388
|
# username: "Username", # required
|
4253
6389
|
# password: "Password", # required
|
6390
|
+
# alternate_data_source_parameters: [
|
6391
|
+
# {
|
6392
|
+
# amazon_elasticsearch_parameters: {
|
6393
|
+
# domain: "Domain", # required
|
6394
|
+
# },
|
6395
|
+
# athena_parameters: {
|
6396
|
+
# work_group: "WorkGroup",
|
6397
|
+
# },
|
6398
|
+
# aurora_parameters: {
|
6399
|
+
# host: "Host", # required
|
6400
|
+
# port: 1, # required
|
6401
|
+
# database: "Database", # required
|
6402
|
+
# },
|
6403
|
+
# aurora_postgre_sql_parameters: {
|
6404
|
+
# host: "Host", # required
|
6405
|
+
# port: 1, # required
|
6406
|
+
# database: "Database", # required
|
6407
|
+
# },
|
6408
|
+
# aws_iot_analytics_parameters: {
|
6409
|
+
# data_set_name: "DataSetName", # required
|
6410
|
+
# },
|
6411
|
+
# jira_parameters: {
|
6412
|
+
# site_base_url: "SiteBaseUrl", # required
|
6413
|
+
# },
|
6414
|
+
# maria_db_parameters: {
|
6415
|
+
# host: "Host", # required
|
6416
|
+
# port: 1, # required
|
6417
|
+
# database: "Database", # required
|
6418
|
+
# },
|
6419
|
+
# my_sql_parameters: {
|
6420
|
+
# host: "Host", # required
|
6421
|
+
# port: 1, # required
|
6422
|
+
# database: "Database", # required
|
6423
|
+
# },
|
6424
|
+
# postgre_sql_parameters: {
|
6425
|
+
# host: "Host", # required
|
6426
|
+
# port: 1, # required
|
6427
|
+
# database: "Database", # required
|
6428
|
+
# },
|
6429
|
+
# presto_parameters: {
|
6430
|
+
# host: "Host", # required
|
6431
|
+
# port: 1, # required
|
6432
|
+
# catalog: "Catalog", # required
|
6433
|
+
# },
|
6434
|
+
# rds_parameters: {
|
6435
|
+
# instance_id: "InstanceId", # required
|
6436
|
+
# database: "Database", # required
|
6437
|
+
# },
|
6438
|
+
# redshift_parameters: {
|
6439
|
+
# host: "Host",
|
6440
|
+
# port: 1,
|
6441
|
+
# database: "Database", # required
|
6442
|
+
# cluster_id: "ClusterId",
|
6443
|
+
# },
|
6444
|
+
# s3_parameters: {
|
6445
|
+
# manifest_file_location: { # required
|
6446
|
+
# bucket: "S3Bucket", # required
|
6447
|
+
# key: "S3Key", # required
|
6448
|
+
# },
|
6449
|
+
# },
|
6450
|
+
# service_now_parameters: {
|
6451
|
+
# site_base_url: "SiteBaseUrl", # required
|
6452
|
+
# },
|
6453
|
+
# snowflake_parameters: {
|
6454
|
+
# host: "Host", # required
|
6455
|
+
# database: "Database", # required
|
6456
|
+
# warehouse: "Warehouse", # required
|
6457
|
+
# },
|
6458
|
+
# spark_parameters: {
|
6459
|
+
# host: "Host", # required
|
6460
|
+
# port: 1, # required
|
6461
|
+
# },
|
6462
|
+
# sql_server_parameters: {
|
6463
|
+
# host: "Host", # required
|
6464
|
+
# port: 1, # required
|
6465
|
+
# database: "Database", # required
|
6466
|
+
# },
|
6467
|
+
# teradata_parameters: {
|
6468
|
+
# host: "Host", # required
|
6469
|
+
# port: 1, # required
|
6470
|
+
# database: "Database", # required
|
6471
|
+
# },
|
6472
|
+
# twitter_parameters: {
|
6473
|
+
# query: "Query", # required
|
6474
|
+
# max_rows: 1, # required
|
6475
|
+
# },
|
6476
|
+
# },
|
6477
|
+
# ],
|
4254
6478
|
# },
|
6479
|
+
# copy_source_arn: "CopySourceArn",
|
4255
6480
|
# },
|
4256
6481
|
# vpc_connection_properties: {
|
4257
6482
|
# vpc_connection_arn: "Arn", # required
|
@@ -4265,7 +6490,7 @@ module Aws::QuickSight
|
|
4265
6490
|
#
|
4266
6491
|
# resp.arn #=> String
|
4267
6492
|
# resp.data_source_id #=> String
|
4268
|
-
# resp.update_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
6493
|
+
# resp.update_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
4269
6494
|
# resp.request_id #=> String
|
4270
6495
|
# resp.status #=> Integer
|
4271
6496
|
#
|
@@ -4475,9 +6700,19 @@ module Aws::QuickSight
|
|
4475
6700
|
# The ID for the template.
|
4476
6701
|
#
|
4477
6702
|
# @option params [required, Types::TemplateSourceEntity] :source_entity
|
4478
|
-
# The
|
4479
|
-
#
|
4480
|
-
#
|
6703
|
+
# The entity that you are using as a source when you update the
|
6704
|
+
# template. In `SourceEntity`, you specify the type of object you're
|
6705
|
+
# using as source: `SourceTemplate` for a template or `SourceAnalysis`
|
6706
|
+
# for an analysis. Both of these require an Amazon Resource Name (ARN).
|
6707
|
+
# For `SourceTemplate`, specify the ARN of the source template. For
|
6708
|
+
# `SourceAnalysis`, specify the ARN of the source analysis. The
|
6709
|
+
# `SourceTemplate` ARN can contain any AWS Account and any
|
6710
|
+
# QuickSight-supported AWS Region.
|
6711
|
+
#
|
6712
|
+
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
6713
|
+
# `SourceAnalysis` to list the replacement datasets for the placeholders
|
6714
|
+
# listed in the original. The schema in each dataset must match its
|
6715
|
+
# placeholder.
|
4481
6716
|
#
|
4482
6717
|
# @option params [String] :version_description
|
4483
6718
|
# A description of the current template version that is being updated.
|
@@ -4525,7 +6760,7 @@ module Aws::QuickSight
|
|
4525
6760
|
# resp.template_id #=> String
|
4526
6761
|
# resp.arn #=> String
|
4527
6762
|
# resp.version_arn #=> String
|
4528
|
-
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
6763
|
+
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
4529
6764
|
# resp.status #=> Integer
|
4530
6765
|
# resp.request_id #=> String
|
4531
6766
|
#
|
@@ -4650,6 +6885,259 @@ module Aws::QuickSight
|
|
4650
6885
|
req.send_request(options)
|
4651
6886
|
end
|
4652
6887
|
|
6888
|
+
# Updates a theme.
|
6889
|
+
#
|
6890
|
+
# @option params [required, String] :aws_account_id
|
6891
|
+
# The ID of the AWS account that contains the theme that you're
|
6892
|
+
# updating.
|
6893
|
+
#
|
6894
|
+
# @option params [required, String] :theme_id
|
6895
|
+
# The ID for the theme.
|
6896
|
+
#
|
6897
|
+
# @option params [String] :name
|
6898
|
+
# The name for the theme.
|
6899
|
+
#
|
6900
|
+
# @option params [required, String] :base_theme_id
|
6901
|
+
# The theme ID, defined by Amazon QuickSight, that a custom theme
|
6902
|
+
# inherits from. All themes initially inherit from a default QuickSight
|
6903
|
+
# theme.
|
6904
|
+
#
|
6905
|
+
# @option params [String] :version_description
|
6906
|
+
# A description of the theme version that you're updating Every time
|
6907
|
+
# that you call `UpdateTheme`, you create a new version of the theme.
|
6908
|
+
# Each version of the theme maintains a description of the version in
|
6909
|
+
# `VersionDescription`.
|
6910
|
+
#
|
6911
|
+
# @option params [Types::ThemeConfiguration] :configuration
|
6912
|
+
# The theme configuration, which contains the theme display properties.
|
6913
|
+
#
|
6914
|
+
# @return [Types::UpdateThemeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6915
|
+
#
|
6916
|
+
# * {Types::UpdateThemeResponse#theme_id #theme_id} => String
|
6917
|
+
# * {Types::UpdateThemeResponse#arn #arn} => String
|
6918
|
+
# * {Types::UpdateThemeResponse#version_arn #version_arn} => String
|
6919
|
+
# * {Types::UpdateThemeResponse#creation_status #creation_status} => String
|
6920
|
+
# * {Types::UpdateThemeResponse#status #status} => Integer
|
6921
|
+
# * {Types::UpdateThemeResponse#request_id #request_id} => String
|
6922
|
+
#
|
6923
|
+
# @example Request syntax with placeholder values
|
6924
|
+
#
|
6925
|
+
# resp = client.update_theme({
|
6926
|
+
# aws_account_id: "AwsAccountId", # required
|
6927
|
+
# theme_id: "RestrictiveResourceId", # required
|
6928
|
+
# name: "ThemeName",
|
6929
|
+
# base_theme_id: "RestrictiveResourceId", # required
|
6930
|
+
# version_description: "VersionDescription",
|
6931
|
+
# configuration: {
|
6932
|
+
# data_color_palette: {
|
6933
|
+
# colors: ["HexColor"],
|
6934
|
+
# min_max_gradient: ["HexColor"],
|
6935
|
+
# empty_fill_color: "HexColor",
|
6936
|
+
# },
|
6937
|
+
# ui_color_palette: {
|
6938
|
+
# primary_foreground: "HexColor",
|
6939
|
+
# primary_background: "HexColor",
|
6940
|
+
# secondary_foreground: "HexColor",
|
6941
|
+
# secondary_background: "HexColor",
|
6942
|
+
# accent: "HexColor",
|
6943
|
+
# accent_foreground: "HexColor",
|
6944
|
+
# danger: "HexColor",
|
6945
|
+
# danger_foreground: "HexColor",
|
6946
|
+
# warning: "HexColor",
|
6947
|
+
# warning_foreground: "HexColor",
|
6948
|
+
# success: "HexColor",
|
6949
|
+
# success_foreground: "HexColor",
|
6950
|
+
# dimension: "HexColor",
|
6951
|
+
# dimension_foreground: "HexColor",
|
6952
|
+
# measure: "HexColor",
|
6953
|
+
# measure_foreground: "HexColor",
|
6954
|
+
# },
|
6955
|
+
# sheet: {
|
6956
|
+
# tile: {
|
6957
|
+
# border: {
|
6958
|
+
# show: false,
|
6959
|
+
# },
|
6960
|
+
# },
|
6961
|
+
# tile_layout: {
|
6962
|
+
# gutter: {
|
6963
|
+
# show: false,
|
6964
|
+
# },
|
6965
|
+
# margin: {
|
6966
|
+
# show: false,
|
6967
|
+
# },
|
6968
|
+
# },
|
6969
|
+
# },
|
6970
|
+
# },
|
6971
|
+
# })
|
6972
|
+
#
|
6973
|
+
# @example Response structure
|
6974
|
+
#
|
6975
|
+
# resp.theme_id #=> String
|
6976
|
+
# resp.arn #=> String
|
6977
|
+
# resp.version_arn #=> String
|
6978
|
+
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
6979
|
+
# resp.status #=> Integer
|
6980
|
+
# resp.request_id #=> String
|
6981
|
+
#
|
6982
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateTheme AWS API Documentation
|
6983
|
+
#
|
6984
|
+
# @overload update_theme(params = {})
|
6985
|
+
# @param [Hash] params ({})
|
6986
|
+
def update_theme(params = {}, options = {})
|
6987
|
+
req = build_request(:update_theme, params)
|
6988
|
+
req.send_request(options)
|
6989
|
+
end
|
6990
|
+
|
6991
|
+
# Updates an alias of a theme.
|
6992
|
+
#
|
6993
|
+
# @option params [required, String] :aws_account_id
|
6994
|
+
# The ID of the AWS account that contains the theme alias that you're
|
6995
|
+
# updating.
|
6996
|
+
#
|
6997
|
+
# @option params [required, String] :theme_id
|
6998
|
+
# The ID for the theme.
|
6999
|
+
#
|
7000
|
+
# @option params [required, String] :alias_name
|
7001
|
+
# The name of the theme alias that you want to update.
|
7002
|
+
#
|
7003
|
+
# @option params [required, Integer] :theme_version_number
|
7004
|
+
# The version number of the theme that the alias should reference.
|
7005
|
+
#
|
7006
|
+
# @return [Types::UpdateThemeAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7007
|
+
#
|
7008
|
+
# * {Types::UpdateThemeAliasResponse#theme_alias #theme_alias} => Types::ThemeAlias
|
7009
|
+
# * {Types::UpdateThemeAliasResponse#status #status} => Integer
|
7010
|
+
# * {Types::UpdateThemeAliasResponse#request_id #request_id} => String
|
7011
|
+
#
|
7012
|
+
# @example Request syntax with placeholder values
|
7013
|
+
#
|
7014
|
+
# resp = client.update_theme_alias({
|
7015
|
+
# aws_account_id: "AwsAccountId", # required
|
7016
|
+
# theme_id: "RestrictiveResourceId", # required
|
7017
|
+
# alias_name: "AliasName", # required
|
7018
|
+
# theme_version_number: 1, # required
|
7019
|
+
# })
|
7020
|
+
#
|
7021
|
+
# @example Response structure
|
7022
|
+
#
|
7023
|
+
# resp.theme_alias.arn #=> String
|
7024
|
+
# resp.theme_alias.alias_name #=> String
|
7025
|
+
# resp.theme_alias.theme_version_number #=> Integer
|
7026
|
+
# resp.status #=> Integer
|
7027
|
+
# resp.request_id #=> String
|
7028
|
+
#
|
7029
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateThemeAlias AWS API Documentation
|
7030
|
+
#
|
7031
|
+
# @overload update_theme_alias(params = {})
|
7032
|
+
# @param [Hash] params ({})
|
7033
|
+
def update_theme_alias(params = {}, options = {})
|
7034
|
+
req = build_request(:update_theme_alias, params)
|
7035
|
+
req.send_request(options)
|
7036
|
+
end
|
7037
|
+
|
7038
|
+
# Updates the resource permissions for a theme. Permissions apply to the
|
7039
|
+
# action to grant or revoke permissions on, for example
|
7040
|
+
# `"quicksight:DescribeTheme"`.
|
7041
|
+
#
|
7042
|
+
# Theme permissions apply in groupings. Valid groupings include the
|
7043
|
+
# following for the three levels of permissions, which are user, owner,
|
7044
|
+
# or no permissions:
|
7045
|
+
#
|
7046
|
+
# * User
|
7047
|
+
#
|
7048
|
+
# * `"quicksight:DescribeTheme"`
|
7049
|
+
#
|
7050
|
+
# * `"quicksight:DescribeThemeAlias"`
|
7051
|
+
#
|
7052
|
+
# * `"quicksight:ListThemeAliases"`
|
7053
|
+
#
|
7054
|
+
# * `"quicksight:ListThemeVersions"`
|
7055
|
+
#
|
7056
|
+
# * Owner
|
7057
|
+
#
|
7058
|
+
# * `"quicksight:DescribeTheme"`
|
7059
|
+
#
|
7060
|
+
# * `"quicksight:DescribeThemeAlias"`
|
7061
|
+
#
|
7062
|
+
# * `"quicksight:ListThemeAliases"`
|
7063
|
+
#
|
7064
|
+
# * `"quicksight:ListThemeVersions"`
|
7065
|
+
#
|
7066
|
+
# * `"quicksight:DeleteTheme"`
|
7067
|
+
#
|
7068
|
+
# * `"quicksight:UpdateTheme"`
|
7069
|
+
#
|
7070
|
+
# * `"quicksight:CreateThemeAlias"`
|
7071
|
+
#
|
7072
|
+
# * `"quicksight:DeleteThemeAlias"`
|
7073
|
+
#
|
7074
|
+
# * `"quicksight:UpdateThemeAlias"`
|
7075
|
+
#
|
7076
|
+
# * `"quicksight:UpdateThemePermissions"`
|
7077
|
+
#
|
7078
|
+
# * `"quicksight:DescribeThemePermissions"`
|
7079
|
+
#
|
7080
|
+
# * To specify no permissions, omit the permissions list.
|
7081
|
+
#
|
7082
|
+
# @option params [required, String] :aws_account_id
|
7083
|
+
# The ID of the AWS account that contains the theme.
|
7084
|
+
#
|
7085
|
+
# @option params [required, String] :theme_id
|
7086
|
+
# The ID for the theme.
|
7087
|
+
#
|
7088
|
+
# @option params [Array<Types::ResourcePermission>] :grant_permissions
|
7089
|
+
# A list of resource permissions to be granted for the theme.
|
7090
|
+
#
|
7091
|
+
# @option params [Array<Types::ResourcePermission>] :revoke_permissions
|
7092
|
+
# A list of resource permissions to be revoked from the theme.
|
7093
|
+
#
|
7094
|
+
# @return [Types::UpdateThemePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7095
|
+
#
|
7096
|
+
# * {Types::UpdateThemePermissionsResponse#theme_id #theme_id} => String
|
7097
|
+
# * {Types::UpdateThemePermissionsResponse#theme_arn #theme_arn} => String
|
7098
|
+
# * {Types::UpdateThemePermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission>
|
7099
|
+
# * {Types::UpdateThemePermissionsResponse#request_id #request_id} => String
|
7100
|
+
# * {Types::UpdateThemePermissionsResponse#status #status} => Integer
|
7101
|
+
#
|
7102
|
+
# @example Request syntax with placeholder values
|
7103
|
+
#
|
7104
|
+
# resp = client.update_theme_permissions({
|
7105
|
+
# aws_account_id: "AwsAccountId", # required
|
7106
|
+
# theme_id: "RestrictiveResourceId", # required
|
7107
|
+
# grant_permissions: [
|
7108
|
+
# {
|
7109
|
+
# principal: "Principal", # required
|
7110
|
+
# actions: ["String"], # required
|
7111
|
+
# },
|
7112
|
+
# ],
|
7113
|
+
# revoke_permissions: [
|
7114
|
+
# {
|
7115
|
+
# principal: "Principal", # required
|
7116
|
+
# actions: ["String"], # required
|
7117
|
+
# },
|
7118
|
+
# ],
|
7119
|
+
# })
|
7120
|
+
#
|
7121
|
+
# @example Response structure
|
7122
|
+
#
|
7123
|
+
# resp.theme_id #=> String
|
7124
|
+
# resp.theme_arn #=> String
|
7125
|
+
# resp.permissions #=> Array
|
7126
|
+
# resp.permissions[0].principal #=> String
|
7127
|
+
# resp.permissions[0].actions #=> Array
|
7128
|
+
# resp.permissions[0].actions[0] #=> String
|
7129
|
+
# resp.request_id #=> String
|
7130
|
+
# resp.status #=> Integer
|
7131
|
+
#
|
7132
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateThemePermissions AWS API Documentation
|
7133
|
+
#
|
7134
|
+
# @overload update_theme_permissions(params = {})
|
7135
|
+
# @param [Hash] params ({})
|
7136
|
+
def update_theme_permissions(params = {}, options = {})
|
7137
|
+
req = build_request(:update_theme_permissions, params)
|
7138
|
+
req.send_request(options)
|
7139
|
+
end
|
7140
|
+
|
4653
7141
|
# Updates an Amazon QuickSight user.
|
4654
7142
|
#
|
4655
7143
|
# @option params [required, String] :user_name
|
@@ -4666,8 +7154,8 @@ module Aws::QuickSight
|
|
4666
7154
|
# The email address of the user that you want to update.
|
4667
7155
|
#
|
4668
7156
|
# @option params [required, String] :role
|
4669
|
-
# The Amazon QuickSight role of the user. The
|
4670
|
-
#
|
7157
|
+
# The Amazon QuickSight role of the user. The role can be one of the
|
7158
|
+
# following default security cohorts:
|
4671
7159
|
#
|
4672
7160
|
# * `READER`\: A user who has read-only access to dashboards.
|
4673
7161
|
#
|
@@ -4677,6 +7165,45 @@ module Aws::QuickSight
|
|
4677
7165
|
# * `ADMIN`\: A user who is an author, who can also manage Amazon
|
4678
7166
|
# QuickSight settings.
|
4679
7167
|
#
|
7168
|
+
# The name of the QuickSight role is invisible to the user except for
|
7169
|
+
# the console screens dealing with permissions.
|
7170
|
+
#
|
7171
|
+
# @option params [String] :custom_permissions_name
|
7172
|
+
# (Enterprise edition only) The name of the custom permissions profile
|
7173
|
+
# that you want to assign to this user. Customized permissions allows
|
7174
|
+
# you to control a user's access by restricting access the following
|
7175
|
+
# operations:
|
7176
|
+
#
|
7177
|
+
# * Create and update data sources
|
7178
|
+
#
|
7179
|
+
# * Create and update datasets
|
7180
|
+
#
|
7181
|
+
# * Create and update email reports
|
7182
|
+
#
|
7183
|
+
# * Subscribe to email reports
|
7184
|
+
#
|
7185
|
+
# A set of custom permissions includes any combination of these
|
7186
|
+
# restrictions. Currently, you need to create the profile names for
|
7187
|
+
# custom permission sets by using the QuickSight console. Then, you use
|
7188
|
+
# the `RegisterUser` API operation to assign the named set of
|
7189
|
+
# permissions to a QuickSight user.
|
7190
|
+
#
|
7191
|
+
# QuickSight custom permissions are applied through IAM policies.
|
7192
|
+
# Therefore, they override the permissions typically granted by
|
7193
|
+
# assigning QuickSight users to one of the default security cohorts in
|
7194
|
+
# QuickSight (admin, author, reader).
|
7195
|
+
#
|
7196
|
+
# This feature is available only to QuickSight Enterprise edition
|
7197
|
+
# subscriptions that use SAML 2.0-Based Federation for Single Sign-On
|
7198
|
+
# (SSO).
|
7199
|
+
#
|
7200
|
+
# @option params [Boolean] :unapply_custom_permissions
|
7201
|
+
# A flag that you use to indicate that you want to remove all custom
|
7202
|
+
# permissions from this user. Using this parameter resets the user to
|
7203
|
+
# the state it was in before a custom permissions profile was applied.
|
7204
|
+
# This parameter defaults to NULL and it doesn't accept any other
|
7205
|
+
# value.
|
7206
|
+
#
|
4680
7207
|
# @return [Types::UpdateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4681
7208
|
#
|
4682
7209
|
# * {Types::UpdateUserResponse#user #user} => Types::User
|
@@ -4691,6 +7218,8 @@ module Aws::QuickSight
|
|
4691
7218
|
# namespace: "Namespace", # required
|
4692
7219
|
# email: "String", # required
|
4693
7220
|
# role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER
|
7221
|
+
# custom_permissions_name: "RoleName",
|
7222
|
+
# unapply_custom_permissions: false,
|
4694
7223
|
# })
|
4695
7224
|
#
|
4696
7225
|
# @example Response structure
|
@@ -4702,6 +7231,7 @@ module Aws::QuickSight
|
|
4702
7231
|
# resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
|
4703
7232
|
# resp.user.active #=> Boolean
|
4704
7233
|
# resp.user.principal_id #=> String
|
7234
|
+
# resp.user.custom_permissions_name #=> String
|
4705
7235
|
# resp.request_id #=> String
|
4706
7236
|
# resp.status #=> Integer
|
4707
7237
|
#
|
@@ -4727,7 +7257,7 @@ module Aws::QuickSight
|
|
4727
7257
|
params: params,
|
4728
7258
|
config: config)
|
4729
7259
|
context[:gem_name] = 'aws-sdk-quicksight'
|
4730
|
-
context[:gem_version] = '1.
|
7260
|
+
context[:gem_version] = '1.27.0'
|
4731
7261
|
Seahorse::Client::Request.new(handlers, context)
|
4732
7262
|
end
|
4733
7263
|
|