aws-sdk-quicksight 1.70.0 → 1.71.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/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight/client.rb +231 -11
- data/lib/aws-sdk-quicksight/client_api.rb +148 -0
- data/lib/aws-sdk-quicksight/endpoint_parameters.rb +3 -0
- data/lib/aws-sdk-quicksight/endpoint_provider.rb +75 -75
- data/lib/aws-sdk-quicksight/endpoints.rb +42 -0
- data/lib/aws-sdk-quicksight/errors.rb +21 -0
- data/lib/aws-sdk-quicksight/plugins/endpoints.rb +6 -0
- data/lib/aws-sdk-quicksight/types.rb +712 -27
- data/lib/aws-sdk-quicksight.rb +1 -1
- metadata +2 -2
@@ -145,6 +145,14 @@ module Aws::QuickSight
|
|
145
145
|
# [1]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdatePublicSharingSettings.html
|
146
146
|
# @return [Boolean]
|
147
147
|
#
|
148
|
+
# @!attribute [rw] termination_protection_enabled
|
149
|
+
# A boolean value that determines whether or not an Amazon QuickSight
|
150
|
+
# account can be deleted. A `True` value doesn't allow the account to
|
151
|
+
# be deleted and results in an error message if a user tries to make a
|
152
|
+
# `DeleteAccountSubsctiption` request. A `False` value will allow the
|
153
|
+
# ccount to be deleted.
|
154
|
+
# @return [Boolean]
|
155
|
+
#
|
148
156
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AccountSettings AWS API Documentation
|
149
157
|
#
|
150
158
|
class AccountSettings < Struct.new(
|
@@ -152,7 +160,8 @@ module Aws::QuickSight
|
|
152
160
|
:edition,
|
153
161
|
:default_namespace,
|
154
162
|
:notification_email,
|
155
|
-
:public_sharing_enabled
|
163
|
+
:public_sharing_enabled,
|
164
|
+
:termination_protection_enabled)
|
156
165
|
SENSITIVE = []
|
157
166
|
include Aws::Structure
|
158
167
|
end
|
@@ -324,19 +333,63 @@ module Aws::QuickSight
|
|
324
333
|
# data as a hash:
|
325
334
|
#
|
326
335
|
# {
|
327
|
-
# operator: "StringEquals", # accepts StringEquals
|
328
|
-
# name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER
|
336
|
+
# operator: "StringEquals", # accepts StringEquals, StringLike
|
337
|
+
# name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER, QUICKSIGHT_VIEWER_OR_OWNER, DIRECT_QUICKSIGHT_VIEWER_OR_OWNER, QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER, ANALYSIS_NAME
|
329
338
|
# value: "String",
|
330
339
|
# }
|
331
340
|
#
|
332
341
|
# @!attribute [rw] operator
|
333
342
|
# The comparison operator that you want to use as a filter, for
|
334
|
-
# example `"Operator": "StringEquals"`.
|
343
|
+
# example `"Operator": "StringEquals"`. Valid values are
|
344
|
+
# `"StringEquals"` and `"StringLike"`.
|
345
|
+
#
|
346
|
+
# If you set the operator value to `"StringEquals"`, you need to
|
347
|
+
# provide an ownership related filter in the `"NAME"` field and the
|
348
|
+
# arn of the user or group whose folders you want to search in the
|
349
|
+
# `"Value"` field. For example, `"Name":"DIRECT_QUICKSIGHT_OWNER",
|
350
|
+
# "Operator": "StringEquals", "Value":
|
351
|
+
# "arn:aws:quicksight:us-east-1:1:user/default/UserName1"`.
|
352
|
+
#
|
353
|
+
# If you set the value to `"StringLike"`, you need to provide the name
|
354
|
+
# of the folders you are searching for. For example,
|
355
|
+
# `"Name":"ANALYSIS_NAME", "Operator": "StringLike", "Value": "Test"`.
|
356
|
+
# The `"StringLike"` operator only supports the `NAME` value
|
357
|
+
# `ANALYSIS_NAME`.
|
335
358
|
# @return [String]
|
336
359
|
#
|
337
360
|
# @!attribute [rw] name
|
338
361
|
# The name of the value that you want to use as a filter, for example
|
339
|
-
# `"Name": "
|
362
|
+
# `"Name": "QUICKSIGHT_OWNER"`.
|
363
|
+
#
|
364
|
+
# Valid values are defined as follows:
|
365
|
+
#
|
366
|
+
# * `QUICKSIGHT_VIEWER_OR_OWNER`\: Provide an ARN of a user or group,
|
367
|
+
# and any analyses with that ARN listed as one of the analysis'
|
368
|
+
# owners or viewers are returned. Implicit permissions from folders
|
369
|
+
# or groups are considered.
|
370
|
+
#
|
371
|
+
# * `QUICKSIGHT_OWNER`\: Provide an ARN of a user or group, and any
|
372
|
+
# analyses with that ARN listed as one of the owners of the analyses
|
373
|
+
# are returned. Implicit permissions from folders or groups are
|
374
|
+
# considered.
|
375
|
+
#
|
376
|
+
# * `DIRECT_QUICKSIGHT_SOLE_OWNER`\: Provide an ARN of a user or
|
377
|
+
# group, and any analyses with that ARN listed as the only owner of
|
378
|
+
# the analysis are returned. Implicit permissions from folders or
|
379
|
+
# groups are not considered.
|
380
|
+
#
|
381
|
+
# * `DIRECT_QUICKSIGHT_OWNER`\: Provide an ARN of a user or group, and
|
382
|
+
# any analyses with that ARN listed as one of the owners of the
|
383
|
+
# analyses are returned. Implicit permissions from folders or groups
|
384
|
+
# are not considered.
|
385
|
+
#
|
386
|
+
# * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER`\: Provide an ARN of a user or
|
387
|
+
# group, and any analyses with that ARN listed as one of the owners
|
388
|
+
# or viewers of the analyses are returned. Implicit permissions from
|
389
|
+
# folders or groups are not considered.
|
390
|
+
#
|
391
|
+
# * `ANALYSIS_NAME`\: Any analyses whose names have a substring match
|
392
|
+
# to this value will be returned.
|
340
393
|
# @return [String]
|
341
394
|
#
|
342
395
|
# @!attribute [rw] value
|
@@ -534,6 +587,9 @@ module Aws::QuickSight
|
|
534
587
|
# visual_id: "RestrictiveResourceId", # required
|
535
588
|
# },
|
536
589
|
# },
|
590
|
+
# q_search_bar: {
|
591
|
+
# initial_topic_id: "RestrictiveResourceId", # required
|
592
|
+
# },
|
537
593
|
# }
|
538
594
|
#
|
539
595
|
# @!attribute [rw] dashboard
|
@@ -546,11 +602,44 @@ module Aws::QuickSight
|
|
546
602
|
# visuals.
|
547
603
|
# @return [Types::AnonymousUserDashboardVisualEmbeddingConfiguration]
|
548
604
|
#
|
605
|
+
# @!attribute [rw] q_search_bar
|
606
|
+
# The Q search bar that you want to use for anonymous user embedding.
|
607
|
+
# @return [Types::AnonymousUserQSearchBarEmbeddingConfiguration]
|
608
|
+
#
|
549
609
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnonymousUserEmbeddingExperienceConfiguration AWS API Documentation
|
550
610
|
#
|
551
611
|
class AnonymousUserEmbeddingExperienceConfiguration < Struct.new(
|
552
612
|
:dashboard,
|
553
|
-
:dashboard_visual
|
613
|
+
:dashboard_visual,
|
614
|
+
:q_search_bar)
|
615
|
+
SENSITIVE = []
|
616
|
+
include Aws::Structure
|
617
|
+
end
|
618
|
+
|
619
|
+
# The settings that you want to use with the Q search bar.
|
620
|
+
#
|
621
|
+
# @note When making an API call, you may pass AnonymousUserQSearchBarEmbeddingConfiguration
|
622
|
+
# data as a hash:
|
623
|
+
#
|
624
|
+
# {
|
625
|
+
# initial_topic_id: "RestrictiveResourceId", # required
|
626
|
+
# }
|
627
|
+
#
|
628
|
+
# @!attribute [rw] initial_topic_id
|
629
|
+
# The QuickSight Q topic ID of the topic that you want the anonymous
|
630
|
+
# user to see first. This ID is included in the output URL. When the
|
631
|
+
# URL in response is accessed, Amazon QuickSight renders the Q search
|
632
|
+
# bar with this topic pre-selected.
|
633
|
+
#
|
634
|
+
# The Amazon Resource Name (ARN) of this Q topic must be included in
|
635
|
+
# the `AuthorizedResourceArns` parameter. Otherwise, the request will
|
636
|
+
# fail with `InvalidParameterValueException`.
|
637
|
+
# @return [String]
|
638
|
+
#
|
639
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnonymousUserQSearchBarEmbeddingConfiguration AWS API Documentation
|
640
|
+
#
|
641
|
+
class AnonymousUserQSearchBarEmbeddingConfiguration < Struct.new(
|
642
|
+
:initial_topic_id)
|
554
643
|
SENSITIVE = []
|
555
644
|
include Aws::Structure
|
556
645
|
end
|
@@ -562,16 +651,28 @@ module Aws::QuickSight
|
|
562
651
|
#
|
563
652
|
# {
|
564
653
|
# work_group: "WorkGroup",
|
654
|
+
# role_arn: "RoleArn",
|
565
655
|
# }
|
566
656
|
#
|
567
657
|
# @!attribute [rw] work_group
|
568
658
|
# The workgroup that Amazon Athena uses.
|
569
659
|
# @return [String]
|
570
660
|
#
|
661
|
+
# @!attribute [rw] role_arn
|
662
|
+
# Use the `RoleArn` structure to override an account-wide role for a
|
663
|
+
# specific Athena data source. For example, say an account
|
664
|
+
# administrator has turned off all Athena access with an account-wide
|
665
|
+
# role. The administrator can then use `RoleArn` to bypass the
|
666
|
+
# account-wide role and allow Athena access for the single Athena data
|
667
|
+
# source that is specified in the structure, even if the account-wide
|
668
|
+
# role forbidding Athena access is still active.
|
669
|
+
# @return [String]
|
670
|
+
#
|
571
671
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AthenaParameters AWS API Documentation
|
572
672
|
#
|
573
673
|
class AthenaParameters < Struct.new(
|
574
|
-
:work_group
|
674
|
+
:work_group,
|
675
|
+
:role_arn)
|
575
676
|
SENSITIVE = []
|
576
677
|
include Aws::Structure
|
577
678
|
end
|
@@ -1998,13 +2099,14 @@ module Aws::QuickSight
|
|
1998
2099
|
# aws_account_id: "AwsAccountId", # required
|
1999
2100
|
# data_source_id: "ResourceId", # required
|
2000
2101
|
# name: "ResourceName", # required
|
2001
|
-
# type: "ADOBE_ANALYTICS", # required, accepts ADOBE_ANALYTICS, AMAZON_ELASTICSEARCH, ATHENA, AURORA, AURORA_POSTGRESQL, AWS_IOT_ANALYTICS, GITHUB, JIRA, MARIADB, MYSQL, ORACLE, POSTGRESQL, PRESTO, REDSHIFT, S3, SALESFORCE, SERVICENOW, SNOWFLAKE, SPARK, SQLSERVER, TERADATA, TWITTER, TIMESTREAM, AMAZON_OPENSEARCH, EXASOL
|
2102
|
+
# type: "ADOBE_ANALYTICS", # required, accepts ADOBE_ANALYTICS, AMAZON_ELASTICSEARCH, ATHENA, AURORA, AURORA_POSTGRESQL, AWS_IOT_ANALYTICS, GITHUB, JIRA, MARIADB, MYSQL, ORACLE, POSTGRESQL, PRESTO, REDSHIFT, S3, SALESFORCE, SERVICENOW, SNOWFLAKE, SPARK, SQLSERVER, TERADATA, TWITTER, TIMESTREAM, AMAZON_OPENSEARCH, EXASOL, DATABRICKS
|
2002
2103
|
# data_source_parameters: {
|
2003
2104
|
# amazon_elasticsearch_parameters: {
|
2004
2105
|
# domain: "Domain", # required
|
2005
2106
|
# },
|
2006
2107
|
# athena_parameters: {
|
2007
2108
|
# work_group: "WorkGroup",
|
2109
|
+
# role_arn: "RoleArn",
|
2008
2110
|
# },
|
2009
2111
|
# aurora_parameters: {
|
2010
2112
|
# host: "Host", # required
|
@@ -2096,6 +2198,11 @@ module Aws::QuickSight
|
|
2096
2198
|
# host: "Host", # required
|
2097
2199
|
# port: 1, # required
|
2098
2200
|
# },
|
2201
|
+
# databricks_parameters: {
|
2202
|
+
# host: "Host", # required
|
2203
|
+
# port: 1, # required
|
2204
|
+
# sql_endpoint_path: "SqlEndpointPath", # required
|
2205
|
+
# },
|
2099
2206
|
# },
|
2100
2207
|
# credentials: {
|
2101
2208
|
# credential_pair: {
|
@@ -2108,6 +2215,7 @@ module Aws::QuickSight
|
|
2108
2215
|
# },
|
2109
2216
|
# athena_parameters: {
|
2110
2217
|
# work_group: "WorkGroup",
|
2218
|
+
# role_arn: "RoleArn",
|
2111
2219
|
# },
|
2112
2220
|
# aurora_parameters: {
|
2113
2221
|
# host: "Host", # required
|
@@ -2199,6 +2307,11 @@ module Aws::QuickSight
|
|
2199
2307
|
# host: "Host", # required
|
2200
2308
|
# port: 1, # required
|
2201
2309
|
# },
|
2310
|
+
# databricks_parameters: {
|
2311
|
+
# host: "Host", # required
|
2312
|
+
# port: 1, # required
|
2313
|
+
# sql_endpoint_path: "SqlEndpointPath", # required
|
2314
|
+
# },
|
2202
2315
|
# },
|
2203
2316
|
# ],
|
2204
2317
|
# },
|
@@ -3325,6 +3438,7 @@ module Aws::QuickSight
|
|
3325
3438
|
# },
|
3326
3439
|
# athena_parameters: {
|
3327
3440
|
# work_group: "WorkGroup",
|
3441
|
+
# role_arn: "RoleArn",
|
3328
3442
|
# },
|
3329
3443
|
# aurora_parameters: {
|
3330
3444
|
# host: "Host", # required
|
@@ -3416,6 +3530,11 @@ module Aws::QuickSight
|
|
3416
3530
|
# host: "Host", # required
|
3417
3531
|
# port: 1, # required
|
3418
3532
|
# },
|
3533
|
+
# databricks_parameters: {
|
3534
|
+
# host: "Host", # required
|
3535
|
+
# port: 1, # required
|
3536
|
+
# sql_endpoint_path: "SqlEndpointPath", # required
|
3537
|
+
# },
|
3419
3538
|
# },
|
3420
3539
|
# ],
|
3421
3540
|
# }
|
@@ -3604,19 +3723,63 @@ module Aws::QuickSight
|
|
3604
3723
|
# data as a hash:
|
3605
3724
|
#
|
3606
3725
|
# {
|
3607
|
-
# operator: "StringEquals", # required, accepts StringEquals
|
3608
|
-
# name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER
|
3726
|
+
# operator: "StringEquals", # required, accepts StringEquals, StringLike
|
3727
|
+
# name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER, QUICKSIGHT_VIEWER_OR_OWNER, DIRECT_QUICKSIGHT_VIEWER_OR_OWNER, QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER, DASHBOARD_NAME
|
3609
3728
|
# value: "String",
|
3610
3729
|
# }
|
3611
3730
|
#
|
3612
3731
|
# @!attribute [rw] operator
|
3613
3732
|
# The comparison operator that you want to use as a filter, for
|
3614
|
-
# example
|
3733
|
+
# example `"Operator": "StringEquals"`. Valid values are
|
3734
|
+
# `"StringEquals"` and `"StringLike"`.
|
3735
|
+
#
|
3736
|
+
# If you set the operator value to `"StringEquals"`, you need to
|
3737
|
+
# provide an ownership related filter in the `"NAME"` field and the
|
3738
|
+
# arn of the user or group whose folders you want to search in the
|
3739
|
+
# `"Value"` field. For example, `"Name":"DIRECT_QUICKSIGHT_OWNER",
|
3740
|
+
# "Operator": "StringEquals", "Value":
|
3741
|
+
# "arn:aws:quicksight:us-east-1:1:user/default/UserName1"`.
|
3742
|
+
#
|
3743
|
+
# If you set the value to `"StringLike"`, you need to provide the name
|
3744
|
+
# of the folders you are searching for. For example,
|
3745
|
+
# `"Name":"DASHBOARD_NAME", "Operator": "StringLike", "Value":
|
3746
|
+
# "Test"`. The `"StringLike"` operator only supports the `NAME` value
|
3747
|
+
# `DASHBOARD_NAME`.
|
3615
3748
|
# @return [String]
|
3616
3749
|
#
|
3617
3750
|
# @!attribute [rw] name
|
3618
3751
|
# The name of the value that you want to use as a filter, for example,
|
3619
|
-
# `"Name": "
|
3752
|
+
# `"Name": "QUICKSIGHT_OWNER"`.
|
3753
|
+
#
|
3754
|
+
# Valid values are defined as follows:
|
3755
|
+
#
|
3756
|
+
# * `QUICKSIGHT_VIEWER_OR_OWNER`\: Provide an ARN of a user or group,
|
3757
|
+
# and any dashboards with that ARN listed as one of the
|
3758
|
+
# dashboards's owners or viewers are returned. Implicit permissions
|
3759
|
+
# from folders or groups are considered.
|
3760
|
+
#
|
3761
|
+
# * `QUICKSIGHT_OWNER`\: Provide an ARN of a user or group, and any
|
3762
|
+
# dashboards with that ARN listed as one of the owners of the
|
3763
|
+
# dashboards are returned. Implicit permissions from folders or
|
3764
|
+
# groups are considered.
|
3765
|
+
#
|
3766
|
+
# * `DIRECT_QUICKSIGHT_SOLE_OWNER`\: Provide an ARN of a user or
|
3767
|
+
# group, and any dashboards with that ARN listed as the only owner
|
3768
|
+
# of the dashboard are returned. Implicit permissions from folders
|
3769
|
+
# or groups are not considered.
|
3770
|
+
#
|
3771
|
+
# * `DIRECT_QUICKSIGHT_OWNER`\: Provide an ARN of a user or group, and
|
3772
|
+
# any dashboards with that ARN listed as one of the owners of the
|
3773
|
+
# dashboards are returned. Implicit permissions from folders or
|
3774
|
+
# groups are not considered.
|
3775
|
+
#
|
3776
|
+
# * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER`\: Provide an ARN of a user or
|
3777
|
+
# group, and any dashboards with that ARN listed as one of the
|
3778
|
+
# owners or viewers of the dashboards are returned. Implicit
|
3779
|
+
# permissions from folders or groups are not considered.
|
3780
|
+
#
|
3781
|
+
# * `DASHBOARD_NAME`\: Any dashboards whose names have a substring
|
3782
|
+
# match to this value will be returned.
|
3620
3783
|
# @return [String]
|
3621
3784
|
#
|
3622
3785
|
# @!attribute [rw] value
|
@@ -4094,6 +4257,87 @@ module Aws::QuickSight
|
|
4094
4257
|
include Aws::Structure
|
4095
4258
|
end
|
4096
4259
|
|
4260
|
+
# A filter that you apply when searching for datasets.
|
4261
|
+
#
|
4262
|
+
# @note When making an API call, you may pass DataSetSearchFilter
|
4263
|
+
# data as a hash:
|
4264
|
+
#
|
4265
|
+
# {
|
4266
|
+
# operator: "StringEquals", # required, accepts StringEquals, StringLike
|
4267
|
+
# name: "QUICKSIGHT_VIEWER_OR_OWNER", # required, accepts QUICKSIGHT_VIEWER_OR_OWNER, QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_VIEWER_OR_OWNER, DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER, DATASET_NAME
|
4268
|
+
# value: "String", # required
|
4269
|
+
# }
|
4270
|
+
#
|
4271
|
+
# @!attribute [rw] operator
|
4272
|
+
# The comparison operator that you want to use as a filter, for
|
4273
|
+
# example `"Operator": "StringEquals"`. Valid values are
|
4274
|
+
# `"StringEquals"` and `"StringLike"`.
|
4275
|
+
#
|
4276
|
+
# If you set the operator value to `"StringEquals"`, you need to
|
4277
|
+
# provide an ownership related filter in the `"NAME"` field and the
|
4278
|
+
# arn of the user or group whose datasets you want to search in the
|
4279
|
+
# `"Value"` field. For example, `"Name":"QUICKSIGHT_OWNER",
|
4280
|
+
# "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-
|
4281
|
+
# 1:1:user/default/UserName1"`.
|
4282
|
+
#
|
4283
|
+
# If you set the value to `"StringLike"`, you need to provide the name
|
4284
|
+
# of the datasets you are searching for. For example,
|
4285
|
+
# `"Name":"DATASET_NAME", "Operator": "StringLike", "Value": "Test"`.
|
4286
|
+
# The `"StringLike"` operator only supports the `NAME` value
|
4287
|
+
# `DATASET_NAME`.
|
4288
|
+
# @return [String]
|
4289
|
+
#
|
4290
|
+
# @!attribute [rw] name
|
4291
|
+
# The name of the value that you want to use as a filter, for example,
|
4292
|
+
# `"Name": "QUICKSIGHT_OWNER"`.
|
4293
|
+
#
|
4294
|
+
# Valid values are defined as follows:
|
4295
|
+
#
|
4296
|
+
# * `QUICKSIGHT_VIEWER_OR_OWNER`\: Provide an ARN of a user or group,
|
4297
|
+
# and any datasets with that ARN listed as one of the dataset owners
|
4298
|
+
# or viewers are returned. Implicit permissions from folders or
|
4299
|
+
# groups are considered.
|
4300
|
+
#
|
4301
|
+
# * `QUICKSIGHT_OWNER`\: Provide an ARN of a user or group, and any
|
4302
|
+
# datasets with that ARN listed as one of the owners of the dataset
|
4303
|
+
# are returned. Implicit permissions from folders or groups are
|
4304
|
+
# considered.
|
4305
|
+
#
|
4306
|
+
# * `DIRECT_QUICKSIGHT_SOLE_OWNER`\: Provide an ARN of a user or
|
4307
|
+
# group, and any datasets with that ARN listed as the only owner of
|
4308
|
+
# the dataset are returned. Implicit permissions from folders or
|
4309
|
+
# groups are not considered.
|
4310
|
+
#
|
4311
|
+
# * `DIRECT_QUICKSIGHT_OWNER`\: Provide an ARN of a user or group, and
|
4312
|
+
# any datasets with that ARN listed as one of the owners if the
|
4313
|
+
# dataset are returned. Implicit permissions from folders or groups
|
4314
|
+
# are not considered.
|
4315
|
+
#
|
4316
|
+
# * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER`\: Provide an ARN of a user or
|
4317
|
+
# group, and any datasets with that ARN listed as one of the owners
|
4318
|
+
# or viewers of the dataset are returned. Implicit permissions from
|
4319
|
+
# folders or groups are not considered.
|
4320
|
+
#
|
4321
|
+
# * `DATASET_NAME`\: Any datasets whose names have a substring match
|
4322
|
+
# to this value will be returned.
|
4323
|
+
# @return [String]
|
4324
|
+
#
|
4325
|
+
# @!attribute [rw] value
|
4326
|
+
# The value of the named item, in this case `QUICKSIGHT_OWNER`, that
|
4327
|
+
# you want to use as a filter, for example, `"Value":
|
4328
|
+
# "arn:aws:quicksight:us-east-1:1:user/default/UserName1"`.
|
4329
|
+
# @return [String]
|
4330
|
+
#
|
4331
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetSearchFilter AWS API Documentation
|
4332
|
+
#
|
4333
|
+
class DataSetSearchFilter < Struct.new(
|
4334
|
+
:operator,
|
4335
|
+
:name,
|
4336
|
+
:value)
|
4337
|
+
SENSITIVE = []
|
4338
|
+
include Aws::Structure
|
4339
|
+
end
|
4340
|
+
|
4097
4341
|
# Dataset summary.
|
4098
4342
|
#
|
4099
4343
|
# @!attribute [rw] arn
|
@@ -4290,6 +4534,7 @@ module Aws::QuickSight
|
|
4290
4534
|
# },
|
4291
4535
|
# athena_parameters: {
|
4292
4536
|
# work_group: "WorkGroup",
|
4537
|
+
# role_arn: "RoleArn",
|
4293
4538
|
# },
|
4294
4539
|
# aurora_parameters: {
|
4295
4540
|
# host: "Host", # required
|
@@ -4381,6 +4626,11 @@ module Aws::QuickSight
|
|
4381
4626
|
# host: "Host", # required
|
4382
4627
|
# port: 1, # required
|
4383
4628
|
# },
|
4629
|
+
# databricks_parameters: {
|
4630
|
+
# host: "Host", # required
|
4631
|
+
# port: 1, # required
|
4632
|
+
# sql_endpoint_path: "SqlEndpointPath", # required
|
4633
|
+
# },
|
4384
4634
|
# },
|
4385
4635
|
# ],
|
4386
4636
|
# },
|
@@ -4446,6 +4696,7 @@ module Aws::QuickSight
|
|
4446
4696
|
# },
|
4447
4697
|
# athena_parameters: {
|
4448
4698
|
# work_group: "WorkGroup",
|
4699
|
+
# role_arn: "RoleArn",
|
4449
4700
|
# },
|
4450
4701
|
# aurora_parameters: {
|
4451
4702
|
# host: "Host", # required
|
@@ -4537,6 +4788,11 @@ module Aws::QuickSight
|
|
4537
4788
|
# host: "Host", # required
|
4538
4789
|
# port: 1, # required
|
4539
4790
|
# },
|
4791
|
+
# databricks_parameters: {
|
4792
|
+
# host: "Host", # required
|
4793
|
+
# port: 1, # required
|
4794
|
+
# sql_endpoint_path: "SqlEndpointPath", # required
|
4795
|
+
# },
|
4540
4796
|
# }
|
4541
4797
|
#
|
4542
4798
|
# @!attribute [rw] amazon_elasticsearch_parameters
|
@@ -4627,6 +4883,11 @@ module Aws::QuickSight
|
|
4627
4883
|
# The parameters for Exasol.
|
4628
4884
|
# @return [Types::ExasolParameters]
|
4629
4885
|
#
|
4886
|
+
# @!attribute [rw] databricks_parameters
|
4887
|
+
# The required parameters that are needed to connect to a Databricks
|
4888
|
+
# data source.
|
4889
|
+
# @return [Types::DatabricksParameters]
|
4890
|
+
#
|
4630
4891
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSourceParameters AWS API Documentation
|
4631
4892
|
#
|
4632
4893
|
class DataSourceParameters < Struct.new(
|
@@ -4651,7 +4912,154 @@ module Aws::QuickSight
|
|
4651
4912
|
:teradata_parameters,
|
4652
4913
|
:twitter_parameters,
|
4653
4914
|
:amazon_open_search_parameters,
|
4654
|
-
:exasol_parameters
|
4915
|
+
:exasol_parameters,
|
4916
|
+
:databricks_parameters)
|
4917
|
+
SENSITIVE = []
|
4918
|
+
include Aws::Structure
|
4919
|
+
end
|
4920
|
+
|
4921
|
+
# A filter that you apply when searching for data sources.
|
4922
|
+
#
|
4923
|
+
# @note When making an API call, you may pass DataSourceSearchFilter
|
4924
|
+
# data as a hash:
|
4925
|
+
#
|
4926
|
+
# {
|
4927
|
+
# operator: "StringEquals", # required, accepts StringEquals, StringLike
|
4928
|
+
# name: "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER", # required, accepts DIRECT_QUICKSIGHT_VIEWER_OR_OWNER, DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER, DATASOURCE_NAME
|
4929
|
+
# value: "String", # required
|
4930
|
+
# }
|
4931
|
+
#
|
4932
|
+
# @!attribute [rw] operator
|
4933
|
+
# The comparison operator that you want to use as a filter, for
|
4934
|
+
# example `"Operator": "StringEquals"`. Valid values are
|
4935
|
+
# `"StringEquals"` and `"StringLike"`.
|
4936
|
+
#
|
4937
|
+
# If you set the operator value to `"StringEquals"`, you need to
|
4938
|
+
# provide an ownership related filter in the `"NAME"` field and the
|
4939
|
+
# arn of the user or group whose data sources you want to search in
|
4940
|
+
# the `"Value"` field. For example, `"Name":"DIRECT_QUICKSIGHT_OWNER",
|
4941
|
+
# "Operator": "StringEquals", "Value":
|
4942
|
+
# "arn:aws:quicksight:us-east-1:1:user/default/UserName1"`.
|
4943
|
+
#
|
4944
|
+
# If you set the value to `"StringLike"`, you need to provide the name
|
4945
|
+
# of the data sources you are searching for. For example,
|
4946
|
+
# `"Name":"DATASOURCE_NAME", "Operator": "StringLike", "Value":
|
4947
|
+
# "Test"`. The `"StringLike"` operator only supports the `NAME` value
|
4948
|
+
# `DATASOURCE_NAME`.
|
4949
|
+
# @return [String]
|
4950
|
+
#
|
4951
|
+
# @!attribute [rw] name
|
4952
|
+
# The name of the value that you want to use as a filter, for example,
|
4953
|
+
# `"Name": "DIRECT_QUICKSIGHT_OWNER"`.
|
4954
|
+
#
|
4955
|
+
# Valid values are defined as follows:
|
4956
|
+
#
|
4957
|
+
# * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER`\: Provide an ARN of a user or
|
4958
|
+
# group, and any data sources with that ARN listed as one of the
|
4959
|
+
# owners or viewers of the data sources are returned. Implicit
|
4960
|
+
# permissions from folders or groups are not considered.
|
4961
|
+
#
|
4962
|
+
# * `DIRECT_QUICKSIGHT_OWNER`\: Provide an ARN of a user or group, and
|
4963
|
+
# any data sources with that ARN listed as one of the owners if the
|
4964
|
+
# data source are returned. Implicit permissions from folders or
|
4965
|
+
# groups are not considered.
|
4966
|
+
#
|
4967
|
+
# * `DIRECT_QUICKSIGHT_SOLE_OWNER`\: Provide an ARN of a user or
|
4968
|
+
# group, and any data sources with that ARN listed as the only owner
|
4969
|
+
# of the data source are returned. Implicit permissions from folders
|
4970
|
+
# or groups are not considered.
|
4971
|
+
#
|
4972
|
+
# * `DATASOURCE_NAME`\: Any data sources whose names have a substring
|
4973
|
+
# match to the provided value are returned.
|
4974
|
+
# @return [String]
|
4975
|
+
#
|
4976
|
+
# @!attribute [rw] value
|
4977
|
+
# The value of the named item, for example `DIRECT_QUICKSIGHT_OWNER`,
|
4978
|
+
# that you want to use as a filter, for example, `"Value":
|
4979
|
+
# "arn:aws:quicksight:us-east-1:1:user/default/UserName1"`.
|
4980
|
+
# @return [String]
|
4981
|
+
#
|
4982
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSourceSearchFilter AWS API Documentation
|
4983
|
+
#
|
4984
|
+
class DataSourceSearchFilter < Struct.new(
|
4985
|
+
:operator,
|
4986
|
+
:name,
|
4987
|
+
:value)
|
4988
|
+
SENSITIVE = []
|
4989
|
+
include Aws::Structure
|
4990
|
+
end
|
4991
|
+
|
4992
|
+
# A `DataSourceSummary` object that returns a summary of a data source.
|
4993
|
+
#
|
4994
|
+
# @!attribute [rw] arn
|
4995
|
+
# The arn of the datasource.
|
4996
|
+
# @return [String]
|
4997
|
+
#
|
4998
|
+
# @!attribute [rw] data_source_id
|
4999
|
+
# The unique ID of the data source.
|
5000
|
+
# @return [String]
|
5001
|
+
#
|
5002
|
+
# @!attribute [rw] name
|
5003
|
+
# The name of the data source.
|
5004
|
+
# @return [String]
|
5005
|
+
#
|
5006
|
+
# @!attribute [rw] type
|
5007
|
+
# The type of the data source.
|
5008
|
+
# @return [String]
|
5009
|
+
#
|
5010
|
+
# @!attribute [rw] created_time
|
5011
|
+
# The date and time that the data source was created. This value is
|
5012
|
+
# expressed in MM-DD-YYYY HH:MM:SS format.
|
5013
|
+
# @return [Time]
|
5014
|
+
#
|
5015
|
+
# @!attribute [rw] last_updated_time
|
5016
|
+
# The date and time the data source was last updated. This value is
|
5017
|
+
# expressed in MM-DD-YYYY HH:MM:SS format.
|
5018
|
+
# @return [Time]
|
5019
|
+
#
|
5020
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSourceSummary AWS API Documentation
|
5021
|
+
#
|
5022
|
+
class DataSourceSummary < Struct.new(
|
5023
|
+
:arn,
|
5024
|
+
:data_source_id,
|
5025
|
+
:name,
|
5026
|
+
:type,
|
5027
|
+
:created_time,
|
5028
|
+
:last_updated_time)
|
5029
|
+
SENSITIVE = []
|
5030
|
+
include Aws::Structure
|
5031
|
+
end
|
5032
|
+
|
5033
|
+
# The required parameters that are needed to connect to a Databricks
|
5034
|
+
# data source.
|
5035
|
+
#
|
5036
|
+
# @note When making an API call, you may pass DatabricksParameters
|
5037
|
+
# data as a hash:
|
5038
|
+
#
|
5039
|
+
# {
|
5040
|
+
# host: "Host", # required
|
5041
|
+
# port: 1, # required
|
5042
|
+
# sql_endpoint_path: "SqlEndpointPath", # required
|
5043
|
+
# }
|
5044
|
+
#
|
5045
|
+
# @!attribute [rw] host
|
5046
|
+
# The host name of the Databricks data source.
|
5047
|
+
# @return [String]
|
5048
|
+
#
|
5049
|
+
# @!attribute [rw] port
|
5050
|
+
# The port for the Databricks data source.
|
5051
|
+
# @return [Integer]
|
5052
|
+
#
|
5053
|
+
# @!attribute [rw] sql_endpoint_path
|
5054
|
+
# The HTTP path of the Databricks data source.
|
5055
|
+
# @return [String]
|
5056
|
+
#
|
5057
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DatabricksParameters AWS API Documentation
|
5058
|
+
#
|
5059
|
+
class DatabricksParameters < Struct.new(
|
5060
|
+
:host,
|
5061
|
+
:port,
|
5062
|
+
:sql_endpoint_path)
|
4655
5063
|
SENSITIVE = []
|
4656
5064
|
include Aws::Structure
|
4657
5065
|
end
|
@@ -4755,6 +5163,43 @@ module Aws::QuickSight
|
|
4755
5163
|
include Aws::Structure
|
4756
5164
|
end
|
4757
5165
|
|
5166
|
+
# @note When making an API call, you may pass DeleteAccountSubscriptionRequest
|
5167
|
+
# data as a hash:
|
5168
|
+
#
|
5169
|
+
# {
|
5170
|
+
# aws_account_id: "AwsAccountId", # required
|
5171
|
+
# }
|
5172
|
+
#
|
5173
|
+
# @!attribute [rw] aws_account_id
|
5174
|
+
# The Amazon Web Services account ID of the account that you want to
|
5175
|
+
# delete.
|
5176
|
+
# @return [String]
|
5177
|
+
#
|
5178
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAccountSubscriptionRequest AWS API Documentation
|
5179
|
+
#
|
5180
|
+
class DeleteAccountSubscriptionRequest < Struct.new(
|
5181
|
+
:aws_account_id)
|
5182
|
+
SENSITIVE = []
|
5183
|
+
include Aws::Structure
|
5184
|
+
end
|
5185
|
+
|
5186
|
+
# @!attribute [rw] request_id
|
5187
|
+
# The Amazon Web Services request ID for this operation.
|
5188
|
+
# @return [String]
|
5189
|
+
#
|
5190
|
+
# @!attribute [rw] status
|
5191
|
+
# The HTTP status of the request.
|
5192
|
+
# @return [Integer]
|
5193
|
+
#
|
5194
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAccountSubscriptionResponse AWS API Documentation
|
5195
|
+
#
|
5196
|
+
class DeleteAccountSubscriptionResponse < Struct.new(
|
5197
|
+
:request_id,
|
5198
|
+
:status)
|
5199
|
+
SENSITIVE = []
|
5200
|
+
include Aws::Structure
|
5201
|
+
end
|
5202
|
+
|
4758
5203
|
# @note When making an API call, you may pass DeleteAnalysisRequest
|
4759
5204
|
# data as a hash:
|
4760
5205
|
#
|
@@ -7415,25 +7860,74 @@ module Aws::QuickSight
|
|
7415
7860
|
include Aws::Structure
|
7416
7861
|
end
|
7417
7862
|
|
7418
|
-
# A filter to use to search
|
7863
|
+
# A filter to use to search an Amazon QuickSight folder.
|
7419
7864
|
#
|
7420
7865
|
# @note When making an API call, you may pass FolderSearchFilter
|
7421
7866
|
# data as a hash:
|
7422
7867
|
#
|
7423
7868
|
# {
|
7424
|
-
# operator: "StringEquals", # accepts StringEquals
|
7425
|
-
# name: "PARENT_FOLDER_ARN", # accepts PARENT_FOLDER_ARN
|
7869
|
+
# operator: "StringEquals", # accepts StringEquals, StringLike
|
7870
|
+
# name: "PARENT_FOLDER_ARN", # accepts PARENT_FOLDER_ARN, DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER, DIRECT_QUICKSIGHT_VIEWER_OR_OWNER, QUICKSIGHT_OWNER, QUICKSIGHT_VIEWER_OR_OWNER, FOLDER_NAME
|
7426
7871
|
# value: "String",
|
7427
7872
|
# }
|
7428
7873
|
#
|
7429
7874
|
# @!attribute [rw] operator
|
7430
|
-
# The comparison operator that you want to use
|
7431
|
-
# example
|
7875
|
+
# The comparison operator that you want to use as a filter, for
|
7876
|
+
# example `"Operator": "StringEquals"`. Valid values are
|
7877
|
+
# `"StringEquals"` and `"StringLike"`.
|
7878
|
+
#
|
7879
|
+
# If you set the operator value to `"StringEquals"`, you need to
|
7880
|
+
# provide an ownership related filter in the `"NAME"` field and the
|
7881
|
+
# arn of the user or group whose folders you want to search in the
|
7882
|
+
# `"Value"` field. For example, `"Name":"DIRECT_QUICKSIGHT_OWNER",
|
7883
|
+
# "Operator": "StringEquals", "Value":
|
7884
|
+
# "arn:aws:quicksight:us-east-1:1:user/default/UserName1"`.
|
7885
|
+
#
|
7886
|
+
# If you set the value to `"StringLike"`, you need to provide the name
|
7887
|
+
# of the folders you are searching for. For example,
|
7888
|
+
# `"Name":"FOLDER_NAME", "Operator": "StringLike", "Value": "Test"`.
|
7889
|
+
# The `"StringLike"` operator only supports the `NAME` value
|
7890
|
+
# `FOLDER_NAME`.
|
7432
7891
|
# @return [String]
|
7433
7892
|
#
|
7434
7893
|
# @!attribute [rw] name
|
7435
7894
|
# The name of a value that you want to use in the filter. For example,
|
7436
|
-
# `"Name": "
|
7895
|
+
# `"Name": "QUICKSIGHT_OWNER"`.
|
7896
|
+
#
|
7897
|
+
# Valid values are defined as follows:
|
7898
|
+
#
|
7899
|
+
# * `QUICKSIGHT_VIEWER_OR_OWNER`\: Provide an ARN of a user or group,
|
7900
|
+
# and any folders with that ARN listed as one of the folder's
|
7901
|
+
# owners or viewers are returned. Implicit permissions from folders
|
7902
|
+
# or groups are considered.
|
7903
|
+
#
|
7904
|
+
# * `QUICKSIGHT_OWNER`\: Provide an ARN of a user or group, and any
|
7905
|
+
# folders with that ARN listed as one of the owners of the folders
|
7906
|
+
# are returned. Implicit permissions from folders or groups are
|
7907
|
+
# considered.
|
7908
|
+
#
|
7909
|
+
# * `DIRECT_QUICKSIGHT_SOLE_OWNER`\: Provide an ARN of a user or
|
7910
|
+
# group, and any folders with that ARN listed as the only owner of
|
7911
|
+
# the folder are returned. Implicit permissions from folders or
|
7912
|
+
# groups are not considered.
|
7913
|
+
#
|
7914
|
+
# * `DIRECT_QUICKSIGHT_OWNER`\: Provide an ARN of a user or group, and
|
7915
|
+
# any folders with that ARN listed as one of the owners of the
|
7916
|
+
# folders are returned. Implicit permissions from folders or groups
|
7917
|
+
# are not considered.
|
7918
|
+
#
|
7919
|
+
# * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER`\: Provide an ARN of a user or
|
7920
|
+
# group, and any folders with that ARN listed as one of the owners
|
7921
|
+
# or viewers of the folders are returned. Implicit permissions from
|
7922
|
+
# folders or groups are not considered.
|
7923
|
+
#
|
7924
|
+
# * `FOLDER_NAME`\: Any folders whose names have a substring match to
|
7925
|
+
# this value will be returned.
|
7926
|
+
#
|
7927
|
+
# * `PARENT_FOLDER_ARN`\: Provide an ARN of a folder, and any folders
|
7928
|
+
# that are directly under that parent folder are returned. If you
|
7929
|
+
# choose to use this option and leave the value blank, all
|
7930
|
+
# root-level folders in the account are returned.
|
7437
7931
|
# @return [String]
|
7438
7932
|
#
|
7439
7933
|
# @!attribute [rw] value
|
@@ -7516,6 +8010,9 @@ module Aws::QuickSight
|
|
7516
8010
|
# visual_id: "RestrictiveResourceId", # required
|
7517
8011
|
# },
|
7518
8012
|
# },
|
8013
|
+
# q_search_bar: {
|
8014
|
+
# initial_topic_id: "RestrictiveResourceId", # required
|
8015
|
+
# },
|
7519
8016
|
# },
|
7520
8017
|
# allowed_domains: ["String"],
|
7521
8018
|
# }
|
@@ -7603,12 +8100,18 @@ module Aws::QuickSight
|
|
7603
8100
|
# The Amazon Web Services request ID for this operation.
|
7604
8101
|
# @return [String]
|
7605
8102
|
#
|
8103
|
+
# @!attribute [rw] anonymous_user_arn
|
8104
|
+
# The Amazon Resource Name (ARN) to use for the anonymous Amazon
|
8105
|
+
# QuickSight user.
|
8106
|
+
# @return [String]
|
8107
|
+
#
|
7606
8108
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GenerateEmbedUrlForAnonymousUserResponse AWS API Documentation
|
7607
8109
|
#
|
7608
8110
|
class GenerateEmbedUrlForAnonymousUserResponse < Struct.new(
|
7609
8111
|
:embed_url,
|
7610
8112
|
:status,
|
7611
|
-
:request_id
|
8113
|
+
:request_id,
|
8114
|
+
:anonymous_user_arn)
|
7612
8115
|
SENSITIVE = [:embed_url]
|
7613
8116
|
include Aws::Structure
|
7614
8117
|
end
|
@@ -8332,6 +8835,25 @@ module Aws::QuickSight
|
|
8332
8835
|
include Aws::Structure
|
8333
8836
|
end
|
8334
8837
|
|
8838
|
+
# You don't have this feature activated for your account. To fix this
|
8839
|
+
# issue, contact Amazon Web Services support.
|
8840
|
+
#
|
8841
|
+
# @!attribute [rw] message
|
8842
|
+
# @return [String]
|
8843
|
+
#
|
8844
|
+
# @!attribute [rw] request_id
|
8845
|
+
# The Amazon Web Services request ID for this request.
|
8846
|
+
# @return [String]
|
8847
|
+
#
|
8848
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/InvalidRequestException AWS API Documentation
|
8849
|
+
#
|
8850
|
+
class InvalidRequestException < Struct.new(
|
8851
|
+
:message,
|
8852
|
+
:request_id)
|
8853
|
+
SENSITIVE = []
|
8854
|
+
include Aws::Structure
|
8855
|
+
end
|
8856
|
+
|
8335
8857
|
# The parameters for Jira.
|
8336
8858
|
#
|
8337
8859
|
# @note When making an API call, you may pass JiraParameters
|
@@ -11572,8 +12094,8 @@ module Aws::QuickSight
|
|
11572
12094
|
# aws_account_id: "AwsAccountId", # required
|
11573
12095
|
# filters: [ # required
|
11574
12096
|
# {
|
11575
|
-
# operator: "StringEquals", # accepts StringEquals
|
11576
|
-
# name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER
|
12097
|
+
# operator: "StringEquals", # accepts StringEquals, StringLike
|
12098
|
+
# name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER, QUICKSIGHT_VIEWER_OR_OWNER, DIRECT_QUICKSIGHT_VIEWER_OR_OWNER, QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER, ANALYSIS_NAME
|
11577
12099
|
# value: "String",
|
11578
12100
|
# },
|
11579
12101
|
# ],
|
@@ -11644,8 +12166,8 @@ module Aws::QuickSight
|
|
11644
12166
|
# aws_account_id: "AwsAccountId", # required
|
11645
12167
|
# filters: [ # required
|
11646
12168
|
# {
|
11647
|
-
# operator: "StringEquals", # required, accepts StringEquals
|
11648
|
-
# name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER
|
12169
|
+
# operator: "StringEquals", # required, accepts StringEquals, StringLike
|
12170
|
+
# name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER, QUICKSIGHT_VIEWER_OR_OWNER, DIRECT_QUICKSIGHT_VIEWER_OR_OWNER, QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER, DASHBOARD_NAME
|
11649
12171
|
# value: "String",
|
11650
12172
|
# },
|
11651
12173
|
# ],
|
@@ -11714,6 +12236,147 @@ module Aws::QuickSight
|
|
11714
12236
|
include Aws::Structure
|
11715
12237
|
end
|
11716
12238
|
|
12239
|
+
# @note When making an API call, you may pass SearchDataSetsRequest
|
12240
|
+
# data as a hash:
|
12241
|
+
#
|
12242
|
+
# {
|
12243
|
+
# aws_account_id: "AwsAccountId", # required
|
12244
|
+
# filters: [ # required
|
12245
|
+
# {
|
12246
|
+
# operator: "StringEquals", # required, accepts StringEquals, StringLike
|
12247
|
+
# name: "QUICKSIGHT_VIEWER_OR_OWNER", # required, accepts QUICKSIGHT_VIEWER_OR_OWNER, QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_VIEWER_OR_OWNER, DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER, DATASET_NAME
|
12248
|
+
# value: "String", # required
|
12249
|
+
# },
|
12250
|
+
# ],
|
12251
|
+
# next_token: "String",
|
12252
|
+
# max_results: 1,
|
12253
|
+
# }
|
12254
|
+
#
|
12255
|
+
# @!attribute [rw] aws_account_id
|
12256
|
+
# The Amazon Web Services account ID.
|
12257
|
+
# @return [String]
|
12258
|
+
#
|
12259
|
+
# @!attribute [rw] filters
|
12260
|
+
# The filters to apply to the search.
|
12261
|
+
# @return [Array<Types::DataSetSearchFilter>]
|
12262
|
+
#
|
12263
|
+
# @!attribute [rw] next_token
|
12264
|
+
# A pagination token that can be used in a subsequent request.
|
12265
|
+
# @return [String]
|
12266
|
+
#
|
12267
|
+
# @!attribute [rw] max_results
|
12268
|
+
# The maximum number of results to be returned per request.
|
12269
|
+
# @return [Integer]
|
12270
|
+
#
|
12271
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchDataSetsRequest AWS API Documentation
|
12272
|
+
#
|
12273
|
+
class SearchDataSetsRequest < Struct.new(
|
12274
|
+
:aws_account_id,
|
12275
|
+
:filters,
|
12276
|
+
:next_token,
|
12277
|
+
:max_results)
|
12278
|
+
SENSITIVE = []
|
12279
|
+
include Aws::Structure
|
12280
|
+
end
|
12281
|
+
|
12282
|
+
# @!attribute [rw] data_set_summaries
|
12283
|
+
# A `DataSetSummaries` object that returns a summary of a dataset.
|
12284
|
+
# @return [Array<Types::DataSetSummary>]
|
12285
|
+
#
|
12286
|
+
# @!attribute [rw] next_token
|
12287
|
+
# A pagination token that can be used in a subsequent request.
|
12288
|
+
# @return [String]
|
12289
|
+
#
|
12290
|
+
# @!attribute [rw] status
|
12291
|
+
# The HTTP status of the request.
|
12292
|
+
# @return [Integer]
|
12293
|
+
#
|
12294
|
+
# @!attribute [rw] request_id
|
12295
|
+
# The Amazon Web Services request ID for this operation.
|
12296
|
+
# @return [String]
|
12297
|
+
#
|
12298
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchDataSetsResponse AWS API Documentation
|
12299
|
+
#
|
12300
|
+
class SearchDataSetsResponse < Struct.new(
|
12301
|
+
:data_set_summaries,
|
12302
|
+
:next_token,
|
12303
|
+
:status,
|
12304
|
+
:request_id)
|
12305
|
+
SENSITIVE = []
|
12306
|
+
include Aws::Structure
|
12307
|
+
end
|
12308
|
+
|
12309
|
+
# @note When making an API call, you may pass SearchDataSourcesRequest
|
12310
|
+
# data as a hash:
|
12311
|
+
#
|
12312
|
+
# {
|
12313
|
+
# aws_account_id: "AwsAccountId", # required
|
12314
|
+
# filters: [ # required
|
12315
|
+
# {
|
12316
|
+
# operator: "StringEquals", # required, accepts StringEquals, StringLike
|
12317
|
+
# name: "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER", # required, accepts DIRECT_QUICKSIGHT_VIEWER_OR_OWNER, DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER, DATASOURCE_NAME
|
12318
|
+
# value: "String", # required
|
12319
|
+
# },
|
12320
|
+
# ],
|
12321
|
+
# next_token: "String",
|
12322
|
+
# max_results: 1,
|
12323
|
+
# }
|
12324
|
+
#
|
12325
|
+
# @!attribute [rw] aws_account_id
|
12326
|
+
# The Amazon Web Services account ID.
|
12327
|
+
# @return [String]
|
12328
|
+
#
|
12329
|
+
# @!attribute [rw] filters
|
12330
|
+
# The filters to apply to the search.
|
12331
|
+
# @return [Array<Types::DataSourceSearchFilter>]
|
12332
|
+
#
|
12333
|
+
# @!attribute [rw] next_token
|
12334
|
+
# A pagination token that can be used in a subsequent request.
|
12335
|
+
# @return [String]
|
12336
|
+
#
|
12337
|
+
# @!attribute [rw] max_results
|
12338
|
+
# The maximum number of results to be returned per request.
|
12339
|
+
# @return [Integer]
|
12340
|
+
#
|
12341
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchDataSourcesRequest AWS API Documentation
|
12342
|
+
#
|
12343
|
+
class SearchDataSourcesRequest < Struct.new(
|
12344
|
+
:aws_account_id,
|
12345
|
+
:filters,
|
12346
|
+
:next_token,
|
12347
|
+
:max_results)
|
12348
|
+
SENSITIVE = []
|
12349
|
+
include Aws::Structure
|
12350
|
+
end
|
12351
|
+
|
12352
|
+
# @!attribute [rw] data_source_summaries
|
12353
|
+
# A `DataSourceSummaries` object that returns a summary of a data
|
12354
|
+
# source.
|
12355
|
+
# @return [Array<Types::DataSourceSummary>]
|
12356
|
+
#
|
12357
|
+
# @!attribute [rw] next_token
|
12358
|
+
# A pagination token that can be used in a subsequent request.
|
12359
|
+
# @return [String]
|
12360
|
+
#
|
12361
|
+
# @!attribute [rw] status
|
12362
|
+
# The HTTP status of the request.
|
12363
|
+
# @return [Integer]
|
12364
|
+
#
|
12365
|
+
# @!attribute [rw] request_id
|
12366
|
+
# The Amazon Web Services request ID for this operation.
|
12367
|
+
# @return [String]
|
12368
|
+
#
|
12369
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchDataSourcesResponse AWS API Documentation
|
12370
|
+
#
|
12371
|
+
class SearchDataSourcesResponse < Struct.new(
|
12372
|
+
:data_source_summaries,
|
12373
|
+
:next_token,
|
12374
|
+
:status,
|
12375
|
+
:request_id)
|
12376
|
+
SENSITIVE = []
|
12377
|
+
include Aws::Structure
|
12378
|
+
end
|
12379
|
+
|
11717
12380
|
# @note When making an API call, you may pass SearchFoldersRequest
|
11718
12381
|
# data as a hash:
|
11719
12382
|
#
|
@@ -11721,8 +12384,8 @@ module Aws::QuickSight
|
|
11721
12384
|
# aws_account_id: "AwsAccountId", # required
|
11722
12385
|
# filters: [ # required
|
11723
12386
|
# {
|
11724
|
-
# operator: "StringEquals", # accepts StringEquals
|
11725
|
-
# name: "PARENT_FOLDER_ARN", # accepts PARENT_FOLDER_ARN
|
12387
|
+
# operator: "StringEquals", # accepts StringEquals, StringLike
|
12388
|
+
# name: "PARENT_FOLDER_ARN", # accepts PARENT_FOLDER_ARN, DIRECT_QUICKSIGHT_OWNER, DIRECT_QUICKSIGHT_SOLE_OWNER, DIRECT_QUICKSIGHT_VIEWER_OR_OWNER, QUICKSIGHT_OWNER, QUICKSIGHT_VIEWER_OR_OWNER, FOLDER_NAME
|
11726
12389
|
# value: "String",
|
11727
12390
|
# },
|
11728
12391
|
# ],
|
@@ -13476,6 +14139,7 @@ module Aws::QuickSight
|
|
13476
14139
|
# aws_account_id: "AwsAccountId", # required
|
13477
14140
|
# default_namespace: "Namespace", # required
|
13478
14141
|
# notification_email: "String",
|
14142
|
+
# termination_protection_enabled: false,
|
13479
14143
|
# }
|
13480
14144
|
#
|
13481
14145
|
# @!attribute [rw] aws_account_id
|
@@ -13497,12 +14161,21 @@ module Aws::QuickSight
|
|
13497
14161
|
# Amazon QuickSight subscription.
|
13498
14162
|
# @return [String]
|
13499
14163
|
#
|
14164
|
+
# @!attribute [rw] termination_protection_enabled
|
14165
|
+
# A boolean value that determines whether or not an Amazon QuickSight
|
14166
|
+
# account can be deleted. A `True` value doesn't allow the account to
|
14167
|
+
# be deleted and results in an error message if a user tries to make a
|
14168
|
+
# `DeleteAccountSubscription` request. A `False` value will allow the
|
14169
|
+
# account to be deleted.
|
14170
|
+
# @return [Boolean]
|
14171
|
+
#
|
13500
14172
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountSettingsRequest AWS API Documentation
|
13501
14173
|
#
|
13502
14174
|
class UpdateAccountSettingsRequest < Struct.new(
|
13503
14175
|
:aws_account_id,
|
13504
14176
|
:default_namespace,
|
13505
|
-
:notification_email
|
14177
|
+
:notification_email,
|
14178
|
+
:termination_protection_enabled)
|
13506
14179
|
SENSITIVE = []
|
13507
14180
|
include Aws::Structure
|
13508
14181
|
end
|
@@ -14523,6 +15196,7 @@ module Aws::QuickSight
|
|
14523
15196
|
# },
|
14524
15197
|
# athena_parameters: {
|
14525
15198
|
# work_group: "WorkGroup",
|
15199
|
+
# role_arn: "RoleArn",
|
14526
15200
|
# },
|
14527
15201
|
# aurora_parameters: {
|
14528
15202
|
# host: "Host", # required
|
@@ -14614,6 +15288,11 @@ module Aws::QuickSight
|
|
14614
15288
|
# host: "Host", # required
|
14615
15289
|
# port: 1, # required
|
14616
15290
|
# },
|
15291
|
+
# databricks_parameters: {
|
15292
|
+
# host: "Host", # required
|
15293
|
+
# port: 1, # required
|
15294
|
+
# sql_endpoint_path: "SqlEndpointPath", # required
|
15295
|
+
# },
|
14617
15296
|
# },
|
14618
15297
|
# credentials: {
|
14619
15298
|
# credential_pair: {
|
@@ -14626,6 +15305,7 @@ module Aws::QuickSight
|
|
14626
15305
|
# },
|
14627
15306
|
# athena_parameters: {
|
14628
15307
|
# work_group: "WorkGroup",
|
15308
|
+
# role_arn: "RoleArn",
|
14629
15309
|
# },
|
14630
15310
|
# aurora_parameters: {
|
14631
15311
|
# host: "Host", # required
|
@@ -14717,6 +15397,11 @@ module Aws::QuickSight
|
|
14717
15397
|
# host: "Host", # required
|
14718
15398
|
# port: 1, # required
|
14719
15399
|
# },
|
15400
|
+
# databricks_parameters: {
|
15401
|
+
# host: "Host", # required
|
15402
|
+
# port: 1, # required
|
15403
|
+
# sql_endpoint_path: "SqlEndpointPath", # required
|
15404
|
+
# },
|
14720
15405
|
# },
|
14721
15406
|
# ],
|
14722
15407
|
# },
|