aws-sdk-quicksight 1.24.0 → 1.29.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-quicksight.rb +2 -2
- data/lib/aws-sdk-quicksight/client.rb +2481 -229
- data/lib/aws-sdk-quicksight/client_api.rb +1194 -1
- data/lib/aws-sdk-quicksight/types.rb +3983 -435
- 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: aee2f20ed2bc9a059eebb1465da1015deaeecc1ca4f9e5612049689264120ace
|
4
|
+
data.tar.gz: b27f58d26efb95ac6d613ce037dbd797871c3675fd6a9fb81ca9453b92e48850
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 44f74bf7547ee0de7d49ec31e3bf6807fdb6c3c097c078f6d841b34bcdbc5bccf82f563bb5db29dd6c29f62a6c51d5d33e93023540280da75c1d2b7abc56b9c6
|
7
|
+
data.tar.gz: f7201fab039e4eb883c955d8a5848990b3eb669d2e8dbf01b414cd3551db6b6cccb8708c9b0a890080103bb70353f80328e5398660e7846a66b2b83bef300c78
|
data/lib/aws-sdk-quicksight.rb
CHANGED
@@ -85,13 +85,28 @@ module Aws::QuickSight
|
|
85
85
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
86
86
|
# credentials.
|
87
87
|
#
|
88
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
89
|
+
# shared file, such as `~/.aws/config`.
|
90
|
+
#
|
91
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
94
|
+
# assume a role after providing credentials via the web.
|
95
|
+
#
|
96
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
97
|
+
# access token generated from `aws login`.
|
98
|
+
#
|
99
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
100
|
+
# process that outputs to stdout.
|
101
|
+
#
|
88
102
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
89
103
|
# from an EC2 IMDS on an EC2 instance.
|
90
104
|
#
|
91
|
-
# * `Aws::
|
92
|
-
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
93
107
|
#
|
94
|
-
# * `Aws::
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
95
110
|
#
|
96
111
|
# When `:credentials` are not configured directly, the following
|
97
112
|
# locations will be searched for credentials:
|
@@ -101,10 +116,10 @@ module Aws::QuickSight
|
|
101
116
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
102
117
|
# * `~/.aws/credentials`
|
103
118
|
# * `~/.aws/config`
|
104
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
105
|
-
# very aggressive. Construct and pass an instance of
|
106
|
-
# `Aws::InstanceProfileCredentails`
|
107
|
-
# timeouts.
|
119
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
|
+
# are very aggressive. Construct and pass an instance of
|
121
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
+
# enable retries and extended timeouts.
|
108
123
|
#
|
109
124
|
# @option options [required, String] :region
|
110
125
|
# The AWS region to connect to. The configured `:region` is
|
@@ -354,16 +369,225 @@ module Aws::QuickSight
|
|
354
369
|
req.send_request(options)
|
355
370
|
end
|
356
371
|
|
372
|
+
# Creates Amazon QuickSight customizations the current AWS Region.
|
373
|
+
# Currently, you can add a custom default theme by using the
|
374
|
+
# `CreateAccountCustomization` or `UpdateAccountCustomization` API
|
375
|
+
# operation. To further customize QuickSight by removing QuickSight
|
376
|
+
# sample assets and videos for all new users, see [Customizing
|
377
|
+
# QuickSight][1] in the Amazon QuickSight User Guide.
|
378
|
+
#
|
379
|
+
# You can create customizations for your AWS account or, if you specify
|
380
|
+
# a namespace, for a QuickSight namespace instead. Customizations that
|
381
|
+
# apply to a namespace always override customizations that apply to an
|
382
|
+
# AWS account. To find out which customizations apply, use the
|
383
|
+
# `DescribeAccountCustomization` API operation.
|
384
|
+
#
|
385
|
+
# Before you add a theme as the namespace default, make sure that you
|
386
|
+
# first share the theme with the namespace. If you don't share it with
|
387
|
+
# the namespace, the theme won't be visible to your users even if you
|
388
|
+
# use this API operation to make it the default theme.
|
389
|
+
#
|
390
|
+
#
|
391
|
+
#
|
392
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html
|
393
|
+
#
|
394
|
+
# @option params [required, String] :aws_account_id
|
395
|
+
# The ID for the AWS account that you want to customize QuickSight for.
|
396
|
+
#
|
397
|
+
# @option params [String] :namespace
|
398
|
+
# The QuickSight namespace that you want to add customizations to.
|
399
|
+
#
|
400
|
+
# @option params [required, Types::AccountCustomization] :account_customization
|
401
|
+
# The QuickSight customizations you're adding in the current AWS
|
402
|
+
# Region. You can add these to an AWS account and a QuickSight
|
403
|
+
# namespace.
|
404
|
+
#
|
405
|
+
# For example, you could add a default theme by setting
|
406
|
+
# `AccountCustomization` to the midnight theme: `"AccountCustomization":
|
407
|
+
# \{ "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" \}. `. Or,
|
408
|
+
# you could add a custom theme by specifying `"AccountCustomization": \{
|
409
|
+
# "DefaultTheme":
|
410
|
+
# "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639"
|
411
|
+
# \}`.
|
412
|
+
#
|
413
|
+
# @option params [Array<Types::Tag>] :tags
|
414
|
+
# A list of the tags that you want to attach to this resource.
|
415
|
+
#
|
416
|
+
# @return [Types::CreateAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
417
|
+
#
|
418
|
+
# * {Types::CreateAccountCustomizationResponse#arn #arn} => String
|
419
|
+
# * {Types::CreateAccountCustomizationResponse#aws_account_id #aws_account_id} => String
|
420
|
+
# * {Types::CreateAccountCustomizationResponse#namespace #namespace} => String
|
421
|
+
# * {Types::CreateAccountCustomizationResponse#account_customization #account_customization} => Types::AccountCustomization
|
422
|
+
# * {Types::CreateAccountCustomizationResponse#request_id #request_id} => String
|
423
|
+
# * {Types::CreateAccountCustomizationResponse#status #status} => Integer
|
424
|
+
#
|
425
|
+
# @example Request syntax with placeholder values
|
426
|
+
#
|
427
|
+
# resp = client.create_account_customization({
|
428
|
+
# aws_account_id: "AwsAccountId", # required
|
429
|
+
# namespace: "Namespace",
|
430
|
+
# account_customization: { # required
|
431
|
+
# default_theme: "Arn",
|
432
|
+
# },
|
433
|
+
# tags: [
|
434
|
+
# {
|
435
|
+
# key: "TagKey", # required
|
436
|
+
# value: "TagValue", # required
|
437
|
+
# },
|
438
|
+
# ],
|
439
|
+
# })
|
440
|
+
#
|
441
|
+
# @example Response structure
|
442
|
+
#
|
443
|
+
# resp.arn #=> String
|
444
|
+
# resp.aws_account_id #=> String
|
445
|
+
# resp.namespace #=> String
|
446
|
+
# resp.account_customization.default_theme #=> String
|
447
|
+
# resp.request_id #=> String
|
448
|
+
# resp.status #=> Integer
|
449
|
+
#
|
450
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAccountCustomization AWS API Documentation
|
451
|
+
#
|
452
|
+
# @overload create_account_customization(params = {})
|
453
|
+
# @param [Hash] params ({})
|
454
|
+
def create_account_customization(params = {}, options = {})
|
455
|
+
req = build_request(:create_account_customization, params)
|
456
|
+
req.send_request(options)
|
457
|
+
end
|
458
|
+
|
459
|
+
# Creates an analysis in Amazon QuickSight.
|
460
|
+
#
|
461
|
+
# @option params [required, String] :aws_account_id
|
462
|
+
# The ID of the AWS account where you are creating an analysis.
|
463
|
+
#
|
464
|
+
# @option params [required, String] :analysis_id
|
465
|
+
# The ID for the analysis that you're creating. This ID displays in the
|
466
|
+
# URL of the analysis.
|
467
|
+
#
|
468
|
+
# @option params [required, String] :name
|
469
|
+
# A descriptive name for the analysis that you're creating. This name
|
470
|
+
# displays for the analysis in the QuickSight console.
|
471
|
+
#
|
472
|
+
# @option params [Types::Parameters] :parameters
|
473
|
+
# The parameter names and override values that you want to use. An
|
474
|
+
# analysis can have any parameter type, and some parameters might accept
|
475
|
+
# multiple values.
|
476
|
+
#
|
477
|
+
# @option params [Array<Types::ResourcePermission>] :permissions
|
478
|
+
# A structure that describes the principals and the resource-level
|
479
|
+
# permissions on an analysis. You can use the `Permissions` structure to
|
480
|
+
# grant permissions by providing a list of AWS Identity and Access
|
481
|
+
# Management (IAM) action information for each principal listed by
|
482
|
+
# Amazon Resource Name (ARN).
|
483
|
+
#
|
484
|
+
# To specify no permissions, omit `Permissions`.
|
485
|
+
#
|
486
|
+
# @option params [required, Types::AnalysisSourceEntity] :source_entity
|
487
|
+
# A source entity to use for the analysis that you're creating. This
|
488
|
+
# metadata structure contains details that describe a source template
|
489
|
+
# and one or more datasets.
|
490
|
+
#
|
491
|
+
# @option params [String] :theme_arn
|
492
|
+
# The ARN for the theme to apply to the analysis that you're creating.
|
493
|
+
# To see the theme in the QuickSight console, make sure that you have
|
494
|
+
# access to it.
|
495
|
+
#
|
496
|
+
# @option params [Array<Types::Tag>] :tags
|
497
|
+
# Contains a map of the key-value pairs for the resource tag or tags
|
498
|
+
# assigned to the analysis.
|
499
|
+
#
|
500
|
+
# @return [Types::CreateAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
501
|
+
#
|
502
|
+
# * {Types::CreateAnalysisResponse#arn #arn} => String
|
503
|
+
# * {Types::CreateAnalysisResponse#analysis_id #analysis_id} => String
|
504
|
+
# * {Types::CreateAnalysisResponse#creation_status #creation_status} => String
|
505
|
+
# * {Types::CreateAnalysisResponse#status #status} => Integer
|
506
|
+
# * {Types::CreateAnalysisResponse#request_id #request_id} => String
|
507
|
+
#
|
508
|
+
# @example Request syntax with placeholder values
|
509
|
+
#
|
510
|
+
# resp = client.create_analysis({
|
511
|
+
# aws_account_id: "AwsAccountId", # required
|
512
|
+
# analysis_id: "RestrictiveResourceId", # required
|
513
|
+
# name: "AnalysisName", # required
|
514
|
+
# parameters: {
|
515
|
+
# string_parameters: [
|
516
|
+
# {
|
517
|
+
# name: "NonEmptyString", # required
|
518
|
+
# values: ["String"], # required
|
519
|
+
# },
|
520
|
+
# ],
|
521
|
+
# integer_parameters: [
|
522
|
+
# {
|
523
|
+
# name: "NonEmptyString", # required
|
524
|
+
# values: [1], # required
|
525
|
+
# },
|
526
|
+
# ],
|
527
|
+
# decimal_parameters: [
|
528
|
+
# {
|
529
|
+
# name: "NonEmptyString", # required
|
530
|
+
# values: [1.0], # required
|
531
|
+
# },
|
532
|
+
# ],
|
533
|
+
# date_time_parameters: [
|
534
|
+
# {
|
535
|
+
# name: "NonEmptyString", # required
|
536
|
+
# values: [Time.now], # required
|
537
|
+
# },
|
538
|
+
# ],
|
539
|
+
# },
|
540
|
+
# permissions: [
|
541
|
+
# {
|
542
|
+
# principal: "Principal", # required
|
543
|
+
# actions: ["String"], # required
|
544
|
+
# },
|
545
|
+
# ],
|
546
|
+
# source_entity: { # required
|
547
|
+
# source_template: {
|
548
|
+
# data_set_references: [ # required
|
549
|
+
# {
|
550
|
+
# data_set_placeholder: "NonEmptyString", # required
|
551
|
+
# data_set_arn: "Arn", # required
|
552
|
+
# },
|
553
|
+
# ],
|
554
|
+
# arn: "Arn", # required
|
555
|
+
# },
|
556
|
+
# },
|
557
|
+
# theme_arn: "Arn",
|
558
|
+
# tags: [
|
559
|
+
# {
|
560
|
+
# key: "TagKey", # required
|
561
|
+
# value: "TagValue", # required
|
562
|
+
# },
|
563
|
+
# ],
|
564
|
+
# })
|
565
|
+
#
|
566
|
+
# @example Response structure
|
567
|
+
#
|
568
|
+
# resp.arn #=> String
|
569
|
+
# resp.analysis_id #=> String
|
570
|
+
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
571
|
+
# resp.status #=> Integer
|
572
|
+
# resp.request_id #=> String
|
573
|
+
#
|
574
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAnalysis AWS API Documentation
|
575
|
+
#
|
576
|
+
# @overload create_analysis(params = {})
|
577
|
+
# @param [Hash] params ({})
|
578
|
+
def create_analysis(params = {}, options = {})
|
579
|
+
req = build_request(:create_analysis, params)
|
580
|
+
req.send_request(options)
|
581
|
+
end
|
582
|
+
|
357
583
|
# Creates a dashboard from a template. To first create a template, see
|
358
|
-
# the CreateTemplate API operation.
|
584
|
+
# the ` CreateTemplate ` API operation.
|
359
585
|
#
|
360
586
|
# A dashboard is an entity in QuickSight that identifies QuickSight
|
361
587
|
# reports, created from analyses. You can share QuickSight dashboards.
|
362
588
|
# With the right permissions, you can create scheduled email reports
|
363
|
-
# from them.
|
364
|
-
#
|
365
|
-
# you have the correct permissions, you can create a dashboard from a
|
366
|
-
# template that exists in a different AWS account.
|
589
|
+
# from them. If you have the correct permissions, you can create a
|
590
|
+
# dashboard from a template that exists in a different AWS account.
|
367
591
|
#
|
368
592
|
# @option params [required, String] :aws_account_id
|
369
593
|
# The ID of the AWS account where you want to create the dashboard.
|
@@ -375,14 +599,16 @@ module Aws::QuickSight
|
|
375
599
|
# The display name of the dashboard.
|
376
600
|
#
|
377
601
|
# @option params [Types::Parameters] :parameters
|
378
|
-
#
|
379
|
-
#
|
602
|
+
# The parameters for the creation of the dashboard, which you want to
|
603
|
+
# use to override the default settings. A dashboard can have any type of
|
380
604
|
# parameters, and some parameters might accept multiple values.
|
381
605
|
#
|
382
606
|
# @option params [Array<Types::ResourcePermission>] :permissions
|
383
607
|
# A structure that contains the permissions of the dashboard. You can
|
384
|
-
# use this structure for granting permissions
|
385
|
-
# information.
|
608
|
+
# use this structure for granting permissions by providing a list of IAM
|
609
|
+
# action information for each principal ARN.
|
610
|
+
#
|
611
|
+
# To specify no permissions, omit the permissions list.
|
386
612
|
#
|
387
613
|
# @option params [required, Types::DashboardSourceEntity] :source_entity
|
388
614
|
# The entity that you are using as a source when you create the
|
@@ -417,13 +643,19 @@ module Aws::QuickSight
|
|
417
643
|
#
|
418
644
|
# * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
|
419
645
|
# either `ENABLED` or `DISABLED`. The visual option to export data to
|
420
|
-
# .
|
646
|
+
# .CSV format isn't enabled when this is set to `DISABLED`. This
|
421
647
|
# option is `ENABLED` by default.
|
422
648
|
#
|
423
649
|
# * `VisibilityState` for `SheetControlsOption` - This visibility state
|
424
650
|
# can be either `COLLAPSED` or `EXPANDED`. This option is `COLLAPSED`
|
425
651
|
# by default.
|
426
652
|
#
|
653
|
+
# @option params [String] :theme_arn
|
654
|
+
# The Amazon Resource Name (ARN) of the theme that is being used for
|
655
|
+
# this dashboard. If you add a value for this field, it overrides the
|
656
|
+
# value that is used in the source entity. The theme ARN must exist in
|
657
|
+
# the same AWS account where you create the dashboard.
|
658
|
+
#
|
427
659
|
# @return [Types::CreateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
428
660
|
#
|
429
661
|
# * {Types::CreateDashboardResponse#arn #arn} => String
|
@@ -500,6 +732,7 @@ module Aws::QuickSight
|
|
500
732
|
# visibility_state: "EXPANDED", # accepts EXPANDED, COLLAPSED
|
501
733
|
# },
|
502
734
|
# },
|
735
|
+
# theme_arn: "Arn",
|
503
736
|
# })
|
504
737
|
#
|
505
738
|
# @example Response structure
|
@@ -507,7 +740,7 @@ module Aws::QuickSight
|
|
507
740
|
# resp.arn #=> String
|
508
741
|
# resp.version_arn #=> String
|
509
742
|
# resp.dashboard_id #=> String
|
510
|
-
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
743
|
+
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
511
744
|
# resp.status #=> Integer
|
512
745
|
# resp.request_id #=> String
|
513
746
|
#
|
@@ -682,6 +915,7 @@ module Aws::QuickSight
|
|
682
915
|
# },
|
683
916
|
# ],
|
684
917
|
# row_level_permission_data_set: {
|
918
|
+
# namespace: "Namespace",
|
685
919
|
# arn: "Arn", # required
|
686
920
|
# permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
|
687
921
|
# },
|
@@ -973,7 +1207,7 @@ module Aws::QuickSight
|
|
973
1207
|
#
|
974
1208
|
# resp.arn #=> String
|
975
1209
|
# resp.data_source_id #=> String
|
976
|
-
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
1210
|
+
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
977
1211
|
# resp.request_id #=> String
|
978
1212
|
# resp.status #=> Integer
|
979
1213
|
#
|
@@ -1221,6 +1455,76 @@ module Aws::QuickSight
|
|
1221
1455
|
req.send_request(options)
|
1222
1456
|
end
|
1223
1457
|
|
1458
|
+
# (Enterprise edition only) Creates a new namespace for you to use with
|
1459
|
+
# Amazon QuickSight.
|
1460
|
+
#
|
1461
|
+
# A namespace allows you to isolate the QuickSight users and groups that
|
1462
|
+
# are registered for that namespace. Users that access the namespace can
|
1463
|
+
# share assets only with other users or groups in the same namespace.
|
1464
|
+
# They can't see users and groups in other namespaces. You can create a
|
1465
|
+
# namespace after your AWS account is subscribed to QuickSight. The
|
1466
|
+
# namespace must be unique within the AWS account. By default, there is
|
1467
|
+
# a limit of 100 namespaces per AWS account. To increase your limit,
|
1468
|
+
# create a ticket with AWS Support.
|
1469
|
+
#
|
1470
|
+
# @option params [required, String] :aws_account_id
|
1471
|
+
# The ID for the AWS account that you want to create the QuickSight
|
1472
|
+
# namespace in.
|
1473
|
+
#
|
1474
|
+
# @option params [required, String] :namespace
|
1475
|
+
# The name that you want to use to describe the new namespace.
|
1476
|
+
#
|
1477
|
+
# @option params [required, String] :identity_store
|
1478
|
+
# Specifies the type of your user identity directory. Currently, this
|
1479
|
+
# supports users with an identity type of `QUICKSIGHT`.
|
1480
|
+
#
|
1481
|
+
# @option params [Array<Types::Tag>] :tags
|
1482
|
+
# The tags that you want to associate with the namespace that you're
|
1483
|
+
# creating.
|
1484
|
+
#
|
1485
|
+
# @return [Types::CreateNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1486
|
+
#
|
1487
|
+
# * {Types::CreateNamespaceResponse#arn #arn} => String
|
1488
|
+
# * {Types::CreateNamespaceResponse#name #name} => String
|
1489
|
+
# * {Types::CreateNamespaceResponse#capacity_region #capacity_region} => String
|
1490
|
+
# * {Types::CreateNamespaceResponse#creation_status #creation_status} => String
|
1491
|
+
# * {Types::CreateNamespaceResponse#identity_store #identity_store} => String
|
1492
|
+
# * {Types::CreateNamespaceResponse#request_id #request_id} => String
|
1493
|
+
# * {Types::CreateNamespaceResponse#status #status} => Integer
|
1494
|
+
#
|
1495
|
+
# @example Request syntax with placeholder values
|
1496
|
+
#
|
1497
|
+
# resp = client.create_namespace({
|
1498
|
+
# aws_account_id: "AwsAccountId", # required
|
1499
|
+
# namespace: "Namespace", # required
|
1500
|
+
# identity_store: "QUICKSIGHT", # required, accepts QUICKSIGHT
|
1501
|
+
# tags: [
|
1502
|
+
# {
|
1503
|
+
# key: "TagKey", # required
|
1504
|
+
# value: "TagValue", # required
|
1505
|
+
# },
|
1506
|
+
# ],
|
1507
|
+
# })
|
1508
|
+
#
|
1509
|
+
# @example Response structure
|
1510
|
+
#
|
1511
|
+
# resp.arn #=> String
|
1512
|
+
# resp.name #=> String
|
1513
|
+
# resp.capacity_region #=> String
|
1514
|
+
# resp.creation_status #=> String, one of "CREATED", "CREATING", "DELETING", "RETRYABLE_FAILURE", "NON_RETRYABLE_FAILURE"
|
1515
|
+
# resp.identity_store #=> String, one of "QUICKSIGHT"
|
1516
|
+
# resp.request_id #=> String
|
1517
|
+
# resp.status #=> Integer
|
1518
|
+
#
|
1519
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateNamespace AWS API Documentation
|
1520
|
+
#
|
1521
|
+
# @overload create_namespace(params = {})
|
1522
|
+
# @param [Hash] params ({})
|
1523
|
+
def create_namespace(params = {}, options = {})
|
1524
|
+
req = build_request(:create_namespace, params)
|
1525
|
+
req.send_request(options)
|
1526
|
+
end
|
1527
|
+
|
1224
1528
|
# Creates a template from an existing QuickSight analysis or template.
|
1225
1529
|
# You can use the resulting template to create a dashboard.
|
1226
1530
|
#
|
@@ -1322,7 +1626,7 @@ module Aws::QuickSight
|
|
1322
1626
|
# resp.arn #=> String
|
1323
1627
|
# resp.version_arn #=> String
|
1324
1628
|
# resp.template_id #=> String
|
1325
|
-
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
1629
|
+
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
1326
1630
|
# resp.status #=> Integer
|
1327
1631
|
# resp.request_id #=> String
|
1328
1632
|
#
|
@@ -1384,98 +1688,383 @@ module Aws::QuickSight
|
|
1384
1688
|
req.send_request(options)
|
1385
1689
|
end
|
1386
1690
|
|
1387
|
-
#
|
1691
|
+
# Creates a theme.
|
1692
|
+
#
|
1693
|
+
# A *theme* is set of configuration options for color and layout. Themes
|
1694
|
+
# apply to analyses and dashboards. For more information, see [Using
|
1695
|
+
# Themes in Amazon QuickSight][1] in the *Amazon QuickSight User Guide*.
|
1696
|
+
#
|
1697
|
+
#
|
1698
|
+
#
|
1699
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html
|
1388
1700
|
#
|
1389
1701
|
# @option params [required, String] :aws_account_id
|
1390
|
-
# The ID of the AWS account
|
1391
|
-
# deleting.
|
1702
|
+
# The ID of the AWS account where you want to store the new theme.
|
1392
1703
|
#
|
1393
|
-
# @option params [required, String] :
|
1394
|
-
#
|
1704
|
+
# @option params [required, String] :theme_id
|
1705
|
+
# An ID for the theme that you want to create. The theme ID is unique
|
1706
|
+
# per AWS Region in each AWS account.
|
1395
1707
|
#
|
1396
|
-
# @option params [
|
1397
|
-
#
|
1398
|
-
# provided, only the specified version of the dashboard is deleted.
|
1708
|
+
# @option params [required, String] :name
|
1709
|
+
# A display name for the theme.
|
1399
1710
|
#
|
1400
|
-
# @
|
1711
|
+
# @option params [required, String] :base_theme_id
|
1712
|
+
# The ID of the theme that a custom theme will inherit from. All themes
|
1713
|
+
# inherit from one of the starting themes defined by Amazon QuickSight.
|
1714
|
+
# For a list of the starting themes, use `ListThemes` or choose
|
1715
|
+
# **Themes** from within a QuickSight analysis.
|
1401
1716
|
#
|
1402
|
-
#
|
1403
|
-
#
|
1404
|
-
#
|
1405
|
-
#
|
1717
|
+
# @option params [String] :version_description
|
1718
|
+
# A description of the first version of the theme that you're creating.
|
1719
|
+
# Every time `UpdateTheme` is called, a new version is created. Each
|
1720
|
+
# version of the theme has a description of the version in the
|
1721
|
+
# `VersionDescription` field.
|
1722
|
+
#
|
1723
|
+
# @option params [required, Types::ThemeConfiguration] :configuration
|
1724
|
+
# The theme configuration, which contains the theme display properties.
|
1725
|
+
#
|
1726
|
+
# @option params [Array<Types::ResourcePermission>] :permissions
|
1727
|
+
# A valid grouping of resource permissions to apply to the new theme.
|
1728
|
+
#
|
1729
|
+
# @option params [Array<Types::Tag>] :tags
|
1730
|
+
# A map of the key-value pairs for the resource tag or tags that you
|
1731
|
+
# want to add to the resource.
|
1732
|
+
#
|
1733
|
+
# @return [Types::CreateThemeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1734
|
+
#
|
1735
|
+
# * {Types::CreateThemeResponse#arn #arn} => String
|
1736
|
+
# * {Types::CreateThemeResponse#version_arn #version_arn} => String
|
1737
|
+
# * {Types::CreateThemeResponse#theme_id #theme_id} => String
|
1738
|
+
# * {Types::CreateThemeResponse#creation_status #creation_status} => String
|
1739
|
+
# * {Types::CreateThemeResponse#status #status} => Integer
|
1740
|
+
# * {Types::CreateThemeResponse#request_id #request_id} => String
|
1406
1741
|
#
|
1407
1742
|
# @example Request syntax with placeholder values
|
1408
1743
|
#
|
1409
|
-
# resp = client.
|
1744
|
+
# resp = client.create_theme({
|
1410
1745
|
# aws_account_id: "AwsAccountId", # required
|
1411
|
-
#
|
1412
|
-
#
|
1746
|
+
# theme_id: "RestrictiveResourceId", # required
|
1747
|
+
# name: "ThemeName", # required
|
1748
|
+
# base_theme_id: "RestrictiveResourceId", # required
|
1749
|
+
# version_description: "VersionDescription",
|
1750
|
+
# configuration: { # required
|
1751
|
+
# data_color_palette: {
|
1752
|
+
# colors: ["HexColor"],
|
1753
|
+
# min_max_gradient: ["HexColor"],
|
1754
|
+
# empty_fill_color: "HexColor",
|
1755
|
+
# },
|
1756
|
+
# ui_color_palette: {
|
1757
|
+
# primary_foreground: "HexColor",
|
1758
|
+
# primary_background: "HexColor",
|
1759
|
+
# secondary_foreground: "HexColor",
|
1760
|
+
# secondary_background: "HexColor",
|
1761
|
+
# accent: "HexColor",
|
1762
|
+
# accent_foreground: "HexColor",
|
1763
|
+
# danger: "HexColor",
|
1764
|
+
# danger_foreground: "HexColor",
|
1765
|
+
# warning: "HexColor",
|
1766
|
+
# warning_foreground: "HexColor",
|
1767
|
+
# success: "HexColor",
|
1768
|
+
# success_foreground: "HexColor",
|
1769
|
+
# dimension: "HexColor",
|
1770
|
+
# dimension_foreground: "HexColor",
|
1771
|
+
# measure: "HexColor",
|
1772
|
+
# measure_foreground: "HexColor",
|
1773
|
+
# },
|
1774
|
+
# sheet: {
|
1775
|
+
# tile: {
|
1776
|
+
# border: {
|
1777
|
+
# show: false,
|
1778
|
+
# },
|
1779
|
+
# },
|
1780
|
+
# tile_layout: {
|
1781
|
+
# gutter: {
|
1782
|
+
# show: false,
|
1783
|
+
# },
|
1784
|
+
# margin: {
|
1785
|
+
# show: false,
|
1786
|
+
# },
|
1787
|
+
# },
|
1788
|
+
# },
|
1789
|
+
# },
|
1790
|
+
# permissions: [
|
1791
|
+
# {
|
1792
|
+
# principal: "Principal", # required
|
1793
|
+
# actions: ["String"], # required
|
1794
|
+
# },
|
1795
|
+
# ],
|
1796
|
+
# tags: [
|
1797
|
+
# {
|
1798
|
+
# key: "TagKey", # required
|
1799
|
+
# value: "TagValue", # required
|
1800
|
+
# },
|
1801
|
+
# ],
|
1413
1802
|
# })
|
1414
1803
|
#
|
1415
1804
|
# @example Response structure
|
1416
1805
|
#
|
1417
|
-
# resp.status #=> Integer
|
1418
1806
|
# resp.arn #=> String
|
1419
|
-
# resp.
|
1807
|
+
# resp.version_arn #=> String
|
1808
|
+
# resp.theme_id #=> String
|
1809
|
+
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
1810
|
+
# resp.status #=> Integer
|
1420
1811
|
# resp.request_id #=> String
|
1421
1812
|
#
|
1422
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
1813
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateTheme AWS API Documentation
|
1423
1814
|
#
|
1424
|
-
# @overload
|
1815
|
+
# @overload create_theme(params = {})
|
1425
1816
|
# @param [Hash] params ({})
|
1426
|
-
def
|
1427
|
-
req = build_request(:
|
1817
|
+
def create_theme(params = {}, options = {})
|
1818
|
+
req = build_request(:create_theme, params)
|
1428
1819
|
req.send_request(options)
|
1429
1820
|
end
|
1430
1821
|
|
1431
|
-
#
|
1822
|
+
# Creates a theme alias for a theme.
|
1432
1823
|
#
|
1433
1824
|
# @option params [required, String] :aws_account_id
|
1434
|
-
# The AWS account
|
1825
|
+
# The ID of the AWS account that contains the theme for the new theme
|
1826
|
+
# alias.
|
1435
1827
|
#
|
1436
|
-
# @option params [required, String] :
|
1437
|
-
#
|
1438
|
-
# AWS Region for each AWS account.
|
1828
|
+
# @option params [required, String] :theme_id
|
1829
|
+
# An ID for the theme alias.
|
1439
1830
|
#
|
1440
|
-
# @
|
1831
|
+
# @option params [required, String] :alias_name
|
1832
|
+
# The name that you want to give to the theme alias that you are
|
1833
|
+
# creating. The alias name can't begin with a `$`. Alias names that
|
1834
|
+
# start with `$` are reserved by Amazon QuickSight.
|
1441
1835
|
#
|
1442
|
-
#
|
1443
|
-
#
|
1444
|
-
#
|
1445
|
-
#
|
1836
|
+
# @option params [required, Integer] :theme_version_number
|
1837
|
+
# The version number of the theme.
|
1838
|
+
#
|
1839
|
+
# @return [Types::CreateThemeAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1840
|
+
#
|
1841
|
+
# * {Types::CreateThemeAliasResponse#theme_alias #theme_alias} => Types::ThemeAlias
|
1842
|
+
# * {Types::CreateThemeAliasResponse#status #status} => Integer
|
1843
|
+
# * {Types::CreateThemeAliasResponse#request_id #request_id} => String
|
1446
1844
|
#
|
1447
1845
|
# @example Request syntax with placeholder values
|
1448
1846
|
#
|
1449
|
-
# resp = client.
|
1847
|
+
# resp = client.create_theme_alias({
|
1450
1848
|
# aws_account_id: "AwsAccountId", # required
|
1451
|
-
#
|
1849
|
+
# theme_id: "RestrictiveResourceId", # required
|
1850
|
+
# alias_name: "AliasName", # required
|
1851
|
+
# theme_version_number: 1, # required
|
1452
1852
|
# })
|
1453
1853
|
#
|
1454
1854
|
# @example Response structure
|
1455
1855
|
#
|
1456
|
-
# resp.arn #=> String
|
1457
|
-
# resp.
|
1458
|
-
# resp.
|
1856
|
+
# resp.theme_alias.arn #=> String
|
1857
|
+
# resp.theme_alias.alias_name #=> String
|
1858
|
+
# resp.theme_alias.theme_version_number #=> Integer
|
1459
1859
|
# resp.status #=> Integer
|
1860
|
+
# resp.request_id #=> String
|
1460
1861
|
#
|
1461
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
1862
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateThemeAlias AWS API Documentation
|
1462
1863
|
#
|
1463
|
-
# @overload
|
1864
|
+
# @overload create_theme_alias(params = {})
|
1464
1865
|
# @param [Hash] params ({})
|
1465
|
-
def
|
1466
|
-
req = build_request(:
|
1866
|
+
def create_theme_alias(params = {}, options = {})
|
1867
|
+
req = build_request(:create_theme_alias, params)
|
1467
1868
|
req.send_request(options)
|
1468
1869
|
end
|
1469
1870
|
|
1470
|
-
# Deletes
|
1471
|
-
#
|
1871
|
+
# Deletes all Amazon QuickSight customizations in this AWS Region for
|
1872
|
+
# the specified AWS Account and QuickSight namespace.
|
1472
1873
|
#
|
1473
1874
|
# @option params [required, String] :aws_account_id
|
1474
|
-
# The AWS account
|
1875
|
+
# The ID for the AWS account that you want to delete QuickSight
|
1876
|
+
# customizations from in this AWS Region.
|
1475
1877
|
#
|
1476
|
-
# @option params [
|
1477
|
-
# The
|
1478
|
-
#
|
1878
|
+
# @option params [String] :namespace
|
1879
|
+
# The QuickSight namespace that you're deleting the customizations
|
1880
|
+
# from.
|
1881
|
+
#
|
1882
|
+
# @return [Types::DeleteAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1883
|
+
#
|
1884
|
+
# * {Types::DeleteAccountCustomizationResponse#request_id #request_id} => String
|
1885
|
+
# * {Types::DeleteAccountCustomizationResponse#status #status} => Integer
|
1886
|
+
#
|
1887
|
+
# @example Request syntax with placeholder values
|
1888
|
+
#
|
1889
|
+
# resp = client.delete_account_customization({
|
1890
|
+
# aws_account_id: "AwsAccountId", # required
|
1891
|
+
# namespace: "Namespace",
|
1892
|
+
# })
|
1893
|
+
#
|
1894
|
+
# @example Response structure
|
1895
|
+
#
|
1896
|
+
# resp.request_id #=> String
|
1897
|
+
# resp.status #=> Integer
|
1898
|
+
#
|
1899
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAccountCustomization AWS API Documentation
|
1900
|
+
#
|
1901
|
+
# @overload delete_account_customization(params = {})
|
1902
|
+
# @param [Hash] params ({})
|
1903
|
+
def delete_account_customization(params = {}, options = {})
|
1904
|
+
req = build_request(:delete_account_customization, params)
|
1905
|
+
req.send_request(options)
|
1906
|
+
end
|
1907
|
+
|
1908
|
+
# Deletes an analysis from Amazon QuickSight. You can optionally include
|
1909
|
+
# a recovery window during which you can restore the analysis. If you
|
1910
|
+
# don't specify a recovery window value, the operation defaults to 30
|
1911
|
+
# days. QuickSight attaches a `DeletionTime` stamp to the response that
|
1912
|
+
# specifies the end of the recovery window. At the end of the recovery
|
1913
|
+
# window, QuickSight deletes the analysis permanently.
|
1914
|
+
#
|
1915
|
+
# At any time before recovery window ends, you can use the
|
1916
|
+
# `RestoreAnalysis` API operation to remove the `DeletionTime` stamp and
|
1917
|
+
# cancel the deletion of the analysis. The analysis remains visible in
|
1918
|
+
# the API until it's deleted, so you can describe it but you can't
|
1919
|
+
# make a template from it.
|
1920
|
+
#
|
1921
|
+
# An analysis that's scheduled for deletion isn't accessible in the
|
1922
|
+
# QuickSight console. To access it in the console, restore it. Deleting
|
1923
|
+
# an analysis doesn't delete the dashboards that you publish from it.
|
1924
|
+
#
|
1925
|
+
# @option params [required, String] :aws_account_id
|
1926
|
+
# The ID of the AWS account where you want to delete an analysis.
|
1927
|
+
#
|
1928
|
+
# @option params [required, String] :analysis_id
|
1929
|
+
# The ID of the analysis that you're deleting.
|
1930
|
+
#
|
1931
|
+
# @option params [Integer] :recovery_window_in_days
|
1932
|
+
# A value that specifies the number of days that QuickSight waits before
|
1933
|
+
# it deletes the analysis. You can't use this parameter with the
|
1934
|
+
# `ForceDeleteWithoutRecovery` option in the same API call. The default
|
1935
|
+
# value is 30.
|
1936
|
+
#
|
1937
|
+
# @option params [Boolean] :force_delete_without_recovery
|
1938
|
+
# This option defaults to the value `NoForceDeleteWithoutRecovery`. To
|
1939
|
+
# immediately delete the analysis, add the `ForceDeleteWithoutRecovery`
|
1940
|
+
# option. You can't restore an analysis after it's deleted.
|
1941
|
+
#
|
1942
|
+
# @return [Types::DeleteAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1943
|
+
#
|
1944
|
+
# * {Types::DeleteAnalysisResponse#status #status} => Integer
|
1945
|
+
# * {Types::DeleteAnalysisResponse#arn #arn} => String
|
1946
|
+
# * {Types::DeleteAnalysisResponse#analysis_id #analysis_id} => String
|
1947
|
+
# * {Types::DeleteAnalysisResponse#deletion_time #deletion_time} => Time
|
1948
|
+
# * {Types::DeleteAnalysisResponse#request_id #request_id} => String
|
1949
|
+
#
|
1950
|
+
# @example Request syntax with placeholder values
|
1951
|
+
#
|
1952
|
+
# resp = client.delete_analysis({
|
1953
|
+
# aws_account_id: "AwsAccountId", # required
|
1954
|
+
# analysis_id: "RestrictiveResourceId", # required
|
1955
|
+
# recovery_window_in_days: 1,
|
1956
|
+
# force_delete_without_recovery: false,
|
1957
|
+
# })
|
1958
|
+
#
|
1959
|
+
# @example Response structure
|
1960
|
+
#
|
1961
|
+
# resp.status #=> Integer
|
1962
|
+
# resp.arn #=> String
|
1963
|
+
# resp.analysis_id #=> String
|
1964
|
+
# resp.deletion_time #=> Time
|
1965
|
+
# resp.request_id #=> String
|
1966
|
+
#
|
1967
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAnalysis AWS API Documentation
|
1968
|
+
#
|
1969
|
+
# @overload delete_analysis(params = {})
|
1970
|
+
# @param [Hash] params ({})
|
1971
|
+
def delete_analysis(params = {}, options = {})
|
1972
|
+
req = build_request(:delete_analysis, params)
|
1973
|
+
req.send_request(options)
|
1974
|
+
end
|
1975
|
+
|
1976
|
+
# Deletes a dashboard.
|
1977
|
+
#
|
1978
|
+
# @option params [required, String] :aws_account_id
|
1979
|
+
# The ID of the AWS account that contains the dashboard that you're
|
1980
|
+
# deleting.
|
1981
|
+
#
|
1982
|
+
# @option params [required, String] :dashboard_id
|
1983
|
+
# The ID for the dashboard.
|
1984
|
+
#
|
1985
|
+
# @option params [Integer] :version_number
|
1986
|
+
# The version number of the dashboard. If the version number property is
|
1987
|
+
# provided, only the specified version of the dashboard is deleted.
|
1988
|
+
#
|
1989
|
+
# @return [Types::DeleteDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1990
|
+
#
|
1991
|
+
# * {Types::DeleteDashboardResponse#status #status} => Integer
|
1992
|
+
# * {Types::DeleteDashboardResponse#arn #arn} => String
|
1993
|
+
# * {Types::DeleteDashboardResponse#dashboard_id #dashboard_id} => String
|
1994
|
+
# * {Types::DeleteDashboardResponse#request_id #request_id} => String
|
1995
|
+
#
|
1996
|
+
# @example Request syntax with placeholder values
|
1997
|
+
#
|
1998
|
+
# resp = client.delete_dashboard({
|
1999
|
+
# aws_account_id: "AwsAccountId", # required
|
2000
|
+
# dashboard_id: "RestrictiveResourceId", # required
|
2001
|
+
# version_number: 1,
|
2002
|
+
# })
|
2003
|
+
#
|
2004
|
+
# @example Response structure
|
2005
|
+
#
|
2006
|
+
# resp.status #=> Integer
|
2007
|
+
# resp.arn #=> String
|
2008
|
+
# resp.dashboard_id #=> String
|
2009
|
+
# resp.request_id #=> String
|
2010
|
+
#
|
2011
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDashboard AWS API Documentation
|
2012
|
+
#
|
2013
|
+
# @overload delete_dashboard(params = {})
|
2014
|
+
# @param [Hash] params ({})
|
2015
|
+
def delete_dashboard(params = {}, options = {})
|
2016
|
+
req = build_request(:delete_dashboard, params)
|
2017
|
+
req.send_request(options)
|
2018
|
+
end
|
2019
|
+
|
2020
|
+
# Deletes a dataset.
|
2021
|
+
#
|
2022
|
+
# @option params [required, String] :aws_account_id
|
2023
|
+
# The AWS account ID.
|
2024
|
+
#
|
2025
|
+
# @option params [required, String] :data_set_id
|
2026
|
+
# The ID for the dataset that you want to create. This ID is unique per
|
2027
|
+
# AWS Region for each AWS account.
|
2028
|
+
#
|
2029
|
+
# @return [Types::DeleteDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2030
|
+
#
|
2031
|
+
# * {Types::DeleteDataSetResponse#arn #arn} => String
|
2032
|
+
# * {Types::DeleteDataSetResponse#data_set_id #data_set_id} => String
|
2033
|
+
# * {Types::DeleteDataSetResponse#request_id #request_id} => String
|
2034
|
+
# * {Types::DeleteDataSetResponse#status #status} => Integer
|
2035
|
+
#
|
2036
|
+
# @example Request syntax with placeholder values
|
2037
|
+
#
|
2038
|
+
# resp = client.delete_data_set({
|
2039
|
+
# aws_account_id: "AwsAccountId", # required
|
2040
|
+
# data_set_id: "ResourceId", # required
|
2041
|
+
# })
|
2042
|
+
#
|
2043
|
+
# @example Response structure
|
2044
|
+
#
|
2045
|
+
# resp.arn #=> String
|
2046
|
+
# resp.data_set_id #=> String
|
2047
|
+
# resp.request_id #=> String
|
2048
|
+
# resp.status #=> Integer
|
2049
|
+
#
|
2050
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDataSet AWS API Documentation
|
2051
|
+
#
|
2052
|
+
# @overload delete_data_set(params = {})
|
2053
|
+
# @param [Hash] params ({})
|
2054
|
+
def delete_data_set(params = {}, options = {})
|
2055
|
+
req = build_request(:delete_data_set, params)
|
2056
|
+
req.send_request(options)
|
2057
|
+
end
|
2058
|
+
|
2059
|
+
# Deletes the data source permanently. This operation breaks all the
|
2060
|
+
# datasets that reference the deleted data source.
|
2061
|
+
#
|
2062
|
+
# @option params [required, String] :aws_account_id
|
2063
|
+
# The AWS account ID.
|
2064
|
+
#
|
2065
|
+
# @option params [required, String] :data_source_id
|
2066
|
+
# The ID of the data source. This ID is unique per AWS Region for each
|
2067
|
+
# AWS account.
|
1479
2068
|
#
|
1480
2069
|
# @return [Types::DeleteDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1481
2070
|
#
|
@@ -1633,6 +2222,45 @@ module Aws::QuickSight
|
|
1633
2222
|
req.send_request(options)
|
1634
2223
|
end
|
1635
2224
|
|
2225
|
+
# Deletes a namespace and the users and groups that are associated with
|
2226
|
+
# the namespace. This is an asynchronous process. Assets including
|
2227
|
+
# dashboards, analyses, datasets and data sources are not deleted. To
|
2228
|
+
# delete these assets, you use the API operations for the relevant
|
2229
|
+
# asset.
|
2230
|
+
#
|
2231
|
+
# @option params [required, String] :aws_account_id
|
2232
|
+
# The ID for the AWS account that you want to delete the QuickSight
|
2233
|
+
# namespace from.
|
2234
|
+
#
|
2235
|
+
# @option params [required, String] :namespace
|
2236
|
+
# The namespace that you want to delete.
|
2237
|
+
#
|
2238
|
+
# @return [Types::DeleteNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2239
|
+
#
|
2240
|
+
# * {Types::DeleteNamespaceResponse#request_id #request_id} => String
|
2241
|
+
# * {Types::DeleteNamespaceResponse#status #status} => Integer
|
2242
|
+
#
|
2243
|
+
# @example Request syntax with placeholder values
|
2244
|
+
#
|
2245
|
+
# resp = client.delete_namespace({
|
2246
|
+
# aws_account_id: "AwsAccountId", # required
|
2247
|
+
# namespace: "Namespace", # required
|
2248
|
+
# })
|
2249
|
+
#
|
2250
|
+
# @example Response structure
|
2251
|
+
#
|
2252
|
+
# resp.request_id #=> String
|
2253
|
+
# resp.status #=> Integer
|
2254
|
+
#
|
2255
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteNamespace AWS API Documentation
|
2256
|
+
#
|
2257
|
+
# @overload delete_namespace(params = {})
|
2258
|
+
# @param [Hash] params ({})
|
2259
|
+
def delete_namespace(params = {}, options = {})
|
2260
|
+
req = build_request(:delete_namespace, params)
|
2261
|
+
req.send_request(options)
|
2262
|
+
end
|
2263
|
+
|
1636
2264
|
# Deletes a template.
|
1637
2265
|
#
|
1638
2266
|
# @option params [required, String] :aws_account_id
|
@@ -1727,6 +2355,98 @@ module Aws::QuickSight
|
|
1727
2355
|
req.send_request(options)
|
1728
2356
|
end
|
1729
2357
|
|
2358
|
+
# Deletes a theme.
|
2359
|
+
#
|
2360
|
+
# @option params [required, String] :aws_account_id
|
2361
|
+
# The ID of the AWS account that contains the theme that you're
|
2362
|
+
# deleting.
|
2363
|
+
#
|
2364
|
+
# @option params [required, String] :theme_id
|
2365
|
+
# An ID for the theme that you want to delete.
|
2366
|
+
#
|
2367
|
+
# @option params [Integer] :version_number
|
2368
|
+
# The version of the theme that you want to delete.
|
2369
|
+
#
|
2370
|
+
# **Note:** If you don't provide a version number, you're using this
|
2371
|
+
# call to `DeleteTheme` to delete all versions of the theme.
|
2372
|
+
#
|
2373
|
+
# @return [Types::DeleteThemeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2374
|
+
#
|
2375
|
+
# * {Types::DeleteThemeResponse#arn #arn} => String
|
2376
|
+
# * {Types::DeleteThemeResponse#request_id #request_id} => String
|
2377
|
+
# * {Types::DeleteThemeResponse#status #status} => Integer
|
2378
|
+
# * {Types::DeleteThemeResponse#theme_id #theme_id} => String
|
2379
|
+
#
|
2380
|
+
# @example Request syntax with placeholder values
|
2381
|
+
#
|
2382
|
+
# resp = client.delete_theme({
|
2383
|
+
# aws_account_id: "AwsAccountId", # required
|
2384
|
+
# theme_id: "RestrictiveResourceId", # required
|
2385
|
+
# version_number: 1,
|
2386
|
+
# })
|
2387
|
+
#
|
2388
|
+
# @example Response structure
|
2389
|
+
#
|
2390
|
+
# resp.arn #=> String
|
2391
|
+
# resp.request_id #=> String
|
2392
|
+
# resp.status #=> Integer
|
2393
|
+
# resp.theme_id #=> String
|
2394
|
+
#
|
2395
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteTheme AWS API Documentation
|
2396
|
+
#
|
2397
|
+
# @overload delete_theme(params = {})
|
2398
|
+
# @param [Hash] params ({})
|
2399
|
+
def delete_theme(params = {}, options = {})
|
2400
|
+
req = build_request(:delete_theme, params)
|
2401
|
+
req.send_request(options)
|
2402
|
+
end
|
2403
|
+
|
2404
|
+
# Deletes the version of the theme that the specified theme alias points
|
2405
|
+
# to. If you provide a specific alias, you delete the version of the
|
2406
|
+
# theme that the alias points to.
|
2407
|
+
#
|
2408
|
+
# @option params [required, String] :aws_account_id
|
2409
|
+
# The ID of the AWS account that contains the theme alias to delete.
|
2410
|
+
#
|
2411
|
+
# @option params [required, String] :theme_id
|
2412
|
+
# The ID for the theme that the specified alias is for.
|
2413
|
+
#
|
2414
|
+
# @option params [required, String] :alias_name
|
2415
|
+
# The unique name for the theme alias to delete.
|
2416
|
+
#
|
2417
|
+
# @return [Types::DeleteThemeAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2418
|
+
#
|
2419
|
+
# * {Types::DeleteThemeAliasResponse#alias_name #alias_name} => String
|
2420
|
+
# * {Types::DeleteThemeAliasResponse#arn #arn} => String
|
2421
|
+
# * {Types::DeleteThemeAliasResponse#request_id #request_id} => String
|
2422
|
+
# * {Types::DeleteThemeAliasResponse#status #status} => Integer
|
2423
|
+
# * {Types::DeleteThemeAliasResponse#theme_id #theme_id} => String
|
2424
|
+
#
|
2425
|
+
# @example Request syntax with placeholder values
|
2426
|
+
#
|
2427
|
+
# resp = client.delete_theme_alias({
|
2428
|
+
# aws_account_id: "AwsAccountId", # required
|
2429
|
+
# theme_id: "RestrictiveResourceId", # required
|
2430
|
+
# alias_name: "AliasName", # required
|
2431
|
+
# })
|
2432
|
+
#
|
2433
|
+
# @example Response structure
|
2434
|
+
#
|
2435
|
+
# resp.alias_name #=> String
|
2436
|
+
# resp.arn #=> String
|
2437
|
+
# resp.request_id #=> String
|
2438
|
+
# resp.status #=> Integer
|
2439
|
+
# resp.theme_id #=> String
|
2440
|
+
#
|
2441
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteThemeAlias AWS API Documentation
|
2442
|
+
#
|
2443
|
+
# @overload delete_theme_alias(params = {})
|
2444
|
+
# @param [Hash] params ({})
|
2445
|
+
def delete_theme_alias(params = {}, options = {})
|
2446
|
+
req = build_request(:delete_theme_alias, params)
|
2447
|
+
req.send_request(options)
|
2448
|
+
end
|
2449
|
+
|
1730
2450
|
# Deletes the Amazon QuickSight user that is associated with the
|
1731
2451
|
# identity of the AWS Identity and Access Management (IAM) user or role
|
1732
2452
|
# that's making the call. The IAM user isn't deleted as a result of
|
@@ -1808,6 +2528,243 @@ module Aws::QuickSight
|
|
1808
2528
|
req.send_request(options)
|
1809
2529
|
end
|
1810
2530
|
|
2531
|
+
# Describes the customizations associated with the provided AWS account
|
2532
|
+
# and Amazon QuickSight namespace in an AWS Region. The QuickSight
|
2533
|
+
# console evaluates which customizations to apply by running this API
|
2534
|
+
# operation with the `Resolved` flag included.
|
2535
|
+
#
|
2536
|
+
# To determine what customizations display when you run this command, it
|
2537
|
+
# can help to visualize the relationship of the entities involved.
|
2538
|
+
#
|
2539
|
+
# * `AWS Account` - The AWS account exists at the top of the hierarchy.
|
2540
|
+
# It has the potential to use all of the AWS Regions and AWS Services.
|
2541
|
+
# When you subscribe to QuickSight, you choose one AWS Region to use
|
2542
|
+
# as your home region. That's where your free SPICE capacity is
|
2543
|
+
# located. You can use QuickSight in any supported AWS Region.
|
2544
|
+
#
|
2545
|
+
# * `AWS Region` - In each AWS Region where you sign in to QuickSight at
|
2546
|
+
# least once, QuickSight acts as a separate instance of the same
|
2547
|
+
# service. If you have a user directory, it resides in us-east-1,
|
2548
|
+
# which is the US East (N. Virginia). Generally speaking, these users
|
2549
|
+
# have access to QuickSight in any AWS Region, unless they are
|
2550
|
+
# constrained to a namespace.
|
2551
|
+
#
|
2552
|
+
# To run the command in a different AWS Region, you change your region
|
2553
|
+
# settings. If you're using the AWS CLI, you can use one of the
|
2554
|
+
# following options:
|
2555
|
+
#
|
2556
|
+
# * Use [command line options][1].
|
2557
|
+
#
|
2558
|
+
# * Use [named profiles][2].
|
2559
|
+
#
|
2560
|
+
# * Run `aws configure` to change your default AWS Region. Use Enter
|
2561
|
+
# to key the same settings for your keys. For more information, see
|
2562
|
+
# [Configuring the AWS CLI][3].
|
2563
|
+
#
|
2564
|
+
# * `Namespace` - A QuickSight namespace is a partition that contains
|
2565
|
+
# users and assets (data sources, datasets, dashboards, and so on). To
|
2566
|
+
# access assets that are in a specific namespace, users and groups
|
2567
|
+
# must also be part of the same namespace. People who share a
|
2568
|
+
# namespace are completely isolated from users and assets in other
|
2569
|
+
# namespaces, even if they are in the same AWS account and AWS Region.
|
2570
|
+
#
|
2571
|
+
# * `Applied customizations` - Within an AWS Region, a set of QuickSight
|
2572
|
+
# customizations can apply to an AWS account or to a namespace.
|
2573
|
+
# Settings that you apply to a namespace override settings that you
|
2574
|
+
# apply to an AWS Account. All settings are isolated to a single AWS
|
2575
|
+
# Region. To apply them in other AWS Regions, run the
|
2576
|
+
# `CreateAccountCustomization` command in each AWS Region where you
|
2577
|
+
# want to apply the same customizations.
|
2578
|
+
#
|
2579
|
+
#
|
2580
|
+
#
|
2581
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html
|
2582
|
+
# [2]: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html
|
2583
|
+
# [3]: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html
|
2584
|
+
#
|
2585
|
+
# @option params [required, String] :aws_account_id
|
2586
|
+
# The ID for the AWS account that you want to describe QuickSight
|
2587
|
+
# customizations for.
|
2588
|
+
#
|
2589
|
+
# @option params [String] :namespace
|
2590
|
+
# The QuickSight namespace that you want to describe QuickSight
|
2591
|
+
# customizations for.
|
2592
|
+
#
|
2593
|
+
# @option params [Boolean] :resolved
|
2594
|
+
# The `Resolved` flag works with the other parameters to determine which
|
2595
|
+
# view of QuickSight customizations is returned. You can add this flag
|
2596
|
+
# to your command to use the same view that QuickSight uses to identify
|
2597
|
+
# which customizations to apply to the console. Omit this flag, or set
|
2598
|
+
# it to `no-resolved`, to reveal customizations that are configured at
|
2599
|
+
# different levels.
|
2600
|
+
#
|
2601
|
+
# @return [Types::DescribeAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2602
|
+
#
|
2603
|
+
# * {Types::DescribeAccountCustomizationResponse#arn #arn} => String
|
2604
|
+
# * {Types::DescribeAccountCustomizationResponse#aws_account_id #aws_account_id} => String
|
2605
|
+
# * {Types::DescribeAccountCustomizationResponse#namespace #namespace} => String
|
2606
|
+
# * {Types::DescribeAccountCustomizationResponse#account_customization #account_customization} => Types::AccountCustomization
|
2607
|
+
# * {Types::DescribeAccountCustomizationResponse#request_id #request_id} => String
|
2608
|
+
# * {Types::DescribeAccountCustomizationResponse#status #status} => Integer
|
2609
|
+
#
|
2610
|
+
# @example Request syntax with placeholder values
|
2611
|
+
#
|
2612
|
+
# resp = client.describe_account_customization({
|
2613
|
+
# aws_account_id: "AwsAccountId", # required
|
2614
|
+
# namespace: "Namespace",
|
2615
|
+
# resolved: false,
|
2616
|
+
# })
|
2617
|
+
#
|
2618
|
+
# @example Response structure
|
2619
|
+
#
|
2620
|
+
# resp.arn #=> String
|
2621
|
+
# resp.aws_account_id #=> String
|
2622
|
+
# resp.namespace #=> String
|
2623
|
+
# resp.account_customization.default_theme #=> String
|
2624
|
+
# resp.request_id #=> String
|
2625
|
+
# resp.status #=> Integer
|
2626
|
+
#
|
2627
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountCustomization AWS API Documentation
|
2628
|
+
#
|
2629
|
+
# @overload describe_account_customization(params = {})
|
2630
|
+
# @param [Hash] params ({})
|
2631
|
+
def describe_account_customization(params = {}, options = {})
|
2632
|
+
req = build_request(:describe_account_customization, params)
|
2633
|
+
req.send_request(options)
|
2634
|
+
end
|
2635
|
+
|
2636
|
+
# Describes the settings that were used when your QuickSight
|
2637
|
+
# subscription was first created in this AWS Account.
|
2638
|
+
#
|
2639
|
+
# @option params [required, String] :aws_account_id
|
2640
|
+
# The ID for the AWS account that contains the settings that you want to
|
2641
|
+
# list.
|
2642
|
+
#
|
2643
|
+
# @return [Types::DescribeAccountSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2644
|
+
#
|
2645
|
+
# * {Types::DescribeAccountSettingsResponse#account_settings #account_settings} => Types::AccountSettings
|
2646
|
+
# * {Types::DescribeAccountSettingsResponse#request_id #request_id} => String
|
2647
|
+
# * {Types::DescribeAccountSettingsResponse#status #status} => Integer
|
2648
|
+
#
|
2649
|
+
# @example Request syntax with placeholder values
|
2650
|
+
#
|
2651
|
+
# resp = client.describe_account_settings({
|
2652
|
+
# aws_account_id: "AwsAccountId", # required
|
2653
|
+
# })
|
2654
|
+
#
|
2655
|
+
# @example Response structure
|
2656
|
+
#
|
2657
|
+
# resp.account_settings.account_name #=> String
|
2658
|
+
# resp.account_settings.edition #=> String, one of "STANDARD", "ENTERPRISE"
|
2659
|
+
# resp.account_settings.default_namespace #=> String
|
2660
|
+
# resp.account_settings.notification_email #=> String
|
2661
|
+
# resp.request_id #=> String
|
2662
|
+
# resp.status #=> Integer
|
2663
|
+
#
|
2664
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountSettings AWS API Documentation
|
2665
|
+
#
|
2666
|
+
# @overload describe_account_settings(params = {})
|
2667
|
+
# @param [Hash] params ({})
|
2668
|
+
def describe_account_settings(params = {}, options = {})
|
2669
|
+
req = build_request(:describe_account_settings, params)
|
2670
|
+
req.send_request(options)
|
2671
|
+
end
|
2672
|
+
|
2673
|
+
# Provides a summary of the metadata for an analysis.
|
2674
|
+
#
|
2675
|
+
# @option params [required, String] :aws_account_id
|
2676
|
+
# The ID of the AWS account that contains the analysis. You must be
|
2677
|
+
# using the AWS account that the analysis is in.
|
2678
|
+
#
|
2679
|
+
# @option params [required, String] :analysis_id
|
2680
|
+
# The ID of the analysis that you're describing. The ID is part of the
|
2681
|
+
# URL of the analysis.
|
2682
|
+
#
|
2683
|
+
# @return [Types::DescribeAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2684
|
+
#
|
2685
|
+
# * {Types::DescribeAnalysisResponse#analysis #analysis} => Types::Analysis
|
2686
|
+
# * {Types::DescribeAnalysisResponse#status #status} => Integer
|
2687
|
+
# * {Types::DescribeAnalysisResponse#request_id #request_id} => String
|
2688
|
+
#
|
2689
|
+
# @example Request syntax with placeholder values
|
2690
|
+
#
|
2691
|
+
# resp = client.describe_analysis({
|
2692
|
+
# aws_account_id: "AwsAccountId", # required
|
2693
|
+
# analysis_id: "RestrictiveResourceId", # required
|
2694
|
+
# })
|
2695
|
+
#
|
2696
|
+
# @example Response structure
|
2697
|
+
#
|
2698
|
+
# resp.analysis.analysis_id #=> String
|
2699
|
+
# resp.analysis.arn #=> String
|
2700
|
+
# resp.analysis.name #=> String
|
2701
|
+
# resp.analysis.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
2702
|
+
# resp.analysis.errors #=> Array
|
2703
|
+
# 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"
|
2704
|
+
# resp.analysis.errors[0].message #=> String
|
2705
|
+
# resp.analysis.data_set_arns #=> Array
|
2706
|
+
# resp.analysis.data_set_arns[0] #=> String
|
2707
|
+
# resp.analysis.theme_arn #=> String
|
2708
|
+
# resp.analysis.created_time #=> Time
|
2709
|
+
# resp.analysis.last_updated_time #=> Time
|
2710
|
+
# resp.status #=> Integer
|
2711
|
+
# resp.request_id #=> String
|
2712
|
+
#
|
2713
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysis AWS API Documentation
|
2714
|
+
#
|
2715
|
+
# @overload describe_analysis(params = {})
|
2716
|
+
# @param [Hash] params ({})
|
2717
|
+
def describe_analysis(params = {}, options = {})
|
2718
|
+
req = build_request(:describe_analysis, params)
|
2719
|
+
req.send_request(options)
|
2720
|
+
end
|
2721
|
+
|
2722
|
+
# Provides the read and write permissions for an analysis.
|
2723
|
+
#
|
2724
|
+
# @option params [required, String] :aws_account_id
|
2725
|
+
# The ID of the AWS account that contains the analysis whose permissions
|
2726
|
+
# you're describing. You must be using the AWS account that the
|
2727
|
+
# analysis is in.
|
2728
|
+
#
|
2729
|
+
# @option params [required, String] :analysis_id
|
2730
|
+
# The ID of the analysis whose permissions you're describing. The ID is
|
2731
|
+
# part of the analysis URL.
|
2732
|
+
#
|
2733
|
+
# @return [Types::DescribeAnalysisPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2734
|
+
#
|
2735
|
+
# * {Types::DescribeAnalysisPermissionsResponse#analysis_id #analysis_id} => String
|
2736
|
+
# * {Types::DescribeAnalysisPermissionsResponse#analysis_arn #analysis_arn} => String
|
2737
|
+
# * {Types::DescribeAnalysisPermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission>
|
2738
|
+
# * {Types::DescribeAnalysisPermissionsResponse#status #status} => Integer
|
2739
|
+
# * {Types::DescribeAnalysisPermissionsResponse#request_id #request_id} => String
|
2740
|
+
#
|
2741
|
+
# @example Request syntax with placeholder values
|
2742
|
+
#
|
2743
|
+
# resp = client.describe_analysis_permissions({
|
2744
|
+
# aws_account_id: "AwsAccountId", # required
|
2745
|
+
# analysis_id: "RestrictiveResourceId", # required
|
2746
|
+
# })
|
2747
|
+
#
|
2748
|
+
# @example Response structure
|
2749
|
+
#
|
2750
|
+
# resp.analysis_id #=> String
|
2751
|
+
# resp.analysis_arn #=> String
|
2752
|
+
# resp.permissions #=> Array
|
2753
|
+
# resp.permissions[0].principal #=> String
|
2754
|
+
# resp.permissions[0].actions #=> Array
|
2755
|
+
# resp.permissions[0].actions[0] #=> String
|
2756
|
+
# resp.status #=> Integer
|
2757
|
+
# resp.request_id #=> String
|
2758
|
+
#
|
2759
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysisPermissions AWS API Documentation
|
2760
|
+
#
|
2761
|
+
# @overload describe_analysis_permissions(params = {})
|
2762
|
+
# @param [Hash] params ({})
|
2763
|
+
def describe_analysis_permissions(params = {}, options = {})
|
2764
|
+
req = build_request(:describe_analysis_permissions, params)
|
2765
|
+
req.send_request(options)
|
2766
|
+
end
|
2767
|
+
|
1811
2768
|
# Provides a summary for a dashboard.
|
1812
2769
|
#
|
1813
2770
|
# @option params [required, String] :aws_account_id
|
@@ -1849,12 +2806,13 @@ module Aws::QuickSight
|
|
1849
2806
|
# 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"
|
1850
2807
|
# resp.dashboard.version.errors[0].message #=> String
|
1851
2808
|
# resp.dashboard.version.version_number #=> Integer
|
1852
|
-
# resp.dashboard.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
2809
|
+
# resp.dashboard.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
1853
2810
|
# resp.dashboard.version.arn #=> String
|
1854
2811
|
# resp.dashboard.version.source_entity_arn #=> String
|
1855
2812
|
# resp.dashboard.version.data_set_arns #=> Array
|
1856
2813
|
# resp.dashboard.version.data_set_arns[0] #=> String
|
1857
2814
|
# resp.dashboard.version.description #=> String
|
2815
|
+
# resp.dashboard.version.theme_arn #=> String
|
1858
2816
|
# resp.dashboard.created_time #=> Time
|
1859
2817
|
# resp.dashboard.last_published_time #=> Time
|
1860
2818
|
# resp.dashboard.last_updated_time #=> Time
|
@@ -1998,6 +2956,7 @@ module Aws::QuickSight
|
|
1998
2956
|
# resp.data_set.column_groups[0].geo_spatial_column_group.country_code #=> String, one of "US"
|
1999
2957
|
# resp.data_set.column_groups[0].geo_spatial_column_group.columns #=> Array
|
2000
2958
|
# resp.data_set.column_groups[0].geo_spatial_column_group.columns[0] #=> String
|
2959
|
+
# resp.data_set.row_level_permission_data_set.namespace #=> String
|
2001
2960
|
# resp.data_set.row_level_permission_data_set.arn #=> String
|
2002
2961
|
# resp.data_set.row_level_permission_data_set.permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS"
|
2003
2962
|
# resp.request_id #=> String
|
@@ -2087,7 +3046,7 @@ module Aws::QuickSight
|
|
2087
3046
|
# resp.data_source.data_source_id #=> String
|
2088
3047
|
# resp.data_source.name #=> String
|
2089
3048
|
# 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"
|
2090
|
-
# resp.data_source.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
3049
|
+
# resp.data_source.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
2091
3050
|
# resp.data_source.created_time #=> Time
|
2092
3051
|
# resp.data_source.last_updated_time #=> Time
|
2093
3052
|
# resp.data_source.data_source_parameters.amazon_elasticsearch_parameters.domain #=> String
|
@@ -2387,6 +3346,49 @@ module Aws::QuickSight
|
|
2387
3346
|
req.send_request(options)
|
2388
3347
|
end
|
2389
3348
|
|
3349
|
+
# Describes the current namespace.
|
3350
|
+
#
|
3351
|
+
# @option params [required, String] :aws_account_id
|
3352
|
+
# The ID for the AWS account that contains the QuickSight namespace that
|
3353
|
+
# you want to describe.
|
3354
|
+
#
|
3355
|
+
# @option params [required, String] :namespace
|
3356
|
+
# The namespace that you want to describe.
|
3357
|
+
#
|
3358
|
+
# @return [Types::DescribeNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3359
|
+
#
|
3360
|
+
# * {Types::DescribeNamespaceResponse#namespace #namespace} => Types::NamespaceInfoV2
|
3361
|
+
# * {Types::DescribeNamespaceResponse#request_id #request_id} => String
|
3362
|
+
# * {Types::DescribeNamespaceResponse#status #status} => Integer
|
3363
|
+
#
|
3364
|
+
# @example Request syntax with placeholder values
|
3365
|
+
#
|
3366
|
+
# resp = client.describe_namespace({
|
3367
|
+
# aws_account_id: "AwsAccountId", # required
|
3368
|
+
# namespace: "Namespace", # required
|
3369
|
+
# })
|
3370
|
+
#
|
3371
|
+
# @example Response structure
|
3372
|
+
#
|
3373
|
+
# resp.namespace.name #=> String
|
3374
|
+
# resp.namespace.arn #=> String
|
3375
|
+
# resp.namespace.capacity_region #=> String
|
3376
|
+
# resp.namespace.creation_status #=> String, one of "CREATED", "CREATING", "DELETING", "RETRYABLE_FAILURE", "NON_RETRYABLE_FAILURE"
|
3377
|
+
# resp.namespace.identity_store #=> String, one of "QUICKSIGHT"
|
3378
|
+
# resp.namespace.namespace_error.type #=> String, one of "PERMISSION_DENIED", "INTERNAL_SERVICE_ERROR"
|
3379
|
+
# resp.namespace.namespace_error.message #=> String
|
3380
|
+
# resp.request_id #=> String
|
3381
|
+
# resp.status #=> Integer
|
3382
|
+
#
|
3383
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeNamespace AWS API Documentation
|
3384
|
+
#
|
3385
|
+
# @overload describe_namespace(params = {})
|
3386
|
+
# @param [Hash] params ({})
|
3387
|
+
def describe_namespace(params = {}, options = {})
|
3388
|
+
req = build_request(:describe_namespace, params)
|
3389
|
+
req.send_request(options)
|
3390
|
+
end
|
3391
|
+
|
2390
3392
|
# Describes a template's metadata.
|
2391
3393
|
#
|
2392
3394
|
# @option params [required, String] :aws_account_id
|
@@ -2412,6 +3414,7 @@ module Aws::QuickSight
|
|
2412
3414
|
#
|
2413
3415
|
# * {Types::DescribeTemplateResponse#template #template} => Types::Template
|
2414
3416
|
# * {Types::DescribeTemplateResponse#status #status} => Integer
|
3417
|
+
# * {Types::DescribeTemplateResponse#request_id #request_id} => String
|
2415
3418
|
#
|
2416
3419
|
# @example Request syntax with placeholder values
|
2417
3420
|
#
|
@@ -2428,10 +3431,10 @@ module Aws::QuickSight
|
|
2428
3431
|
# resp.template.name #=> String
|
2429
3432
|
# resp.template.version.created_time #=> Time
|
2430
3433
|
# resp.template.version.errors #=> Array
|
2431
|
-
# resp.template.version.errors[0].type #=> String, one of "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE"
|
3434
|
+
# resp.template.version.errors[0].type #=> String, one of "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE", "ACCESS_DENIED"
|
2432
3435
|
# resp.template.version.errors[0].message #=> String
|
2433
3436
|
# resp.template.version.version_number #=> Integer
|
2434
|
-
# resp.template.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
3437
|
+
# resp.template.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
2435
3438
|
# resp.template.version.data_set_configurations #=> Array
|
2436
3439
|
# resp.template.version.data_set_configurations[0].placeholder #=> String
|
2437
3440
|
# resp.template.version.data_set_configurations[0].data_set_schema.column_schema_list #=> Array
|
@@ -2444,10 +3447,12 @@ module Aws::QuickSight
|
|
2444
3447
|
# resp.template.version.data_set_configurations[0].column_group_schema_list[0].column_group_column_schema_list[0].name #=> String
|
2445
3448
|
# resp.template.version.description #=> String
|
2446
3449
|
# resp.template.version.source_entity_arn #=> String
|
3450
|
+
# resp.template.version.theme_arn #=> String
|
2447
3451
|
# resp.template.template_id #=> String
|
2448
3452
|
# resp.template.last_updated_time #=> Time
|
2449
3453
|
# resp.template.created_time #=> Time
|
2450
3454
|
# resp.status #=> Integer
|
3455
|
+
# resp.request_id #=> String
|
2451
3456
|
#
|
2452
3457
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTemplate AWS API Documentation
|
2453
3458
|
#
|
@@ -2549,6 +3554,182 @@ module Aws::QuickSight
|
|
2549
3554
|
req.send_request(options)
|
2550
3555
|
end
|
2551
3556
|
|
3557
|
+
# Describes a theme.
|
3558
|
+
#
|
3559
|
+
# @option params [required, String] :aws_account_id
|
3560
|
+
# The ID of the AWS account that contains the theme that you're
|
3561
|
+
# describing.
|
3562
|
+
#
|
3563
|
+
# @option params [required, String] :theme_id
|
3564
|
+
# The ID for the theme.
|
3565
|
+
#
|
3566
|
+
# @option params [Integer] :version_number
|
3567
|
+
# The version number for the version to describe. If a `VersionNumber`
|
3568
|
+
# parameter value isn't provided, the latest version of the theme is
|
3569
|
+
# described.
|
3570
|
+
#
|
3571
|
+
# @option params [String] :alias_name
|
3572
|
+
# The alias of the theme that you want to describe. If you name a
|
3573
|
+
# specific alias, you describe the version that the alias points to. You
|
3574
|
+
# can specify the latest version of the theme by providing the keyword
|
3575
|
+
# `$LATEST` in the `AliasName` parameter. The keyword `$PUBLISHED`
|
3576
|
+
# doesn't apply to themes.
|
3577
|
+
#
|
3578
|
+
# @return [Types::DescribeThemeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3579
|
+
#
|
3580
|
+
# * {Types::DescribeThemeResponse#theme #theme} => Types::Theme
|
3581
|
+
# * {Types::DescribeThemeResponse#status #status} => Integer
|
3582
|
+
# * {Types::DescribeThemeResponse#request_id #request_id} => String
|
3583
|
+
#
|
3584
|
+
# @example Request syntax with placeholder values
|
3585
|
+
#
|
3586
|
+
# resp = client.describe_theme({
|
3587
|
+
# aws_account_id: "AwsAndAccountId", # required
|
3588
|
+
# theme_id: "RestrictiveResourceId", # required
|
3589
|
+
# version_number: 1,
|
3590
|
+
# alias_name: "AliasName",
|
3591
|
+
# })
|
3592
|
+
#
|
3593
|
+
# @example Response structure
|
3594
|
+
#
|
3595
|
+
# resp.theme.arn #=> String
|
3596
|
+
# resp.theme.name #=> String
|
3597
|
+
# resp.theme.theme_id #=> String
|
3598
|
+
# resp.theme.version.version_number #=> Integer
|
3599
|
+
# resp.theme.version.arn #=> String
|
3600
|
+
# resp.theme.version.description #=> String
|
3601
|
+
# resp.theme.version.base_theme_id #=> String
|
3602
|
+
# resp.theme.version.created_time #=> Time
|
3603
|
+
# resp.theme.version.configuration.data_color_palette.colors #=> Array
|
3604
|
+
# resp.theme.version.configuration.data_color_palette.colors[0] #=> String
|
3605
|
+
# resp.theme.version.configuration.data_color_palette.min_max_gradient #=> Array
|
3606
|
+
# resp.theme.version.configuration.data_color_palette.min_max_gradient[0] #=> String
|
3607
|
+
# resp.theme.version.configuration.data_color_palette.empty_fill_color #=> String
|
3608
|
+
# resp.theme.version.configuration.ui_color_palette.primary_foreground #=> String
|
3609
|
+
# resp.theme.version.configuration.ui_color_palette.primary_background #=> String
|
3610
|
+
# resp.theme.version.configuration.ui_color_palette.secondary_foreground #=> String
|
3611
|
+
# resp.theme.version.configuration.ui_color_palette.secondary_background #=> String
|
3612
|
+
# resp.theme.version.configuration.ui_color_palette.accent #=> String
|
3613
|
+
# resp.theme.version.configuration.ui_color_palette.accent_foreground #=> String
|
3614
|
+
# resp.theme.version.configuration.ui_color_palette.danger #=> String
|
3615
|
+
# resp.theme.version.configuration.ui_color_palette.danger_foreground #=> String
|
3616
|
+
# resp.theme.version.configuration.ui_color_palette.warning #=> String
|
3617
|
+
# resp.theme.version.configuration.ui_color_palette.warning_foreground #=> String
|
3618
|
+
# resp.theme.version.configuration.ui_color_palette.success #=> String
|
3619
|
+
# resp.theme.version.configuration.ui_color_palette.success_foreground #=> String
|
3620
|
+
# resp.theme.version.configuration.ui_color_palette.dimension #=> String
|
3621
|
+
# resp.theme.version.configuration.ui_color_palette.dimension_foreground #=> String
|
3622
|
+
# resp.theme.version.configuration.ui_color_palette.measure #=> String
|
3623
|
+
# resp.theme.version.configuration.ui_color_palette.measure_foreground #=> String
|
3624
|
+
# resp.theme.version.configuration.sheet.tile.border.show #=> Boolean
|
3625
|
+
# resp.theme.version.configuration.sheet.tile_layout.gutter.show #=> Boolean
|
3626
|
+
# resp.theme.version.configuration.sheet.tile_layout.margin.show #=> Boolean
|
3627
|
+
# resp.theme.version.errors #=> Array
|
3628
|
+
# resp.theme.version.errors[0].type #=> String, one of "INTERNAL_FAILURE"
|
3629
|
+
# resp.theme.version.errors[0].message #=> String
|
3630
|
+
# resp.theme.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
3631
|
+
# resp.theme.created_time #=> Time
|
3632
|
+
# resp.theme.last_updated_time #=> Time
|
3633
|
+
# resp.theme.type #=> String, one of "QUICKSIGHT", "CUSTOM", "ALL"
|
3634
|
+
# resp.status #=> Integer
|
3635
|
+
# resp.request_id #=> String
|
3636
|
+
#
|
3637
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTheme AWS API Documentation
|
3638
|
+
#
|
3639
|
+
# @overload describe_theme(params = {})
|
3640
|
+
# @param [Hash] params ({})
|
3641
|
+
def describe_theme(params = {}, options = {})
|
3642
|
+
req = build_request(:describe_theme, params)
|
3643
|
+
req.send_request(options)
|
3644
|
+
end
|
3645
|
+
|
3646
|
+
# Describes the alias for a theme.
|
3647
|
+
#
|
3648
|
+
# @option params [required, String] :aws_account_id
|
3649
|
+
# The ID of the AWS account that contains the theme alias that you're
|
3650
|
+
# describing.
|
3651
|
+
#
|
3652
|
+
# @option params [required, String] :theme_id
|
3653
|
+
# The ID for the theme.
|
3654
|
+
#
|
3655
|
+
# @option params [required, String] :alias_name
|
3656
|
+
# The name of the theme alias that you want to describe.
|
3657
|
+
#
|
3658
|
+
# @return [Types::DescribeThemeAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3659
|
+
#
|
3660
|
+
# * {Types::DescribeThemeAliasResponse#theme_alias #theme_alias} => Types::ThemeAlias
|
3661
|
+
# * {Types::DescribeThemeAliasResponse#status #status} => Integer
|
3662
|
+
# * {Types::DescribeThemeAliasResponse#request_id #request_id} => String
|
3663
|
+
#
|
3664
|
+
# @example Request syntax with placeholder values
|
3665
|
+
#
|
3666
|
+
# resp = client.describe_theme_alias({
|
3667
|
+
# aws_account_id: "AwsAccountId", # required
|
3668
|
+
# theme_id: "RestrictiveResourceId", # required
|
3669
|
+
# alias_name: "AliasName", # required
|
3670
|
+
# })
|
3671
|
+
#
|
3672
|
+
# @example Response structure
|
3673
|
+
#
|
3674
|
+
# resp.theme_alias.arn #=> String
|
3675
|
+
# resp.theme_alias.alias_name #=> String
|
3676
|
+
# resp.theme_alias.theme_version_number #=> Integer
|
3677
|
+
# resp.status #=> Integer
|
3678
|
+
# resp.request_id #=> String
|
3679
|
+
#
|
3680
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeThemeAlias AWS API Documentation
|
3681
|
+
#
|
3682
|
+
# @overload describe_theme_alias(params = {})
|
3683
|
+
# @param [Hash] params ({})
|
3684
|
+
def describe_theme_alias(params = {}, options = {})
|
3685
|
+
req = build_request(:describe_theme_alias, params)
|
3686
|
+
req.send_request(options)
|
3687
|
+
end
|
3688
|
+
|
3689
|
+
# Describes the read and write permissions for a theme.
|
3690
|
+
#
|
3691
|
+
# @option params [required, String] :aws_account_id
|
3692
|
+
# The ID of the AWS account that contains the theme that you're
|
3693
|
+
# describing.
|
3694
|
+
#
|
3695
|
+
# @option params [required, String] :theme_id
|
3696
|
+
# The ID for the theme that you want to describe permissions for.
|
3697
|
+
#
|
3698
|
+
# @return [Types::DescribeThemePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3699
|
+
#
|
3700
|
+
# * {Types::DescribeThemePermissionsResponse#theme_id #theme_id} => String
|
3701
|
+
# * {Types::DescribeThemePermissionsResponse#theme_arn #theme_arn} => String
|
3702
|
+
# * {Types::DescribeThemePermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission>
|
3703
|
+
# * {Types::DescribeThemePermissionsResponse#request_id #request_id} => String
|
3704
|
+
# * {Types::DescribeThemePermissionsResponse#status #status} => Integer
|
3705
|
+
#
|
3706
|
+
# @example Request syntax with placeholder values
|
3707
|
+
#
|
3708
|
+
# resp = client.describe_theme_permissions({
|
3709
|
+
# aws_account_id: "AwsAccountId", # required
|
3710
|
+
# theme_id: "RestrictiveResourceId", # required
|
3711
|
+
# })
|
3712
|
+
#
|
3713
|
+
# @example Response structure
|
3714
|
+
#
|
3715
|
+
# resp.theme_id #=> String
|
3716
|
+
# resp.theme_arn #=> String
|
3717
|
+
# resp.permissions #=> Array
|
3718
|
+
# resp.permissions[0].principal #=> String
|
3719
|
+
# resp.permissions[0].actions #=> Array
|
3720
|
+
# resp.permissions[0].actions[0] #=> String
|
3721
|
+
# resp.request_id #=> String
|
3722
|
+
# resp.status #=> Integer
|
3723
|
+
#
|
3724
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeThemePermissions AWS API Documentation
|
3725
|
+
#
|
3726
|
+
# @overload describe_theme_permissions(params = {})
|
3727
|
+
# @param [Hash] params ({})
|
3728
|
+
def describe_theme_permissions(params = {}, options = {})
|
3729
|
+
req = build_request(:describe_theme_permissions, params)
|
3730
|
+
req.send_request(options)
|
3731
|
+
end
|
3732
|
+
|
2552
3733
|
# Returns information about a user, given the user name.
|
2553
3734
|
#
|
2554
3735
|
# @option params [required, String] :user_name
|
@@ -2584,6 +3765,7 @@ module Aws::QuickSight
|
|
2584
3765
|
# resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
|
2585
3766
|
# resp.user.active #=> Boolean
|
2586
3767
|
# resp.user.principal_id #=> String
|
3768
|
+
# resp.user.custom_permissions_name #=> String
|
2587
3769
|
# resp.request_id #=> String
|
2588
3770
|
# resp.status #=> Integer
|
2589
3771
|
#
|
@@ -2596,9 +3778,10 @@ module Aws::QuickSight
|
|
2596
3778
|
req.send_request(options)
|
2597
3779
|
end
|
2598
3780
|
|
2599
|
-
# Generates a URL and authorization code that you can
|
2600
|
-
#
|
2601
|
-
#
|
3781
|
+
# Generates a session URL and authorization code that you can use to
|
3782
|
+
# embed an Amazon QuickSight read-only dashboard in your web server
|
3783
|
+
# code. Before you use this command, make sure that you have configured
|
3784
|
+
# the dashboards and permissions.
|
2602
3785
|
#
|
2603
3786
|
# Currently, you can use `GetDashboardEmbedURL` only from the server,
|
2604
3787
|
# not from the user's browser. The following rules apply to the
|
@@ -2612,66 +3795,161 @@ module Aws::QuickSight
|
|
2612
3795
|
#
|
2613
3796
|
# * The resulting user session is valid for 10 hours.
|
2614
3797
|
#
|
2615
|
-
# For more information, see [Embedding Amazon QuickSight
|
2616
|
-
#
|
2617
|
-
#
|
3798
|
+
# For more information, see [Embedding Amazon QuickSight][1] in the
|
3799
|
+
# *Amazon QuickSight User Guide* .
|
3800
|
+
#
|
3801
|
+
#
|
3802
|
+
#
|
3803
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedding-dashboards.html
|
3804
|
+
#
|
3805
|
+
# @option params [required, String] :aws_account_id
|
3806
|
+
# The ID for the AWS account that contains the dashboard that you're
|
3807
|
+
# embedding.
|
3808
|
+
#
|
3809
|
+
# @option params [required, String] :dashboard_id
|
3810
|
+
# The ID for the dashboard, also added to the IAM policy.
|
3811
|
+
#
|
3812
|
+
# @option params [required, String] :identity_type
|
3813
|
+
# The authentication method that the user uses to sign in.
|
3814
|
+
#
|
3815
|
+
# @option params [Integer] :session_lifetime_in_minutes
|
3816
|
+
# How many minutes the session is valid. The session lifetime must be
|
3817
|
+
# 15-600 minutes.
|
3818
|
+
#
|
3819
|
+
# @option params [Boolean] :undo_redo_disabled
|
3820
|
+
# Remove the undo/redo button on the embedded dashboard. The default is
|
3821
|
+
# FALSE, which enables the undo/redo button.
|
3822
|
+
#
|
3823
|
+
# @option params [Boolean] :reset_disabled
|
3824
|
+
# Remove the reset button on the embedded dashboard. The default is
|
3825
|
+
# FALSE, which enables the reset button.
|
3826
|
+
#
|
3827
|
+
# @option params [String] :user_arn
|
3828
|
+
# The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
|
3829
|
+
# `QUICKSIGHT` identity type. You can use this for any Amazon QuickSight
|
3830
|
+
# users in your account (readers, authors, or admins) authenticated as
|
3831
|
+
# one of the following:
|
3832
|
+
#
|
3833
|
+
# * Active Directory (AD) users or group members
|
3834
|
+
#
|
3835
|
+
# * Invited nonfederated users
|
3836
|
+
#
|
3837
|
+
# * IAM users and IAM role-based sessions authenticated through
|
3838
|
+
# Federated Single Sign-On using SAML, OpenID Connect, or IAM
|
3839
|
+
# federation.
|
3840
|
+
#
|
3841
|
+
# Omit this parameter for users in the third group – IAM users and IAM
|
3842
|
+
# role-based sessions.
|
3843
|
+
#
|
3844
|
+
# @return [Types::GetDashboardEmbedUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3845
|
+
#
|
3846
|
+
# * {Types::GetDashboardEmbedUrlResponse#embed_url #embed_url} => String
|
3847
|
+
# * {Types::GetDashboardEmbedUrlResponse#status #status} => Integer
|
3848
|
+
# * {Types::GetDashboardEmbedUrlResponse#request_id #request_id} => String
|
3849
|
+
#
|
3850
|
+
# @example Request syntax with placeholder values
|
3851
|
+
#
|
3852
|
+
# resp = client.get_dashboard_embed_url({
|
3853
|
+
# aws_account_id: "AwsAccountId", # required
|
3854
|
+
# dashboard_id: "RestrictiveResourceId", # required
|
3855
|
+
# identity_type: "IAM", # required, accepts IAM, QUICKSIGHT
|
3856
|
+
# session_lifetime_in_minutes: 1,
|
3857
|
+
# undo_redo_disabled: false,
|
3858
|
+
# reset_disabled: false,
|
3859
|
+
# user_arn: "Arn",
|
3860
|
+
# })
|
3861
|
+
#
|
3862
|
+
# @example Response structure
|
3863
|
+
#
|
3864
|
+
# resp.embed_url #=> String
|
3865
|
+
# resp.status #=> Integer
|
3866
|
+
# resp.request_id #=> String
|
3867
|
+
#
|
3868
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetDashboardEmbedUrl AWS API Documentation
|
3869
|
+
#
|
3870
|
+
# @overload get_dashboard_embed_url(params = {})
|
3871
|
+
# @param [Hash] params ({})
|
3872
|
+
def get_dashboard_embed_url(params = {}, options = {})
|
3873
|
+
req = build_request(:get_dashboard_embed_url, params)
|
3874
|
+
req.send_request(options)
|
3875
|
+
end
|
3876
|
+
|
3877
|
+
# Generates a session URL and authorization code that you can use to
|
3878
|
+
# embed the Amazon QuickSight console in your web server code. Use
|
3879
|
+
# `GetSessionEmbedUrl` where you want to provide an authoring portal
|
3880
|
+
# that allows users to create data sources, datasets, analyses, and
|
3881
|
+
# dashboards. The users who access an embedded QuickSight console need
|
3882
|
+
# belong to the author or admin security cohort. If you want to restrict
|
3883
|
+
# permissions to some of these features, add a custom permissions
|
3884
|
+
# profile to the user with the ` UpdateUser ` API operation. Use `
|
3885
|
+
# RegisterUser ` API operation to add a new user with a custom
|
3886
|
+
# permission profile attached. For more information, see the following
|
3887
|
+
# sections in the *Amazon QuickSight User Guide*\:
|
3888
|
+
#
|
3889
|
+
# * [Embedding the Amazon QuickSight Console][1]
|
3890
|
+
#
|
3891
|
+
# * [Customizing Access to the Amazon QuickSight Console][2]
|
3892
|
+
#
|
3893
|
+
#
|
3894
|
+
#
|
3895
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedding-the-quicksight-console.html
|
3896
|
+
# [2]: https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html
|
3897
|
+
#
|
3898
|
+
# @option params [required, String] :aws_account_id
|
3899
|
+
# The ID for the AWS account associated with your QuickSight
|
3900
|
+
# subscription.
|
3901
|
+
#
|
3902
|
+
# @option params [String] :entry_point
|
3903
|
+
# The URL you use to access the embedded session. The entry point URL is
|
3904
|
+
# constrained to the following paths:
|
2618
3905
|
#
|
3906
|
+
# * `/start`
|
2619
3907
|
#
|
3908
|
+
# * `/start/analyses`
|
2620
3909
|
#
|
2621
|
-
#
|
2622
|
-
# [2]: https://docs.aws.amazon.com/quicksight/latest/APIReference/qs-dev-embedded-dashboards.html
|
3910
|
+
# * `/start/dashboards`
|
2623
3911
|
#
|
2624
|
-
#
|
2625
|
-
# The ID for the AWS account that contains the dashboard that you're
|
2626
|
-
# embedding.
|
3912
|
+
# * `/start/favorites`
|
2627
3913
|
#
|
2628
|
-
#
|
2629
|
-
#
|
3914
|
+
# * `/dashboards/DashboardId ` - where `DashboardId` is the actual ID
|
3915
|
+
# key from the QuickSight console URL of the dashboard
|
2630
3916
|
#
|
2631
|
-
#
|
2632
|
-
#
|
3917
|
+
# * `/analyses/AnalysisId ` - where `AnalysisId` is the actual ID key
|
3918
|
+
# from the QuickSight console URL of the analysis
|
2633
3919
|
#
|
2634
3920
|
# @option params [Integer] :session_lifetime_in_minutes
|
2635
3921
|
# How many minutes the session is valid. The session lifetime must be
|
2636
3922
|
# 15-600 minutes.
|
2637
3923
|
#
|
2638
|
-
# @option params [Boolean] :undo_redo_disabled
|
2639
|
-
# Remove the undo/redo button on the embedded dashboard. The default is
|
2640
|
-
# FALSE, which enables the undo/redo button.
|
2641
|
-
#
|
2642
|
-
# @option params [Boolean] :reset_disabled
|
2643
|
-
# Remove the reset button on the embedded dashboard. The default is
|
2644
|
-
# FALSE, which enables the reset button.
|
2645
|
-
#
|
2646
3924
|
# @option params [String] :user_arn
|
2647
3925
|
# The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
|
2648
|
-
# `QUICKSIGHT` identity type. You can use this for any Amazon
|
2649
|
-
# users in your account (readers, authors, or admins)
|
2650
|
-
# one of the following:
|
3926
|
+
# `QUICKSIGHT` identity type. You can use this for any type of Amazon
|
3927
|
+
# QuickSight users in your account (readers, authors, or admins). They
|
3928
|
+
# need to be authenticated as one of the following:
|
2651
3929
|
#
|
2652
|
-
#
|
3930
|
+
# 1. Active Directory (AD) users or group members
|
2653
3931
|
#
|
2654
|
-
#
|
3932
|
+
# 2. Invited nonfederated users
|
2655
3933
|
#
|
2656
|
-
#
|
2657
|
-
#
|
2658
|
-
#
|
3934
|
+
# 3. IAM users and IAM role-based sessions authenticated through
|
3935
|
+
# Federated Single Sign-On using SAML, OpenID Connect, or IAM
|
3936
|
+
# federation
|
2659
3937
|
#
|
2660
|
-
#
|
3938
|
+
# Omit this parameter for users in the third group – IAM users and IAM
|
3939
|
+
# role-based sessions.
|
2661
3940
|
#
|
2662
|
-
#
|
2663
|
-
#
|
2664
|
-
# * {Types::
|
3941
|
+
# @return [Types::GetSessionEmbedUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3942
|
+
#
|
3943
|
+
# * {Types::GetSessionEmbedUrlResponse#embed_url #embed_url} => String
|
3944
|
+
# * {Types::GetSessionEmbedUrlResponse#status #status} => Integer
|
3945
|
+
# * {Types::GetSessionEmbedUrlResponse#request_id #request_id} => String
|
2665
3946
|
#
|
2666
3947
|
# @example Request syntax with placeholder values
|
2667
3948
|
#
|
2668
|
-
# resp = client.
|
3949
|
+
# resp = client.get_session_embed_url({
|
2669
3950
|
# aws_account_id: "AwsAccountId", # required
|
2670
|
-
#
|
2671
|
-
# identity_type: "IAM", # required, accepts IAM, QUICKSIGHT
|
3951
|
+
# entry_point: "EntryPoint",
|
2672
3952
|
# session_lifetime_in_minutes: 1,
|
2673
|
-
# undo_redo_disabled: false,
|
2674
|
-
# reset_disabled: false,
|
2675
3953
|
# user_arn: "Arn",
|
2676
3954
|
# })
|
2677
3955
|
#
|
@@ -2681,12 +3959,63 @@ module Aws::QuickSight
|
|
2681
3959
|
# resp.status #=> Integer
|
2682
3960
|
# resp.request_id #=> String
|
2683
3961
|
#
|
2684
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
3962
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetSessionEmbedUrl AWS API Documentation
|
2685
3963
|
#
|
2686
|
-
# @overload
|
3964
|
+
# @overload get_session_embed_url(params = {})
|
2687
3965
|
# @param [Hash] params ({})
|
2688
|
-
def
|
2689
|
-
req = build_request(:
|
3966
|
+
def get_session_embed_url(params = {}, options = {})
|
3967
|
+
req = build_request(:get_session_embed_url, params)
|
3968
|
+
req.send_request(options)
|
3969
|
+
end
|
3970
|
+
|
3971
|
+
# Lists Amazon QuickSight analyses that exist in the specified AWS
|
3972
|
+
# account.
|
3973
|
+
#
|
3974
|
+
# @option params [required, String] :aws_account_id
|
3975
|
+
# The ID of the AWS account that contains the analyses.
|
3976
|
+
#
|
3977
|
+
# @option params [String] :next_token
|
3978
|
+
# A pagination token that can be used in a subsequent request.
|
3979
|
+
#
|
3980
|
+
# @option params [Integer] :max_results
|
3981
|
+
# The maximum number of results to return.
|
3982
|
+
#
|
3983
|
+
# @return [Types::ListAnalysesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3984
|
+
#
|
3985
|
+
# * {Types::ListAnalysesResponse#analysis_summary_list #analysis_summary_list} => Array<Types::AnalysisSummary>
|
3986
|
+
# * {Types::ListAnalysesResponse#next_token #next_token} => String
|
3987
|
+
# * {Types::ListAnalysesResponse#status #status} => Integer
|
3988
|
+
# * {Types::ListAnalysesResponse#request_id #request_id} => String
|
3989
|
+
#
|
3990
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3991
|
+
#
|
3992
|
+
# @example Request syntax with placeholder values
|
3993
|
+
#
|
3994
|
+
# resp = client.list_analyses({
|
3995
|
+
# aws_account_id: "AwsAccountId", # required
|
3996
|
+
# next_token: "String",
|
3997
|
+
# max_results: 1,
|
3998
|
+
# })
|
3999
|
+
#
|
4000
|
+
# @example Response structure
|
4001
|
+
#
|
4002
|
+
# resp.analysis_summary_list #=> Array
|
4003
|
+
# resp.analysis_summary_list[0].arn #=> String
|
4004
|
+
# resp.analysis_summary_list[0].analysis_id #=> String
|
4005
|
+
# resp.analysis_summary_list[0].name #=> String
|
4006
|
+
# resp.analysis_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
4007
|
+
# resp.analysis_summary_list[0].created_time #=> Time
|
4008
|
+
# resp.analysis_summary_list[0].last_updated_time #=> Time
|
4009
|
+
# resp.next_token #=> String
|
4010
|
+
# resp.status #=> Integer
|
4011
|
+
# resp.request_id #=> String
|
4012
|
+
#
|
4013
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListAnalyses AWS API Documentation
|
4014
|
+
#
|
4015
|
+
# @overload list_analyses(params = {})
|
4016
|
+
# @param [Hash] params ({})
|
4017
|
+
def list_analyses(params = {}, options = {})
|
4018
|
+
req = build_request(:list_analyses, params)
|
2690
4019
|
req.send_request(options)
|
2691
4020
|
end
|
2692
4021
|
|
@@ -2731,7 +4060,7 @@ module Aws::QuickSight
|
|
2731
4060
|
# resp.dashboard_version_summary_list[0].arn #=> String
|
2732
4061
|
# resp.dashboard_version_summary_list[0].created_time #=> Time
|
2733
4062
|
# resp.dashboard_version_summary_list[0].version_number #=> Integer
|
2734
|
-
# resp.dashboard_version_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
4063
|
+
# 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"
|
2735
4064
|
# resp.dashboard_version_summary_list[0].source_entity_arn #=> String
|
2736
4065
|
# resp.dashboard_version_summary_list[0].description #=> String
|
2737
4066
|
# resp.next_token #=> String
|
@@ -2842,6 +4171,7 @@ module Aws::QuickSight
|
|
2842
4171
|
# resp.data_set_summaries[0].created_time #=> Time
|
2843
4172
|
# resp.data_set_summaries[0].last_updated_time #=> Time
|
2844
4173
|
# resp.data_set_summaries[0].import_mode #=> String, one of "SPICE", "DIRECT_QUERY"
|
4174
|
+
# resp.data_set_summaries[0].row_level_permission_data_set.namespace #=> String
|
2845
4175
|
# resp.data_set_summaries[0].row_level_permission_data_set.arn #=> String
|
2846
4176
|
# resp.data_set_summaries[0].row_level_permission_data_set.permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS"
|
2847
4177
|
# resp.next_token #=> String
|
@@ -2894,7 +4224,7 @@ module Aws::QuickSight
|
|
2894
4224
|
# resp.data_sources[0].data_source_id #=> String
|
2895
4225
|
# resp.data_sources[0].name #=> String
|
2896
4226
|
# 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"
|
2897
|
-
# resp.data_sources[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
4227
|
+
# resp.data_sources[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
2898
4228
|
# resp.data_sources[0].created_time #=> Time
|
2899
4229
|
# resp.data_sources[0].last_updated_time #=> Time
|
2900
4230
|
# resp.data_sources[0].data_source_parameters.amazon_elasticsearch_parameters.domain #=> String
|
@@ -3280,6 +4610,58 @@ module Aws::QuickSight
|
|
3280
4610
|
req.send_request(options)
|
3281
4611
|
end
|
3282
4612
|
|
4613
|
+
# Lists the namespaces for the specified AWS account.
|
4614
|
+
#
|
4615
|
+
# @option params [required, String] :aws_account_id
|
4616
|
+
# The ID for the AWS account that contains the QuickSight namespaces
|
4617
|
+
# that you want to list.
|
4618
|
+
#
|
4619
|
+
# @option params [String] :next_token
|
4620
|
+
# A pagination token that can be used in a subsequent request.
|
4621
|
+
#
|
4622
|
+
# @option params [Integer] :max_results
|
4623
|
+
# The maximum number of results to return.
|
4624
|
+
#
|
4625
|
+
# @return [Types::ListNamespacesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4626
|
+
#
|
4627
|
+
# * {Types::ListNamespacesResponse#namespaces #namespaces} => Array<Types::NamespaceInfoV2>
|
4628
|
+
# * {Types::ListNamespacesResponse#next_token #next_token} => String
|
4629
|
+
# * {Types::ListNamespacesResponse#request_id #request_id} => String
|
4630
|
+
# * {Types::ListNamespacesResponse#status #status} => Integer
|
4631
|
+
#
|
4632
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4633
|
+
#
|
4634
|
+
# @example Request syntax with placeholder values
|
4635
|
+
#
|
4636
|
+
# resp = client.list_namespaces({
|
4637
|
+
# aws_account_id: "AwsAccountId", # required
|
4638
|
+
# next_token: "String",
|
4639
|
+
# max_results: 1,
|
4640
|
+
# })
|
4641
|
+
#
|
4642
|
+
# @example Response structure
|
4643
|
+
#
|
4644
|
+
# resp.namespaces #=> Array
|
4645
|
+
# resp.namespaces[0].name #=> String
|
4646
|
+
# resp.namespaces[0].arn #=> String
|
4647
|
+
# resp.namespaces[0].capacity_region #=> String
|
4648
|
+
# resp.namespaces[0].creation_status #=> String, one of "CREATED", "CREATING", "DELETING", "RETRYABLE_FAILURE", "NON_RETRYABLE_FAILURE"
|
4649
|
+
# resp.namespaces[0].identity_store #=> String, one of "QUICKSIGHT"
|
4650
|
+
# resp.namespaces[0].namespace_error.type #=> String, one of "PERMISSION_DENIED", "INTERNAL_SERVICE_ERROR"
|
4651
|
+
# resp.namespaces[0].namespace_error.message #=> String
|
4652
|
+
# resp.next_token #=> String
|
4653
|
+
# resp.request_id #=> String
|
4654
|
+
# resp.status #=> Integer
|
4655
|
+
#
|
4656
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListNamespaces AWS API Documentation
|
4657
|
+
#
|
4658
|
+
# @overload list_namespaces(params = {})
|
4659
|
+
# @param [Hash] params ({})
|
4660
|
+
def list_namespaces(params = {}, options = {})
|
4661
|
+
req = build_request(:list_namespaces, params)
|
4662
|
+
req.send_request(options)
|
4663
|
+
end
|
4664
|
+
|
3283
4665
|
# Lists the tags assigned to a resource.
|
3284
4666
|
#
|
3285
4667
|
# @option params [required, String] :resource_arn
|
@@ -3333,50 +4715,208 @@ module Aws::QuickSight
|
|
3333
4715
|
#
|
3334
4716
|
# @return [Types::ListTemplateAliasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3335
4717
|
#
|
3336
|
-
# * {Types::ListTemplateAliasesResponse#template_alias_list #template_alias_list} => Array<Types::TemplateAlias>
|
3337
|
-
# * {Types::ListTemplateAliasesResponse#status #status} => Integer
|
3338
|
-
# * {Types::ListTemplateAliasesResponse#request_id #request_id} => String
|
3339
|
-
# * {Types::ListTemplateAliasesResponse#next_token #next_token} => String
|
4718
|
+
# * {Types::ListTemplateAliasesResponse#template_alias_list #template_alias_list} => Array<Types::TemplateAlias>
|
4719
|
+
# * {Types::ListTemplateAliasesResponse#status #status} => Integer
|
4720
|
+
# * {Types::ListTemplateAliasesResponse#request_id #request_id} => String
|
4721
|
+
# * {Types::ListTemplateAliasesResponse#next_token #next_token} => String
|
4722
|
+
#
|
4723
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4724
|
+
#
|
4725
|
+
# @example Request syntax with placeholder values
|
4726
|
+
#
|
4727
|
+
# resp = client.list_template_aliases({
|
4728
|
+
# aws_account_id: "AwsAccountId", # required
|
4729
|
+
# template_id: "RestrictiveResourceId", # required
|
4730
|
+
# next_token: "String",
|
4731
|
+
# max_results: 1,
|
4732
|
+
# })
|
4733
|
+
#
|
4734
|
+
# @example Response structure
|
4735
|
+
#
|
4736
|
+
# resp.template_alias_list #=> Array
|
4737
|
+
# resp.template_alias_list[0].alias_name #=> String
|
4738
|
+
# resp.template_alias_list[0].arn #=> String
|
4739
|
+
# resp.template_alias_list[0].template_version_number #=> Integer
|
4740
|
+
# resp.status #=> Integer
|
4741
|
+
# resp.request_id #=> String
|
4742
|
+
# resp.next_token #=> String
|
4743
|
+
#
|
4744
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTemplateAliases AWS API Documentation
|
4745
|
+
#
|
4746
|
+
# @overload list_template_aliases(params = {})
|
4747
|
+
# @param [Hash] params ({})
|
4748
|
+
def list_template_aliases(params = {}, options = {})
|
4749
|
+
req = build_request(:list_template_aliases, params)
|
4750
|
+
req.send_request(options)
|
4751
|
+
end
|
4752
|
+
|
4753
|
+
# Lists all the versions of the templates in the current Amazon
|
4754
|
+
# QuickSight account.
|
4755
|
+
#
|
4756
|
+
# @option params [required, String] :aws_account_id
|
4757
|
+
# The ID of the AWS account that contains the templates that you're
|
4758
|
+
# listing.
|
4759
|
+
#
|
4760
|
+
# @option params [required, String] :template_id
|
4761
|
+
# The ID for the template.
|
4762
|
+
#
|
4763
|
+
# @option params [String] :next_token
|
4764
|
+
# The token for the next set of results, or null if there are no more
|
4765
|
+
# results.
|
4766
|
+
#
|
4767
|
+
# @option params [Integer] :max_results
|
4768
|
+
# The maximum number of results to be returned per request.
|
4769
|
+
#
|
4770
|
+
# @return [Types::ListTemplateVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4771
|
+
#
|
4772
|
+
# * {Types::ListTemplateVersionsResponse#template_version_summary_list #template_version_summary_list} => Array<Types::TemplateVersionSummary>
|
4773
|
+
# * {Types::ListTemplateVersionsResponse#next_token #next_token} => String
|
4774
|
+
# * {Types::ListTemplateVersionsResponse#status #status} => Integer
|
4775
|
+
# * {Types::ListTemplateVersionsResponse#request_id #request_id} => String
|
4776
|
+
#
|
4777
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4778
|
+
#
|
4779
|
+
# @example Request syntax with placeholder values
|
4780
|
+
#
|
4781
|
+
# resp = client.list_template_versions({
|
4782
|
+
# aws_account_id: "AwsAccountId", # required
|
4783
|
+
# template_id: "RestrictiveResourceId", # required
|
4784
|
+
# next_token: "String",
|
4785
|
+
# max_results: 1,
|
4786
|
+
# })
|
4787
|
+
#
|
4788
|
+
# @example Response structure
|
4789
|
+
#
|
4790
|
+
# resp.template_version_summary_list #=> Array
|
4791
|
+
# resp.template_version_summary_list[0].arn #=> String
|
4792
|
+
# resp.template_version_summary_list[0].version_number #=> Integer
|
4793
|
+
# resp.template_version_summary_list[0].created_time #=> Time
|
4794
|
+
# 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"
|
4795
|
+
# resp.template_version_summary_list[0].description #=> String
|
4796
|
+
# resp.next_token #=> String
|
4797
|
+
# resp.status #=> Integer
|
4798
|
+
# resp.request_id #=> String
|
4799
|
+
#
|
4800
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTemplateVersions AWS API Documentation
|
4801
|
+
#
|
4802
|
+
# @overload list_template_versions(params = {})
|
4803
|
+
# @param [Hash] params ({})
|
4804
|
+
def list_template_versions(params = {}, options = {})
|
4805
|
+
req = build_request(:list_template_versions, params)
|
4806
|
+
req.send_request(options)
|
4807
|
+
end
|
4808
|
+
|
4809
|
+
# Lists all the templates in the current Amazon QuickSight account.
|
4810
|
+
#
|
4811
|
+
# @option params [required, String] :aws_account_id
|
4812
|
+
# The ID of the AWS account that contains the templates that you're
|
4813
|
+
# listing.
|
4814
|
+
#
|
4815
|
+
# @option params [String] :next_token
|
4816
|
+
# The token for the next set of results, or null if there are no more
|
4817
|
+
# results.
|
4818
|
+
#
|
4819
|
+
# @option params [Integer] :max_results
|
4820
|
+
# The maximum number of results to be returned per request.
|
4821
|
+
#
|
4822
|
+
# @return [Types::ListTemplatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4823
|
+
#
|
4824
|
+
# * {Types::ListTemplatesResponse#template_summary_list #template_summary_list} => Array<Types::TemplateSummary>
|
4825
|
+
# * {Types::ListTemplatesResponse#next_token #next_token} => String
|
4826
|
+
# * {Types::ListTemplatesResponse#status #status} => Integer
|
4827
|
+
# * {Types::ListTemplatesResponse#request_id #request_id} => String
|
4828
|
+
#
|
4829
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4830
|
+
#
|
4831
|
+
# @example Request syntax with placeholder values
|
4832
|
+
#
|
4833
|
+
# resp = client.list_templates({
|
4834
|
+
# aws_account_id: "AwsAccountId", # required
|
4835
|
+
# next_token: "String",
|
4836
|
+
# max_results: 1,
|
4837
|
+
# })
|
4838
|
+
#
|
4839
|
+
# @example Response structure
|
4840
|
+
#
|
4841
|
+
# resp.template_summary_list #=> Array
|
4842
|
+
# resp.template_summary_list[0].arn #=> String
|
4843
|
+
# resp.template_summary_list[0].template_id #=> String
|
4844
|
+
# resp.template_summary_list[0].name #=> String
|
4845
|
+
# resp.template_summary_list[0].latest_version_number #=> Integer
|
4846
|
+
# resp.template_summary_list[0].created_time #=> Time
|
4847
|
+
# resp.template_summary_list[0].last_updated_time #=> Time
|
4848
|
+
# resp.next_token #=> String
|
4849
|
+
# resp.status #=> Integer
|
4850
|
+
# resp.request_id #=> String
|
4851
|
+
#
|
4852
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTemplates AWS API Documentation
|
4853
|
+
#
|
4854
|
+
# @overload list_templates(params = {})
|
4855
|
+
# @param [Hash] params ({})
|
4856
|
+
def list_templates(params = {}, options = {})
|
4857
|
+
req = build_request(:list_templates, params)
|
4858
|
+
req.send_request(options)
|
4859
|
+
end
|
4860
|
+
|
4861
|
+
# Lists all the aliases of a theme.
|
4862
|
+
#
|
4863
|
+
# @option params [required, String] :aws_account_id
|
4864
|
+
# The ID of the AWS account that contains the theme aliases that you're
|
4865
|
+
# listing.
|
4866
|
+
#
|
4867
|
+
# @option params [required, String] :theme_id
|
4868
|
+
# The ID for the theme.
|
4869
|
+
#
|
4870
|
+
# @option params [String] :next_token
|
4871
|
+
# The token for the next set of results, or null if there are no more
|
4872
|
+
# results.
|
4873
|
+
#
|
4874
|
+
# @option params [Integer] :max_results
|
4875
|
+
# The maximum number of results to be returned per request.
|
4876
|
+
#
|
4877
|
+
# @return [Types::ListThemeAliasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3340
4878
|
#
|
3341
|
-
#
|
4879
|
+
# * {Types::ListThemeAliasesResponse#theme_alias_list #theme_alias_list} => Array<Types::ThemeAlias>
|
4880
|
+
# * {Types::ListThemeAliasesResponse#status #status} => Integer
|
4881
|
+
# * {Types::ListThemeAliasesResponse#request_id #request_id} => String
|
4882
|
+
# * {Types::ListThemeAliasesResponse#next_token #next_token} => String
|
3342
4883
|
#
|
3343
4884
|
# @example Request syntax with placeholder values
|
3344
4885
|
#
|
3345
|
-
# resp = client.
|
4886
|
+
# resp = client.list_theme_aliases({
|
3346
4887
|
# aws_account_id: "AwsAccountId", # required
|
3347
|
-
#
|
4888
|
+
# theme_id: "RestrictiveResourceId", # required
|
3348
4889
|
# next_token: "String",
|
3349
4890
|
# max_results: 1,
|
3350
4891
|
# })
|
3351
4892
|
#
|
3352
4893
|
# @example Response structure
|
3353
4894
|
#
|
3354
|
-
# resp.
|
3355
|
-
# resp.
|
3356
|
-
# resp.
|
3357
|
-
# resp.
|
4895
|
+
# resp.theme_alias_list #=> Array
|
4896
|
+
# resp.theme_alias_list[0].arn #=> String
|
4897
|
+
# resp.theme_alias_list[0].alias_name #=> String
|
4898
|
+
# resp.theme_alias_list[0].theme_version_number #=> Integer
|
3358
4899
|
# resp.status #=> Integer
|
3359
4900
|
# resp.request_id #=> String
|
3360
4901
|
# resp.next_token #=> String
|
3361
4902
|
#
|
3362
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
4903
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListThemeAliases AWS API Documentation
|
3363
4904
|
#
|
3364
|
-
# @overload
|
4905
|
+
# @overload list_theme_aliases(params = {})
|
3365
4906
|
# @param [Hash] params ({})
|
3366
|
-
def
|
3367
|
-
req = build_request(:
|
4907
|
+
def list_theme_aliases(params = {}, options = {})
|
4908
|
+
req = build_request(:list_theme_aliases, params)
|
3368
4909
|
req.send_request(options)
|
3369
4910
|
end
|
3370
4911
|
|
3371
|
-
# Lists all the versions of the
|
3372
|
-
# QuickSight account.
|
4912
|
+
# Lists all the versions of the themes in the current AWS account.
|
3373
4913
|
#
|
3374
4914
|
# @option params [required, String] :aws_account_id
|
3375
|
-
# The ID of the AWS account that contains the
|
4915
|
+
# The ID of the AWS account that contains the themes that you're
|
3376
4916
|
# listing.
|
3377
4917
|
#
|
3378
|
-
# @option params [required, String] :
|
3379
|
-
# The ID for the
|
4918
|
+
# @option params [required, String] :theme_id
|
4919
|
+
# The ID for the theme.
|
3380
4920
|
#
|
3381
4921
|
# @option params [String] :next_token
|
3382
4922
|
# The token for the next set of results, or null if there are no more
|
@@ -3385,49 +4925,47 @@ module Aws::QuickSight
|
|
3385
4925
|
# @option params [Integer] :max_results
|
3386
4926
|
# The maximum number of results to be returned per request.
|
3387
4927
|
#
|
3388
|
-
# @return [Types::
|
3389
|
-
#
|
3390
|
-
# * {Types::ListTemplateVersionsResponse#template_version_summary_list #template_version_summary_list} => Array<Types::TemplateVersionSummary>
|
3391
|
-
# * {Types::ListTemplateVersionsResponse#next_token #next_token} => String
|
3392
|
-
# * {Types::ListTemplateVersionsResponse#status #status} => Integer
|
3393
|
-
# * {Types::ListTemplateVersionsResponse#request_id #request_id} => String
|
4928
|
+
# @return [Types::ListThemeVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3394
4929
|
#
|
3395
|
-
#
|
4930
|
+
# * {Types::ListThemeVersionsResponse#theme_version_summary_list #theme_version_summary_list} => Array<Types::ThemeVersionSummary>
|
4931
|
+
# * {Types::ListThemeVersionsResponse#next_token #next_token} => String
|
4932
|
+
# * {Types::ListThemeVersionsResponse#status #status} => Integer
|
4933
|
+
# * {Types::ListThemeVersionsResponse#request_id #request_id} => String
|
3396
4934
|
#
|
3397
4935
|
# @example Request syntax with placeholder values
|
3398
4936
|
#
|
3399
|
-
# resp = client.
|
4937
|
+
# resp = client.list_theme_versions({
|
3400
4938
|
# aws_account_id: "AwsAccountId", # required
|
3401
|
-
#
|
4939
|
+
# theme_id: "RestrictiveResourceId", # required
|
3402
4940
|
# next_token: "String",
|
3403
4941
|
# max_results: 1,
|
3404
4942
|
# })
|
3405
4943
|
#
|
3406
4944
|
# @example Response structure
|
3407
4945
|
#
|
3408
|
-
# resp.
|
3409
|
-
# resp.
|
3410
|
-
# resp.
|
3411
|
-
# resp.
|
3412
|
-
# resp.
|
3413
|
-
# resp.
|
4946
|
+
# resp.theme_version_summary_list #=> Array
|
4947
|
+
# resp.theme_version_summary_list[0].version_number #=> Integer
|
4948
|
+
# resp.theme_version_summary_list[0].arn #=> String
|
4949
|
+
# resp.theme_version_summary_list[0].description #=> String
|
4950
|
+
# resp.theme_version_summary_list[0].created_time #=> Time
|
4951
|
+
# 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"
|
3414
4952
|
# resp.next_token #=> String
|
3415
4953
|
# resp.status #=> Integer
|
3416
4954
|
# resp.request_id #=> String
|
3417
4955
|
#
|
3418
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
4956
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListThemeVersions AWS API Documentation
|
3419
4957
|
#
|
3420
|
-
# @overload
|
4958
|
+
# @overload list_theme_versions(params = {})
|
3421
4959
|
# @param [Hash] params ({})
|
3422
|
-
def
|
3423
|
-
req = build_request(:
|
4960
|
+
def list_theme_versions(params = {}, options = {})
|
4961
|
+
req = build_request(:list_theme_versions, params)
|
3424
4962
|
req.send_request(options)
|
3425
4963
|
end
|
3426
4964
|
|
3427
|
-
# Lists all the
|
4965
|
+
# Lists all the themes in the current AWS account.
|
3428
4966
|
#
|
3429
4967
|
# @option params [required, String] :aws_account_id
|
3430
|
-
# The ID of the AWS account that contains the
|
4968
|
+
# The ID of the AWS account that contains the themes that you're
|
3431
4969
|
# listing.
|
3432
4970
|
#
|
3433
4971
|
# @option params [String] :next_token
|
@@ -3437,42 +4975,53 @@ module Aws::QuickSight
|
|
3437
4975
|
# @option params [Integer] :max_results
|
3438
4976
|
# The maximum number of results to be returned per request.
|
3439
4977
|
#
|
3440
|
-
# @
|
4978
|
+
# @option params [String] :type
|
4979
|
+
# The type of themes that you want to list. Valid options include the
|
4980
|
+
# following:
|
3441
4981
|
#
|
3442
|
-
# *
|
3443
|
-
# * {Types::ListTemplatesResponse#next_token #next_token} => String
|
3444
|
-
# * {Types::ListTemplatesResponse#status #status} => Integer
|
3445
|
-
# * {Types::ListTemplatesResponse#request_id #request_id} => String
|
4982
|
+
# * `ALL (default)`- Display all existing themes.
|
3446
4983
|
#
|
3447
|
-
#
|
4984
|
+
# * `CUSTOM` - Display only the themes created by people using Amazon
|
4985
|
+
# QuickSight.
|
4986
|
+
#
|
4987
|
+
# * `QUICKSIGHT` - Display only the starting themes defined by
|
4988
|
+
# QuickSight.
|
4989
|
+
#
|
4990
|
+
# @return [Types::ListThemesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4991
|
+
#
|
4992
|
+
# * {Types::ListThemesResponse#theme_summary_list #theme_summary_list} => Array<Types::ThemeSummary>
|
4993
|
+
# * {Types::ListThemesResponse#next_token #next_token} => String
|
4994
|
+
# * {Types::ListThemesResponse#status #status} => Integer
|
4995
|
+
# * {Types::ListThemesResponse#request_id #request_id} => String
|
3448
4996
|
#
|
3449
4997
|
# @example Request syntax with placeholder values
|
3450
4998
|
#
|
3451
|
-
# resp = client.
|
4999
|
+
# resp = client.list_themes({
|
3452
5000
|
# aws_account_id: "AwsAccountId", # required
|
3453
5001
|
# next_token: "String",
|
3454
5002
|
# max_results: 1,
|
5003
|
+
# type: "QUICKSIGHT", # accepts QUICKSIGHT, CUSTOM, ALL
|
3455
5004
|
# })
|
3456
5005
|
#
|
3457
5006
|
# @example Response structure
|
3458
5007
|
#
|
3459
|
-
# resp.
|
3460
|
-
# resp.
|
3461
|
-
# resp.
|
3462
|
-
# resp.
|
3463
|
-
# resp.
|
3464
|
-
# resp.
|
3465
|
-
# resp.
|
5008
|
+
# resp.theme_summary_list #=> Array
|
5009
|
+
# resp.theme_summary_list[0].arn #=> String
|
5010
|
+
# resp.theme_summary_list[0].name #=> String
|
5011
|
+
# resp.theme_summary_list[0].theme_id #=> String
|
5012
|
+
# resp.theme_summary_list[0].latest_version_number #=> Integer
|
5013
|
+
# resp.theme_summary_list[0].created_time #=> Time
|
5014
|
+
# resp.theme_summary_list[0].last_updated_time #=> Time
|
3466
5015
|
# resp.next_token #=> String
|
3467
5016
|
# resp.status #=> Integer
|
3468
5017
|
# resp.request_id #=> String
|
3469
5018
|
#
|
3470
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
5019
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListThemes AWS API Documentation
|
3471
5020
|
#
|
3472
|
-
# @overload
|
5021
|
+
# @overload list_themes(params = {})
|
3473
5022
|
# @param [Hash] params ({})
|
3474
|
-
def
|
3475
|
-
req = build_request(:
|
5023
|
+
def list_themes(params = {}, options = {})
|
5024
|
+
req = build_request(:list_themes, params)
|
3476
5025
|
req.send_request(options)
|
3477
5026
|
end
|
3478
5027
|
|
@@ -3575,6 +5124,7 @@ module Aws::QuickSight
|
|
3575
5124
|
# resp.user_list[0].identity_type #=> String, one of "IAM", "QUICKSIGHT"
|
3576
5125
|
# resp.user_list[0].active #=> Boolean
|
3577
5126
|
# resp.user_list[0].principal_id #=> String
|
5127
|
+
# resp.user_list[0].custom_permissions_name #=> String
|
3578
5128
|
# resp.next_token #=> String
|
3579
5129
|
# resp.request_id #=> String
|
3580
5130
|
# resp.status #=> Integer
|
@@ -3648,6 +5198,38 @@ module Aws::QuickSight
|
|
3648
5198
|
# The Amazon QuickSight user name that you want to create for the user
|
3649
5199
|
# you are registering.
|
3650
5200
|
#
|
5201
|
+
# @option params [String] :custom_permissions_name
|
5202
|
+
# (Enterprise edition only) The name of the custom permissions profile
|
5203
|
+
# that you want to assign to this user. Customized permissions allows
|
5204
|
+
# you to control a user's access by restricting access the following
|
5205
|
+
# operations:
|
5206
|
+
#
|
5207
|
+
# * Create and update data sources
|
5208
|
+
#
|
5209
|
+
# * Create and update datasets
|
5210
|
+
#
|
5211
|
+
# * Create and update email reports
|
5212
|
+
#
|
5213
|
+
# * Subscribe to email reports
|
5214
|
+
#
|
5215
|
+
# To add custom permissions to an existing user, use ` UpdateUser `
|
5216
|
+
# instead.
|
5217
|
+
#
|
5218
|
+
# A set of custom permissions includes any combination of these
|
5219
|
+
# restrictions. Currently, you need to create the profile names for
|
5220
|
+
# custom permission sets by using the QuickSight console. Then, you use
|
5221
|
+
# the `RegisterUser` API operation to assign the named set of
|
5222
|
+
# permissions to a QuickSight user.
|
5223
|
+
#
|
5224
|
+
# QuickSight custom permissions are applied through IAM policies.
|
5225
|
+
# Therefore, they override the permissions typically granted by
|
5226
|
+
# assigning QuickSight users to one of the default security cohorts in
|
5227
|
+
# QuickSight (admin, author, reader).
|
5228
|
+
#
|
5229
|
+
# This feature is available only to QuickSight Enterprise edition
|
5230
|
+
# subscriptions that use SAML 2.0-Based Federation for Single Sign-On
|
5231
|
+
# (SSO).
|
5232
|
+
#
|
3651
5233
|
# @return [Types::RegisterUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3652
5234
|
#
|
3653
5235
|
# * {Types::RegisterUserResponse#user #user} => Types::User
|
@@ -3666,6 +5248,7 @@ module Aws::QuickSight
|
|
3666
5248
|
# aws_account_id: "AwsAccountId", # required
|
3667
5249
|
# namespace: "Namespace", # required
|
3668
5250
|
# user_name: "UserName",
|
5251
|
+
# custom_permissions_name: "RoleName",
|
3669
5252
|
# })
|
3670
5253
|
#
|
3671
5254
|
# @example Response structure
|
@@ -3677,6 +5260,7 @@ module Aws::QuickSight
|
|
3677
5260
|
# resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
|
3678
5261
|
# resp.user.active #=> Boolean
|
3679
5262
|
# resp.user.principal_id #=> String
|
5263
|
+
# resp.user.custom_permissions_name #=> String
|
3680
5264
|
# resp.user_invitation_url #=> String
|
3681
5265
|
# resp.request_id #=> String
|
3682
5266
|
# resp.status #=> Integer
|
@@ -3690,7 +5274,107 @@ module Aws::QuickSight
|
|
3690
5274
|
req.send_request(options)
|
3691
5275
|
end
|
3692
5276
|
|
3693
|
-
#
|
5277
|
+
# Restores an analysis.
|
5278
|
+
#
|
5279
|
+
# @option params [required, String] :aws_account_id
|
5280
|
+
# The ID of the AWS account that contains the analysis.
|
5281
|
+
#
|
5282
|
+
# @option params [required, String] :analysis_id
|
5283
|
+
# The ID of the analysis that you're restoring.
|
5284
|
+
#
|
5285
|
+
# @return [Types::RestoreAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5286
|
+
#
|
5287
|
+
# * {Types::RestoreAnalysisResponse#status #status} => Integer
|
5288
|
+
# * {Types::RestoreAnalysisResponse#arn #arn} => String
|
5289
|
+
# * {Types::RestoreAnalysisResponse#analysis_id #analysis_id} => String
|
5290
|
+
# * {Types::RestoreAnalysisResponse#request_id #request_id} => String
|
5291
|
+
#
|
5292
|
+
# @example Request syntax with placeholder values
|
5293
|
+
#
|
5294
|
+
# resp = client.restore_analysis({
|
5295
|
+
# aws_account_id: "AwsAccountId", # required
|
5296
|
+
# analysis_id: "RestrictiveResourceId", # required
|
5297
|
+
# })
|
5298
|
+
#
|
5299
|
+
# @example Response structure
|
5300
|
+
#
|
5301
|
+
# resp.status #=> Integer
|
5302
|
+
# resp.arn #=> String
|
5303
|
+
# resp.analysis_id #=> String
|
5304
|
+
# resp.request_id #=> String
|
5305
|
+
#
|
5306
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RestoreAnalysis AWS API Documentation
|
5307
|
+
#
|
5308
|
+
# @overload restore_analysis(params = {})
|
5309
|
+
# @param [Hash] params ({})
|
5310
|
+
def restore_analysis(params = {}, options = {})
|
5311
|
+
req = build_request(:restore_analysis, params)
|
5312
|
+
req.send_request(options)
|
5313
|
+
end
|
5314
|
+
|
5315
|
+
# Searches for analyses that belong to the user specified in the filter.
|
5316
|
+
#
|
5317
|
+
# @option params [required, String] :aws_account_id
|
5318
|
+
# The ID of the AWS account that contains the analyses that you're
|
5319
|
+
# searching for.
|
5320
|
+
#
|
5321
|
+
# @option params [required, Array<Types::AnalysisSearchFilter>] :filters
|
5322
|
+
# The structure for the search filters that you want to apply to your
|
5323
|
+
# search.
|
5324
|
+
#
|
5325
|
+
# @option params [String] :next_token
|
5326
|
+
# A pagination token that can be used in a subsequent request.
|
5327
|
+
#
|
5328
|
+
# @option params [Integer] :max_results
|
5329
|
+
# The maximum number of results to return.
|
5330
|
+
#
|
5331
|
+
# @return [Types::SearchAnalysesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5332
|
+
#
|
5333
|
+
# * {Types::SearchAnalysesResponse#analysis_summary_list #analysis_summary_list} => Array<Types::AnalysisSummary>
|
5334
|
+
# * {Types::SearchAnalysesResponse#next_token #next_token} => String
|
5335
|
+
# * {Types::SearchAnalysesResponse#status #status} => Integer
|
5336
|
+
# * {Types::SearchAnalysesResponse#request_id #request_id} => String
|
5337
|
+
#
|
5338
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5339
|
+
#
|
5340
|
+
# @example Request syntax with placeholder values
|
5341
|
+
#
|
5342
|
+
# resp = client.search_analyses({
|
5343
|
+
# aws_account_id: "AwsAccountId", # required
|
5344
|
+
# filters: [ # required
|
5345
|
+
# {
|
5346
|
+
# operator: "StringEquals", # accepts StringEquals
|
5347
|
+
# name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER
|
5348
|
+
# value: "String",
|
5349
|
+
# },
|
5350
|
+
# ],
|
5351
|
+
# next_token: "String",
|
5352
|
+
# max_results: 1,
|
5353
|
+
# })
|
5354
|
+
#
|
5355
|
+
# @example Response structure
|
5356
|
+
#
|
5357
|
+
# resp.analysis_summary_list #=> Array
|
5358
|
+
# resp.analysis_summary_list[0].arn #=> String
|
5359
|
+
# resp.analysis_summary_list[0].analysis_id #=> String
|
5360
|
+
# resp.analysis_summary_list[0].name #=> String
|
5361
|
+
# resp.analysis_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
5362
|
+
# resp.analysis_summary_list[0].created_time #=> Time
|
5363
|
+
# resp.analysis_summary_list[0].last_updated_time #=> Time
|
5364
|
+
# resp.next_token #=> String
|
5365
|
+
# resp.status #=> Integer
|
5366
|
+
# resp.request_id #=> String
|
5367
|
+
#
|
5368
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchAnalyses AWS API Documentation
|
5369
|
+
#
|
5370
|
+
# @overload search_analyses(params = {})
|
5371
|
+
# @param [Hash] params ({})
|
5372
|
+
def search_analyses(params = {}, options = {})
|
5373
|
+
req = build_request(:search_analyses, params)
|
5374
|
+
req.send_request(options)
|
5375
|
+
end
|
5376
|
+
|
5377
|
+
# Searches for dashboards that belong to a user.
|
3694
5378
|
#
|
3695
5379
|
# @option params [required, String] :aws_account_id
|
3696
5380
|
# The ID of the AWS account that contains the user whose dashboards
|
@@ -3768,89 +5452,354 @@ module Aws::QuickSight
|
|
3768
5452
|
# key that is already associated with the resource, the new tag value
|
3769
5453
|
# that you specify replaces the previous value for that tag.
|
3770
5454
|
#
|
3771
|
-
# You can associate as many as 50 tags with a resource. QuickSight
|
3772
|
-
# supports tagging on data set, data source, dashboard, and template.
|
5455
|
+
# You can associate as many as 50 tags with a resource. QuickSight
|
5456
|
+
# supports tagging on data set, data source, dashboard, and template.
|
5457
|
+
#
|
5458
|
+
# Tagging for QuickSight works in a similar way to tagging for other AWS
|
5459
|
+
# services, except for the following:
|
5460
|
+
#
|
5461
|
+
# * You can't use tags to track AWS costs for QuickSight. This
|
5462
|
+
# restriction is because QuickSight costs are based on users and SPICE
|
5463
|
+
# capacity, which aren't taggable resources.
|
5464
|
+
#
|
5465
|
+
# * QuickSight doesn't currently support the Tag Editor for AWS
|
5466
|
+
# Resource Groups.
|
5467
|
+
#
|
5468
|
+
# @option params [required, String] :resource_arn
|
5469
|
+
# The Amazon Resource Name (ARN) of the resource that you want to tag.
|
5470
|
+
#
|
5471
|
+
# @option params [required, Array<Types::Tag>] :tags
|
5472
|
+
# Contains a map of the key-value pairs for the resource tag or tags
|
5473
|
+
# assigned to the resource.
|
5474
|
+
#
|
5475
|
+
# @return [Types::TagResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5476
|
+
#
|
5477
|
+
# * {Types::TagResourceResponse#request_id #request_id} => String
|
5478
|
+
# * {Types::TagResourceResponse#status #status} => Integer
|
5479
|
+
#
|
5480
|
+
# @example Request syntax with placeholder values
|
5481
|
+
#
|
5482
|
+
# resp = client.tag_resource({
|
5483
|
+
# resource_arn: "Arn", # required
|
5484
|
+
# tags: [ # required
|
5485
|
+
# {
|
5486
|
+
# key: "TagKey", # required
|
5487
|
+
# value: "TagValue", # required
|
5488
|
+
# },
|
5489
|
+
# ],
|
5490
|
+
# })
|
5491
|
+
#
|
5492
|
+
# @example Response structure
|
5493
|
+
#
|
5494
|
+
# resp.request_id #=> String
|
5495
|
+
# resp.status #=> Integer
|
5496
|
+
#
|
5497
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TagResource AWS API Documentation
|
5498
|
+
#
|
5499
|
+
# @overload tag_resource(params = {})
|
5500
|
+
# @param [Hash] params ({})
|
5501
|
+
def tag_resource(params = {}, options = {})
|
5502
|
+
req = build_request(:tag_resource, params)
|
5503
|
+
req.send_request(options)
|
5504
|
+
end
|
5505
|
+
|
5506
|
+
# Removes a tag or tags from a resource.
|
5507
|
+
#
|
5508
|
+
# @option params [required, String] :resource_arn
|
5509
|
+
# The Amazon Resource Name (ARN) of the resource that you want to untag.
|
5510
|
+
#
|
5511
|
+
# @option params [required, Array<String>] :tag_keys
|
5512
|
+
# The keys of the key-value pairs for the resource tag or tags assigned
|
5513
|
+
# to the resource.
|
5514
|
+
#
|
5515
|
+
# @return [Types::UntagResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5516
|
+
#
|
5517
|
+
# * {Types::UntagResourceResponse#request_id #request_id} => String
|
5518
|
+
# * {Types::UntagResourceResponse#status #status} => Integer
|
5519
|
+
#
|
5520
|
+
# @example Request syntax with placeholder values
|
5521
|
+
#
|
5522
|
+
# resp = client.untag_resource({
|
5523
|
+
# resource_arn: "Arn", # required
|
5524
|
+
# tag_keys: ["TagKey"], # required
|
5525
|
+
# })
|
5526
|
+
#
|
5527
|
+
# @example Response structure
|
5528
|
+
#
|
5529
|
+
# resp.request_id #=> String
|
5530
|
+
# resp.status #=> Integer
|
5531
|
+
#
|
5532
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UntagResource AWS API Documentation
|
5533
|
+
#
|
5534
|
+
# @overload untag_resource(params = {})
|
5535
|
+
# @param [Hash] params ({})
|
5536
|
+
def untag_resource(params = {}, options = {})
|
5537
|
+
req = build_request(:untag_resource, params)
|
5538
|
+
req.send_request(options)
|
5539
|
+
end
|
5540
|
+
|
5541
|
+
# Updates Amazon QuickSight customizations the current AWS Region.
|
5542
|
+
# Currently, the only customization you can use is a theme.
|
5543
|
+
#
|
5544
|
+
# You can use customizations for your AWS account or, if you specify a
|
5545
|
+
# namespace, for a QuickSight namespace instead. Customizations that
|
5546
|
+
# apply to a namespace override customizations that apply to an AWS
|
5547
|
+
# account. To find out which customizations apply, use the
|
5548
|
+
# `DescribeAccountCustomization` API operation.
|
5549
|
+
#
|
5550
|
+
# @option params [required, String] :aws_account_id
|
5551
|
+
# The ID for the AWS account that you want to update QuickSight
|
5552
|
+
# customizations for.
|
5553
|
+
#
|
5554
|
+
# @option params [String] :namespace
|
5555
|
+
# The namespace that you want to update QuickSight customizations for.
|
5556
|
+
#
|
5557
|
+
# @option params [required, Types::AccountCustomization] :account_customization
|
5558
|
+
# The QuickSight customizations you're updating in the current AWS
|
5559
|
+
# Region.
|
5560
|
+
#
|
5561
|
+
# @return [Types::UpdateAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5562
|
+
#
|
5563
|
+
# * {Types::UpdateAccountCustomizationResponse#arn #arn} => String
|
5564
|
+
# * {Types::UpdateAccountCustomizationResponse#aws_account_id #aws_account_id} => String
|
5565
|
+
# * {Types::UpdateAccountCustomizationResponse#namespace #namespace} => String
|
5566
|
+
# * {Types::UpdateAccountCustomizationResponse#account_customization #account_customization} => Types::AccountCustomization
|
5567
|
+
# * {Types::UpdateAccountCustomizationResponse#request_id #request_id} => String
|
5568
|
+
# * {Types::UpdateAccountCustomizationResponse#status #status} => Integer
|
5569
|
+
#
|
5570
|
+
# @example Request syntax with placeholder values
|
5571
|
+
#
|
5572
|
+
# resp = client.update_account_customization({
|
5573
|
+
# aws_account_id: "AwsAccountId", # required
|
5574
|
+
# namespace: "Namespace",
|
5575
|
+
# account_customization: { # required
|
5576
|
+
# default_theme: "Arn",
|
5577
|
+
# },
|
5578
|
+
# })
|
5579
|
+
#
|
5580
|
+
# @example Response structure
|
5581
|
+
#
|
5582
|
+
# resp.arn #=> String
|
5583
|
+
# resp.aws_account_id #=> String
|
5584
|
+
# resp.namespace #=> String
|
5585
|
+
# resp.account_customization.default_theme #=> String
|
5586
|
+
# resp.request_id #=> String
|
5587
|
+
# resp.status #=> Integer
|
5588
|
+
#
|
5589
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomization AWS API Documentation
|
5590
|
+
#
|
5591
|
+
# @overload update_account_customization(params = {})
|
5592
|
+
# @param [Hash] params ({})
|
5593
|
+
def update_account_customization(params = {}, options = {})
|
5594
|
+
req = build_request(:update_account_customization, params)
|
5595
|
+
req.send_request(options)
|
5596
|
+
end
|
5597
|
+
|
5598
|
+
# Updates the Amazon QuickSight settings in your AWS Account.
|
5599
|
+
#
|
5600
|
+
# @option params [required, String] :aws_account_id
|
5601
|
+
# The ID for the AWS account that contains the QuickSight settings that
|
5602
|
+
# you want to list.
|
5603
|
+
#
|
5604
|
+
# @option params [required, String] :default_namespace
|
5605
|
+
# The default namespace for this AWS Account. Currently, the default is
|
5606
|
+
# `default`. IAM users who register for the first time with QuickSight
|
5607
|
+
# provide an email that becomes associated with the default namespace.
|
5608
|
+
#
|
5609
|
+
# @option params [String] :notification_email
|
5610
|
+
# The email address that you want QuickSight to send notifications to
|
5611
|
+
# regarding your AWS account or QuickSight subscription.
|
5612
|
+
#
|
5613
|
+
# @return [Types::UpdateAccountSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5614
|
+
#
|
5615
|
+
# * {Types::UpdateAccountSettingsResponse#request_id #request_id} => String
|
5616
|
+
# * {Types::UpdateAccountSettingsResponse#status #status} => Integer
|
5617
|
+
#
|
5618
|
+
# @example Request syntax with placeholder values
|
5619
|
+
#
|
5620
|
+
# resp = client.update_account_settings({
|
5621
|
+
# aws_account_id: "AwsAccountId", # required
|
5622
|
+
# default_namespace: "Namespace", # required
|
5623
|
+
# notification_email: "String",
|
5624
|
+
# })
|
5625
|
+
#
|
5626
|
+
# @example Response structure
|
5627
|
+
#
|
5628
|
+
# resp.request_id #=> String
|
5629
|
+
# resp.status #=> Integer
|
5630
|
+
#
|
5631
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountSettings AWS API Documentation
|
3773
5632
|
#
|
3774
|
-
#
|
3775
|
-
#
|
5633
|
+
# @overload update_account_settings(params = {})
|
5634
|
+
# @param [Hash] params ({})
|
5635
|
+
def update_account_settings(params = {}, options = {})
|
5636
|
+
req = build_request(:update_account_settings, params)
|
5637
|
+
req.send_request(options)
|
5638
|
+
end
|
5639
|
+
|
5640
|
+
# Updates an analysis in Amazon QuickSight
|
3776
5641
|
#
|
3777
|
-
#
|
3778
|
-
#
|
3779
|
-
#
|
5642
|
+
# @option params [required, String] :aws_account_id
|
5643
|
+
# The ID of the AWS account that contains the analysis that you're
|
5644
|
+
# updating.
|
3780
5645
|
#
|
3781
|
-
#
|
3782
|
-
#
|
5646
|
+
# @option params [required, String] :analysis_id
|
5647
|
+
# The ID for the analysis that you're updating. This ID displays in the
|
5648
|
+
# URL of the analysis.
|
3783
5649
|
#
|
3784
|
-
# @option params [required, String] :
|
3785
|
-
#
|
5650
|
+
# @option params [required, String] :name
|
5651
|
+
# A descriptive name for the analysis that you're updating. This name
|
5652
|
+
# displays for the analysis in the QuickSight console.
|
3786
5653
|
#
|
3787
|
-
# @option params [
|
3788
|
-
#
|
3789
|
-
#
|
5654
|
+
# @option params [Types::Parameters] :parameters
|
5655
|
+
# The parameter names and override values that you want to use. An
|
5656
|
+
# analysis can have any parameter type, and some parameters might accept
|
5657
|
+
# multiple values.
|
3790
5658
|
#
|
3791
|
-
# @
|
5659
|
+
# @option params [required, Types::AnalysisSourceEntity] :source_entity
|
5660
|
+
# A source entity to use for the analysis that you're updating. This
|
5661
|
+
# metadata structure contains details that describe a source template
|
5662
|
+
# and one or more datasets.
|
3792
5663
|
#
|
3793
|
-
#
|
3794
|
-
#
|
5664
|
+
# @option params [String] :theme_arn
|
5665
|
+
# The Amazon Resource Name (ARN) for the theme to apply to the analysis
|
5666
|
+
# that you're creating. To see the theme in the QuickSight console,
|
5667
|
+
# make sure that you have access to it.
|
5668
|
+
#
|
5669
|
+
# @return [Types::UpdateAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5670
|
+
#
|
5671
|
+
# * {Types::UpdateAnalysisResponse#arn #arn} => String
|
5672
|
+
# * {Types::UpdateAnalysisResponse#analysis_id #analysis_id} => String
|
5673
|
+
# * {Types::UpdateAnalysisResponse#update_status #update_status} => String
|
5674
|
+
# * {Types::UpdateAnalysisResponse#status #status} => Integer
|
5675
|
+
# * {Types::UpdateAnalysisResponse#request_id #request_id} => String
|
3795
5676
|
#
|
3796
5677
|
# @example Request syntax with placeholder values
|
3797
5678
|
#
|
3798
|
-
# resp = client.
|
3799
|
-
#
|
3800
|
-
#
|
3801
|
-
#
|
3802
|
-
#
|
3803
|
-
#
|
5679
|
+
# resp = client.update_analysis({
|
5680
|
+
# aws_account_id: "AwsAccountId", # required
|
5681
|
+
# analysis_id: "RestrictiveResourceId", # required
|
5682
|
+
# name: "AnalysisName", # required
|
5683
|
+
# parameters: {
|
5684
|
+
# string_parameters: [
|
5685
|
+
# {
|
5686
|
+
# name: "NonEmptyString", # required
|
5687
|
+
# values: ["String"], # required
|
5688
|
+
# },
|
5689
|
+
# ],
|
5690
|
+
# integer_parameters: [
|
5691
|
+
# {
|
5692
|
+
# name: "NonEmptyString", # required
|
5693
|
+
# values: [1], # required
|
5694
|
+
# },
|
5695
|
+
# ],
|
5696
|
+
# decimal_parameters: [
|
5697
|
+
# {
|
5698
|
+
# name: "NonEmptyString", # required
|
5699
|
+
# values: [1.0], # required
|
5700
|
+
# },
|
5701
|
+
# ],
|
5702
|
+
# date_time_parameters: [
|
5703
|
+
# {
|
5704
|
+
# name: "NonEmptyString", # required
|
5705
|
+
# values: [Time.now], # required
|
5706
|
+
# },
|
5707
|
+
# ],
|
5708
|
+
# },
|
5709
|
+
# source_entity: { # required
|
5710
|
+
# source_template: {
|
5711
|
+
# data_set_references: [ # required
|
5712
|
+
# {
|
5713
|
+
# data_set_placeholder: "NonEmptyString", # required
|
5714
|
+
# data_set_arn: "Arn", # required
|
5715
|
+
# },
|
5716
|
+
# ],
|
5717
|
+
# arn: "Arn", # required
|
3804
5718
|
# },
|
3805
|
-
#
|
5719
|
+
# },
|
5720
|
+
# theme_arn: "Arn",
|
3806
5721
|
# })
|
3807
5722
|
#
|
3808
5723
|
# @example Response structure
|
3809
5724
|
#
|
3810
|
-
# resp.
|
5725
|
+
# resp.arn #=> String
|
5726
|
+
# resp.analysis_id #=> String
|
5727
|
+
# resp.update_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
3811
5728
|
# resp.status #=> Integer
|
5729
|
+
# resp.request_id #=> String
|
3812
5730
|
#
|
3813
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
5731
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysis AWS API Documentation
|
3814
5732
|
#
|
3815
|
-
# @overload
|
5733
|
+
# @overload update_analysis(params = {})
|
3816
5734
|
# @param [Hash] params ({})
|
3817
|
-
def
|
3818
|
-
req = build_request(:
|
5735
|
+
def update_analysis(params = {}, options = {})
|
5736
|
+
req = build_request(:update_analysis, params)
|
3819
5737
|
req.send_request(options)
|
3820
5738
|
end
|
3821
5739
|
|
3822
|
-
#
|
5740
|
+
# Updates the read and write permissions for an analysis.
|
3823
5741
|
#
|
3824
|
-
# @option params [required, String] :
|
3825
|
-
# The
|
5742
|
+
# @option params [required, String] :aws_account_id
|
5743
|
+
# The ID of the AWS account that contains the analysis whose permissions
|
5744
|
+
# you're updating. You must be using the AWS account that the analysis
|
5745
|
+
# is in.
|
3826
5746
|
#
|
3827
|
-
# @option params [required,
|
3828
|
-
# The
|
3829
|
-
#
|
5747
|
+
# @option params [required, String] :analysis_id
|
5748
|
+
# The ID of the analysis whose permissions you're updating. The ID is
|
5749
|
+
# part of the analysis URL.
|
3830
5750
|
#
|
3831
|
-
# @
|
5751
|
+
# @option params [Array<Types::ResourcePermission>] :grant_permissions
|
5752
|
+
# A structure that describes the permissions to add and the principal to
|
5753
|
+
# add them to.
|
3832
5754
|
#
|
3833
|
-
#
|
3834
|
-
#
|
5755
|
+
# @option params [Array<Types::ResourcePermission>] :revoke_permissions
|
5756
|
+
# A structure that describes the permissions to remove and the principal
|
5757
|
+
# to remove them from.
|
5758
|
+
#
|
5759
|
+
# @return [Types::UpdateAnalysisPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5760
|
+
#
|
5761
|
+
# * {Types::UpdateAnalysisPermissionsResponse#analysis_arn #analysis_arn} => String
|
5762
|
+
# * {Types::UpdateAnalysisPermissionsResponse#analysis_id #analysis_id} => String
|
5763
|
+
# * {Types::UpdateAnalysisPermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission>
|
5764
|
+
# * {Types::UpdateAnalysisPermissionsResponse#request_id #request_id} => String
|
5765
|
+
# * {Types::UpdateAnalysisPermissionsResponse#status #status} => Integer
|
3835
5766
|
#
|
3836
5767
|
# @example Request syntax with placeholder values
|
3837
5768
|
#
|
3838
|
-
# resp = client.
|
3839
|
-
#
|
3840
|
-
#
|
5769
|
+
# resp = client.update_analysis_permissions({
|
5770
|
+
# aws_account_id: "AwsAccountId", # required
|
5771
|
+
# analysis_id: "RestrictiveResourceId", # required
|
5772
|
+
# grant_permissions: [
|
5773
|
+
# {
|
5774
|
+
# principal: "Principal", # required
|
5775
|
+
# actions: ["String"], # required
|
5776
|
+
# },
|
5777
|
+
# ],
|
5778
|
+
# revoke_permissions: [
|
5779
|
+
# {
|
5780
|
+
# principal: "Principal", # required
|
5781
|
+
# actions: ["String"], # required
|
5782
|
+
# },
|
5783
|
+
# ],
|
3841
5784
|
# })
|
3842
5785
|
#
|
3843
5786
|
# @example Response structure
|
3844
5787
|
#
|
5788
|
+
# resp.analysis_arn #=> String
|
5789
|
+
# resp.analysis_id #=> String
|
5790
|
+
# resp.permissions #=> Array
|
5791
|
+
# resp.permissions[0].principal #=> String
|
5792
|
+
# resp.permissions[0].actions #=> Array
|
5793
|
+
# resp.permissions[0].actions[0] #=> String
|
3845
5794
|
# resp.request_id #=> String
|
3846
5795
|
# resp.status #=> Integer
|
3847
5796
|
#
|
3848
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
5797
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysisPermissions AWS API Documentation
|
3849
5798
|
#
|
3850
|
-
# @overload
|
5799
|
+
# @overload update_analysis_permissions(params = {})
|
3851
5800
|
# @param [Hash] params ({})
|
3852
|
-
def
|
3853
|
-
req = build_request(:
|
5801
|
+
def update_analysis_permissions(params = {}, options = {})
|
5802
|
+
req = build_request(:update_analysis_permissions, params)
|
3854
5803
|
req.send_request(options)
|
3855
5804
|
end
|
3856
5805
|
|
@@ -3900,13 +5849,19 @@ module Aws::QuickSight
|
|
3900
5849
|
#
|
3901
5850
|
# * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
|
3902
5851
|
# either `ENABLED` or `DISABLED`. The visual option to export data to
|
3903
|
-
# .
|
5852
|
+
# .CSV format isn't enabled when this is set to `DISABLED`. This
|
3904
5853
|
# option is `ENABLED` by default.
|
3905
5854
|
#
|
3906
5855
|
# * `VisibilityState` for `SheetControlsOption` - This visibility state
|
3907
5856
|
# can be either `COLLAPSED` or `EXPANDED`. This option is `COLLAPSED`
|
3908
5857
|
# by default.
|
3909
5858
|
#
|
5859
|
+
# @option params [String] :theme_arn
|
5860
|
+
# The Amazon Resource Name (ARN) of the theme that is being used for
|
5861
|
+
# this dashboard. If you add a value for this field, it overrides the
|
5862
|
+
# value that was originally associated with the entity. The theme ARN
|
5863
|
+
# must exist in the same AWS account where you create the dashboard.
|
5864
|
+
#
|
3910
5865
|
# @return [Types::UpdateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3911
5866
|
#
|
3912
5867
|
# * {Types::UpdateDashboardResponse#arn #arn} => String
|
@@ -3971,6 +5926,7 @@ module Aws::QuickSight
|
|
3971
5926
|
# visibility_state: "EXPANDED", # accepts EXPANDED, COLLAPSED
|
3972
5927
|
# },
|
3973
5928
|
# },
|
5929
|
+
# theme_arn: "Arn",
|
3974
5930
|
# })
|
3975
5931
|
#
|
3976
5932
|
# @example Response structure
|
@@ -3978,7 +5934,7 @@ module Aws::QuickSight
|
|
3978
5934
|
# resp.arn #=> String
|
3979
5935
|
# resp.version_arn #=> String
|
3980
5936
|
# resp.dashboard_id #=> String
|
3981
|
-
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
5937
|
+
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
3982
5938
|
# resp.status #=> Integer
|
3983
5939
|
# resp.request_id #=> String
|
3984
5940
|
#
|
@@ -4244,6 +6200,7 @@ module Aws::QuickSight
|
|
4244
6200
|
# },
|
4245
6201
|
# ],
|
4246
6202
|
# row_level_permission_data_set: {
|
6203
|
+
# namespace: "Namespace",
|
4247
6204
|
# arn: "Arn", # required
|
4248
6205
|
# permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
|
4249
6206
|
# },
|
@@ -4563,7 +6520,7 @@ module Aws::QuickSight
|
|
4563
6520
|
#
|
4564
6521
|
# resp.arn #=> String
|
4565
6522
|
# resp.data_source_id #=> String
|
4566
|
-
# resp.update_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
6523
|
+
# resp.update_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
4567
6524
|
# resp.request_id #=> String
|
4568
6525
|
# resp.status #=> Integer
|
4569
6526
|
#
|
@@ -4833,7 +6790,7 @@ module Aws::QuickSight
|
|
4833
6790
|
# resp.template_id #=> String
|
4834
6791
|
# resp.arn #=> String
|
4835
6792
|
# resp.version_arn #=> String
|
4836
|
-
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
6793
|
+
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
4837
6794
|
# resp.status #=> Integer
|
4838
6795
|
# resp.request_id #=> String
|
4839
6796
|
#
|
@@ -4958,6 +6915,259 @@ module Aws::QuickSight
|
|
4958
6915
|
req.send_request(options)
|
4959
6916
|
end
|
4960
6917
|
|
6918
|
+
# Updates a theme.
|
6919
|
+
#
|
6920
|
+
# @option params [required, String] :aws_account_id
|
6921
|
+
# The ID of the AWS account that contains the theme that you're
|
6922
|
+
# updating.
|
6923
|
+
#
|
6924
|
+
# @option params [required, String] :theme_id
|
6925
|
+
# The ID for the theme.
|
6926
|
+
#
|
6927
|
+
# @option params [String] :name
|
6928
|
+
# The name for the theme.
|
6929
|
+
#
|
6930
|
+
# @option params [required, String] :base_theme_id
|
6931
|
+
# The theme ID, defined by Amazon QuickSight, that a custom theme
|
6932
|
+
# inherits from. All themes initially inherit from a default QuickSight
|
6933
|
+
# theme.
|
6934
|
+
#
|
6935
|
+
# @option params [String] :version_description
|
6936
|
+
# A description of the theme version that you're updating Every time
|
6937
|
+
# that you call `UpdateTheme`, you create a new version of the theme.
|
6938
|
+
# Each version of the theme maintains a description of the version in
|
6939
|
+
# `VersionDescription`.
|
6940
|
+
#
|
6941
|
+
# @option params [Types::ThemeConfiguration] :configuration
|
6942
|
+
# The theme configuration, which contains the theme display properties.
|
6943
|
+
#
|
6944
|
+
# @return [Types::UpdateThemeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6945
|
+
#
|
6946
|
+
# * {Types::UpdateThemeResponse#theme_id #theme_id} => String
|
6947
|
+
# * {Types::UpdateThemeResponse#arn #arn} => String
|
6948
|
+
# * {Types::UpdateThemeResponse#version_arn #version_arn} => String
|
6949
|
+
# * {Types::UpdateThemeResponse#creation_status #creation_status} => String
|
6950
|
+
# * {Types::UpdateThemeResponse#status #status} => Integer
|
6951
|
+
# * {Types::UpdateThemeResponse#request_id #request_id} => String
|
6952
|
+
#
|
6953
|
+
# @example Request syntax with placeholder values
|
6954
|
+
#
|
6955
|
+
# resp = client.update_theme({
|
6956
|
+
# aws_account_id: "AwsAccountId", # required
|
6957
|
+
# theme_id: "RestrictiveResourceId", # required
|
6958
|
+
# name: "ThemeName",
|
6959
|
+
# base_theme_id: "RestrictiveResourceId", # required
|
6960
|
+
# version_description: "VersionDescription",
|
6961
|
+
# configuration: {
|
6962
|
+
# data_color_palette: {
|
6963
|
+
# colors: ["HexColor"],
|
6964
|
+
# min_max_gradient: ["HexColor"],
|
6965
|
+
# empty_fill_color: "HexColor",
|
6966
|
+
# },
|
6967
|
+
# ui_color_palette: {
|
6968
|
+
# primary_foreground: "HexColor",
|
6969
|
+
# primary_background: "HexColor",
|
6970
|
+
# secondary_foreground: "HexColor",
|
6971
|
+
# secondary_background: "HexColor",
|
6972
|
+
# accent: "HexColor",
|
6973
|
+
# accent_foreground: "HexColor",
|
6974
|
+
# danger: "HexColor",
|
6975
|
+
# danger_foreground: "HexColor",
|
6976
|
+
# warning: "HexColor",
|
6977
|
+
# warning_foreground: "HexColor",
|
6978
|
+
# success: "HexColor",
|
6979
|
+
# success_foreground: "HexColor",
|
6980
|
+
# dimension: "HexColor",
|
6981
|
+
# dimension_foreground: "HexColor",
|
6982
|
+
# measure: "HexColor",
|
6983
|
+
# measure_foreground: "HexColor",
|
6984
|
+
# },
|
6985
|
+
# sheet: {
|
6986
|
+
# tile: {
|
6987
|
+
# border: {
|
6988
|
+
# show: false,
|
6989
|
+
# },
|
6990
|
+
# },
|
6991
|
+
# tile_layout: {
|
6992
|
+
# gutter: {
|
6993
|
+
# show: false,
|
6994
|
+
# },
|
6995
|
+
# margin: {
|
6996
|
+
# show: false,
|
6997
|
+
# },
|
6998
|
+
# },
|
6999
|
+
# },
|
7000
|
+
# },
|
7001
|
+
# })
|
7002
|
+
#
|
7003
|
+
# @example Response structure
|
7004
|
+
#
|
7005
|
+
# resp.theme_id #=> String
|
7006
|
+
# resp.arn #=> String
|
7007
|
+
# resp.version_arn #=> String
|
7008
|
+
# resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
7009
|
+
# resp.status #=> Integer
|
7010
|
+
# resp.request_id #=> String
|
7011
|
+
#
|
7012
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateTheme AWS API Documentation
|
7013
|
+
#
|
7014
|
+
# @overload update_theme(params = {})
|
7015
|
+
# @param [Hash] params ({})
|
7016
|
+
def update_theme(params = {}, options = {})
|
7017
|
+
req = build_request(:update_theme, params)
|
7018
|
+
req.send_request(options)
|
7019
|
+
end
|
7020
|
+
|
7021
|
+
# Updates an alias of a theme.
|
7022
|
+
#
|
7023
|
+
# @option params [required, String] :aws_account_id
|
7024
|
+
# The ID of the AWS account that contains the theme alias that you're
|
7025
|
+
# updating.
|
7026
|
+
#
|
7027
|
+
# @option params [required, String] :theme_id
|
7028
|
+
# The ID for the theme.
|
7029
|
+
#
|
7030
|
+
# @option params [required, String] :alias_name
|
7031
|
+
# The name of the theme alias that you want to update.
|
7032
|
+
#
|
7033
|
+
# @option params [required, Integer] :theme_version_number
|
7034
|
+
# The version number of the theme that the alias should reference.
|
7035
|
+
#
|
7036
|
+
# @return [Types::UpdateThemeAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7037
|
+
#
|
7038
|
+
# * {Types::UpdateThemeAliasResponse#theme_alias #theme_alias} => Types::ThemeAlias
|
7039
|
+
# * {Types::UpdateThemeAliasResponse#status #status} => Integer
|
7040
|
+
# * {Types::UpdateThemeAliasResponse#request_id #request_id} => String
|
7041
|
+
#
|
7042
|
+
# @example Request syntax with placeholder values
|
7043
|
+
#
|
7044
|
+
# resp = client.update_theme_alias({
|
7045
|
+
# aws_account_id: "AwsAccountId", # required
|
7046
|
+
# theme_id: "RestrictiveResourceId", # required
|
7047
|
+
# alias_name: "AliasName", # required
|
7048
|
+
# theme_version_number: 1, # required
|
7049
|
+
# })
|
7050
|
+
#
|
7051
|
+
# @example Response structure
|
7052
|
+
#
|
7053
|
+
# resp.theme_alias.arn #=> String
|
7054
|
+
# resp.theme_alias.alias_name #=> String
|
7055
|
+
# resp.theme_alias.theme_version_number #=> Integer
|
7056
|
+
# resp.status #=> Integer
|
7057
|
+
# resp.request_id #=> String
|
7058
|
+
#
|
7059
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateThemeAlias AWS API Documentation
|
7060
|
+
#
|
7061
|
+
# @overload update_theme_alias(params = {})
|
7062
|
+
# @param [Hash] params ({})
|
7063
|
+
def update_theme_alias(params = {}, options = {})
|
7064
|
+
req = build_request(:update_theme_alias, params)
|
7065
|
+
req.send_request(options)
|
7066
|
+
end
|
7067
|
+
|
7068
|
+
# Updates the resource permissions for a theme. Permissions apply to the
|
7069
|
+
# action to grant or revoke permissions on, for example
|
7070
|
+
# `"quicksight:DescribeTheme"`.
|
7071
|
+
#
|
7072
|
+
# Theme permissions apply in groupings. Valid groupings include the
|
7073
|
+
# following for the three levels of permissions, which are user, owner,
|
7074
|
+
# or no permissions:
|
7075
|
+
#
|
7076
|
+
# * User
|
7077
|
+
#
|
7078
|
+
# * `"quicksight:DescribeTheme"`
|
7079
|
+
#
|
7080
|
+
# * `"quicksight:DescribeThemeAlias"`
|
7081
|
+
#
|
7082
|
+
# * `"quicksight:ListThemeAliases"`
|
7083
|
+
#
|
7084
|
+
# * `"quicksight:ListThemeVersions"`
|
7085
|
+
#
|
7086
|
+
# * Owner
|
7087
|
+
#
|
7088
|
+
# * `"quicksight:DescribeTheme"`
|
7089
|
+
#
|
7090
|
+
# * `"quicksight:DescribeThemeAlias"`
|
7091
|
+
#
|
7092
|
+
# * `"quicksight:ListThemeAliases"`
|
7093
|
+
#
|
7094
|
+
# * `"quicksight:ListThemeVersions"`
|
7095
|
+
#
|
7096
|
+
# * `"quicksight:DeleteTheme"`
|
7097
|
+
#
|
7098
|
+
# * `"quicksight:UpdateTheme"`
|
7099
|
+
#
|
7100
|
+
# * `"quicksight:CreateThemeAlias"`
|
7101
|
+
#
|
7102
|
+
# * `"quicksight:DeleteThemeAlias"`
|
7103
|
+
#
|
7104
|
+
# * `"quicksight:UpdateThemeAlias"`
|
7105
|
+
#
|
7106
|
+
# * `"quicksight:UpdateThemePermissions"`
|
7107
|
+
#
|
7108
|
+
# * `"quicksight:DescribeThemePermissions"`
|
7109
|
+
#
|
7110
|
+
# * To specify no permissions, omit the permissions list.
|
7111
|
+
#
|
7112
|
+
# @option params [required, String] :aws_account_id
|
7113
|
+
# The ID of the AWS account that contains the theme.
|
7114
|
+
#
|
7115
|
+
# @option params [required, String] :theme_id
|
7116
|
+
# The ID for the theme.
|
7117
|
+
#
|
7118
|
+
# @option params [Array<Types::ResourcePermission>] :grant_permissions
|
7119
|
+
# A list of resource permissions to be granted for the theme.
|
7120
|
+
#
|
7121
|
+
# @option params [Array<Types::ResourcePermission>] :revoke_permissions
|
7122
|
+
# A list of resource permissions to be revoked from the theme.
|
7123
|
+
#
|
7124
|
+
# @return [Types::UpdateThemePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7125
|
+
#
|
7126
|
+
# * {Types::UpdateThemePermissionsResponse#theme_id #theme_id} => String
|
7127
|
+
# * {Types::UpdateThemePermissionsResponse#theme_arn #theme_arn} => String
|
7128
|
+
# * {Types::UpdateThemePermissionsResponse#permissions #permissions} => Array<Types::ResourcePermission>
|
7129
|
+
# * {Types::UpdateThemePermissionsResponse#request_id #request_id} => String
|
7130
|
+
# * {Types::UpdateThemePermissionsResponse#status #status} => Integer
|
7131
|
+
#
|
7132
|
+
# @example Request syntax with placeholder values
|
7133
|
+
#
|
7134
|
+
# resp = client.update_theme_permissions({
|
7135
|
+
# aws_account_id: "AwsAccountId", # required
|
7136
|
+
# theme_id: "RestrictiveResourceId", # required
|
7137
|
+
# grant_permissions: [
|
7138
|
+
# {
|
7139
|
+
# principal: "Principal", # required
|
7140
|
+
# actions: ["String"], # required
|
7141
|
+
# },
|
7142
|
+
# ],
|
7143
|
+
# revoke_permissions: [
|
7144
|
+
# {
|
7145
|
+
# principal: "Principal", # required
|
7146
|
+
# actions: ["String"], # required
|
7147
|
+
# },
|
7148
|
+
# ],
|
7149
|
+
# })
|
7150
|
+
#
|
7151
|
+
# @example Response structure
|
7152
|
+
#
|
7153
|
+
# resp.theme_id #=> String
|
7154
|
+
# resp.theme_arn #=> String
|
7155
|
+
# resp.permissions #=> Array
|
7156
|
+
# resp.permissions[0].principal #=> String
|
7157
|
+
# resp.permissions[0].actions #=> Array
|
7158
|
+
# resp.permissions[0].actions[0] #=> String
|
7159
|
+
# resp.request_id #=> String
|
7160
|
+
# resp.status #=> Integer
|
7161
|
+
#
|
7162
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateThemePermissions AWS API Documentation
|
7163
|
+
#
|
7164
|
+
# @overload update_theme_permissions(params = {})
|
7165
|
+
# @param [Hash] params ({})
|
7166
|
+
def update_theme_permissions(params = {}, options = {})
|
7167
|
+
req = build_request(:update_theme_permissions, params)
|
7168
|
+
req.send_request(options)
|
7169
|
+
end
|
7170
|
+
|
4961
7171
|
# Updates an Amazon QuickSight user.
|
4962
7172
|
#
|
4963
7173
|
# @option params [required, String] :user_name
|
@@ -4974,8 +7184,8 @@ module Aws::QuickSight
|
|
4974
7184
|
# The email address of the user that you want to update.
|
4975
7185
|
#
|
4976
7186
|
# @option params [required, String] :role
|
4977
|
-
# The Amazon QuickSight role of the user. The
|
4978
|
-
#
|
7187
|
+
# The Amazon QuickSight role of the user. The role can be one of the
|
7188
|
+
# following default security cohorts:
|
4979
7189
|
#
|
4980
7190
|
# * `READER`\: A user who has read-only access to dashboards.
|
4981
7191
|
#
|
@@ -4985,6 +7195,45 @@ module Aws::QuickSight
|
|
4985
7195
|
# * `ADMIN`\: A user who is an author, who can also manage Amazon
|
4986
7196
|
# QuickSight settings.
|
4987
7197
|
#
|
7198
|
+
# The name of the QuickSight role is invisible to the user except for
|
7199
|
+
# the console screens dealing with permissions.
|
7200
|
+
#
|
7201
|
+
# @option params [String] :custom_permissions_name
|
7202
|
+
# (Enterprise edition only) The name of the custom permissions profile
|
7203
|
+
# that you want to assign to this user. Customized permissions allows
|
7204
|
+
# you to control a user's access by restricting access the following
|
7205
|
+
# operations:
|
7206
|
+
#
|
7207
|
+
# * Create and update data sources
|
7208
|
+
#
|
7209
|
+
# * Create and update datasets
|
7210
|
+
#
|
7211
|
+
# * Create and update email reports
|
7212
|
+
#
|
7213
|
+
# * Subscribe to email reports
|
7214
|
+
#
|
7215
|
+
# A set of custom permissions includes any combination of these
|
7216
|
+
# restrictions. Currently, you need to create the profile names for
|
7217
|
+
# custom permission sets by using the QuickSight console. Then, you use
|
7218
|
+
# the `RegisterUser` API operation to assign the named set of
|
7219
|
+
# permissions to a QuickSight user.
|
7220
|
+
#
|
7221
|
+
# QuickSight custom permissions are applied through IAM policies.
|
7222
|
+
# Therefore, they override the permissions typically granted by
|
7223
|
+
# assigning QuickSight users to one of the default security cohorts in
|
7224
|
+
# QuickSight (admin, author, reader).
|
7225
|
+
#
|
7226
|
+
# This feature is available only to QuickSight Enterprise edition
|
7227
|
+
# subscriptions that use SAML 2.0-Based Federation for Single Sign-On
|
7228
|
+
# (SSO).
|
7229
|
+
#
|
7230
|
+
# @option params [Boolean] :unapply_custom_permissions
|
7231
|
+
# A flag that you use to indicate that you want to remove all custom
|
7232
|
+
# permissions from this user. Using this parameter resets the user to
|
7233
|
+
# the state it was in before a custom permissions profile was applied.
|
7234
|
+
# This parameter defaults to NULL and it doesn't accept any other
|
7235
|
+
# value.
|
7236
|
+
#
|
4988
7237
|
# @return [Types::UpdateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4989
7238
|
#
|
4990
7239
|
# * {Types::UpdateUserResponse#user #user} => Types::User
|
@@ -4999,6 +7248,8 @@ module Aws::QuickSight
|
|
4999
7248
|
# namespace: "Namespace", # required
|
5000
7249
|
# email: "String", # required
|
5001
7250
|
# role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER
|
7251
|
+
# custom_permissions_name: "RoleName",
|
7252
|
+
# unapply_custom_permissions: false,
|
5002
7253
|
# })
|
5003
7254
|
#
|
5004
7255
|
# @example Response structure
|
@@ -5010,6 +7261,7 @@ module Aws::QuickSight
|
|
5010
7261
|
# resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
|
5011
7262
|
# resp.user.active #=> Boolean
|
5012
7263
|
# resp.user.principal_id #=> String
|
7264
|
+
# resp.user.custom_permissions_name #=> String
|
5013
7265
|
# resp.request_id #=> String
|
5014
7266
|
# resp.status #=> Integer
|
5015
7267
|
#
|
@@ -5035,7 +7287,7 @@ module Aws::QuickSight
|
|
5035
7287
|
params: params,
|
5036
7288
|
config: config)
|
5037
7289
|
context[:gem_name] = 'aws-sdk-quicksight'
|
5038
|
-
context[:gem_version] = '1.
|
7290
|
+
context[:gem_version] = '1.29.0'
|
5039
7291
|
Seahorse::Client::Request.new(handlers, context)
|
5040
7292
|
end
|
5041
7293
|
|