aws-sdk-quicksight 1.53.0 → 1.57.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight/client.rb +164 -50
- data/lib/aws-sdk-quicksight/client_api.rb +89 -21
- data/lib/aws-sdk-quicksight/types.rb +267 -65
- data/lib/aws-sdk-quicksight.rb +1 -1
- metadata +4 -4
@@ -34,7 +34,7 @@ module Aws::QuickSight
|
|
34
34
|
|
35
35
|
# The Amazon QuickSight customizations associated with your Amazon Web
|
36
36
|
# Services account or a Amazon QuickSight namespace in a specific Amazon
|
37
|
-
# Web Services Region
|
37
|
+
# Web Services Region.
|
38
38
|
#
|
39
39
|
# @note When making an API call, you may pass AccountCustomization
|
40
40
|
# data as a hash:
|
@@ -130,7 +130,7 @@ module Aws::QuickSight
|
|
130
130
|
include Aws::Structure
|
131
131
|
end
|
132
132
|
|
133
|
-
# The parameters for
|
133
|
+
# The parameters for OpenSearch.
|
134
134
|
#
|
135
135
|
# @note When making an API call, you may pass AmazonElasticsearchParameters
|
136
136
|
# data as a hash:
|
@@ -140,7 +140,7 @@ module Aws::QuickSight
|
|
140
140
|
# }
|
141
141
|
#
|
142
142
|
# @!attribute [rw] domain
|
143
|
-
# The
|
143
|
+
# The OpenSearch domain.
|
144
144
|
# @return [String]
|
145
145
|
#
|
146
146
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AmazonElasticsearchParameters AWS API Documentation
|
@@ -151,6 +151,24 @@ module Aws::QuickSight
|
|
151
151
|
include Aws::Structure
|
152
152
|
end
|
153
153
|
|
154
|
+
# @note When making an API call, you may pass AmazonOpenSearchParameters
|
155
|
+
# data as a hash:
|
156
|
+
#
|
157
|
+
# {
|
158
|
+
# domain: "Domain", # required
|
159
|
+
# }
|
160
|
+
#
|
161
|
+
# @!attribute [rw] domain
|
162
|
+
# @return [String]
|
163
|
+
#
|
164
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AmazonOpenSearchParameters AWS API Documentation
|
165
|
+
#
|
166
|
+
class AmazonOpenSearchParameters < Struct.new(
|
167
|
+
:domain)
|
168
|
+
SENSITIVE = []
|
169
|
+
include Aws::Structure
|
170
|
+
end
|
171
|
+
|
154
172
|
# Metadata structure for an analysis in Amazon QuickSight
|
155
173
|
#
|
156
174
|
# @!attribute [rw] analysis_id
|
@@ -591,7 +609,7 @@ module Aws::QuickSight
|
|
591
609
|
#
|
592
610
|
# {
|
593
611
|
# aws_account_id: "AwsAccountId", # required
|
594
|
-
# data_set_id: "
|
612
|
+
# data_set_id: "String", # required
|
595
613
|
# ingestion_id: "IngestionId", # required
|
596
614
|
# }
|
597
615
|
#
|
@@ -913,7 +931,7 @@ module Aws::QuickSight
|
|
913
931
|
#
|
914
932
|
# @!attribute [rw] account_customization
|
915
933
|
# The Amazon QuickSight customizations you're adding in the current
|
916
|
-
# Amazon Web Services Region
|
934
|
+
# Amazon Web Services Region. You can add these to an Amazon Web
|
917
935
|
# Services account and a Amazon QuickSight namespace.
|
918
936
|
#
|
919
937
|
# For example, you can add a default theme by setting
|
@@ -957,7 +975,7 @@ module Aws::QuickSight
|
|
957
975
|
#
|
958
976
|
# @!attribute [rw] account_customization
|
959
977
|
# The Amazon QuickSight customizations you're adding in the current
|
960
|
-
# Amazon Web Services Region
|
978
|
+
# Amazon Web Services Region.
|
961
979
|
# @return [Types::AccountCustomization]
|
962
980
|
#
|
963
981
|
# @!attribute [rw] request_id
|
@@ -1270,7 +1288,7 @@ module Aws::QuickSight
|
|
1270
1288
|
# the CreateTemplate API operation. For `SourceTemplate`, specify the
|
1271
1289
|
# Amazon Resource Name (ARN) of the source template. The
|
1272
1290
|
# `SourceTemplate`ARN can contain any Amazon Web Services account and
|
1273
|
-
# any Amazon QuickSight-supported Amazon Web Services Region
|
1291
|
+
# any Amazon QuickSight-supported Amazon Web Services Region.
|
1274
1292
|
#
|
1275
1293
|
# Use the `DataSetReferences` entity within `SourceTemplate` to list
|
1276
1294
|
# the replacement datasets for the placeholders listed in the
|
@@ -1545,7 +1563,7 @@ module Aws::QuickSight
|
|
1545
1563
|
#
|
1546
1564
|
# @!attribute [rw] data_set_id
|
1547
1565
|
# An ID for the dataset that you want to create. This ID is unique per
|
1548
|
-
# Amazon Web Services Region
|
1566
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
1549
1567
|
# @return [String]
|
1550
1568
|
#
|
1551
1569
|
# @!attribute [rw] name
|
@@ -1632,8 +1650,7 @@ module Aws::QuickSight
|
|
1632
1650
|
#
|
1633
1651
|
# @!attribute [rw] data_set_id
|
1634
1652
|
# The ID for the dataset that you want to create. This ID is unique
|
1635
|
-
# per Amazon Web Services Region
|
1636
|
-
# account.
|
1653
|
+
# per Amazon Web Services Region for each Amazon Web Services account.
|
1637
1654
|
# @return [String]
|
1638
1655
|
#
|
1639
1656
|
# @!attribute [rw] ingestion_arn
|
@@ -1674,7 +1691,7 @@ module Aws::QuickSight
|
|
1674
1691
|
# aws_account_id: "AwsAccountId", # required
|
1675
1692
|
# data_source_id: "ResourceId", # required
|
1676
1693
|
# name: "ResourceName", # required
|
1677
|
-
# 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
|
1694
|
+
# 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
|
1678
1695
|
# data_source_parameters: {
|
1679
1696
|
# amazon_elasticsearch_parameters: {
|
1680
1697
|
# domain: "Domain", # required
|
@@ -1765,6 +1782,9 @@ module Aws::QuickSight
|
|
1765
1782
|
# query: "Query", # required
|
1766
1783
|
# max_rows: 1, # required
|
1767
1784
|
# },
|
1785
|
+
# amazon_open_search_parameters: {
|
1786
|
+
# domain: "Domain", # required
|
1787
|
+
# },
|
1768
1788
|
# },
|
1769
1789
|
# credentials: {
|
1770
1790
|
# credential_pair: {
|
@@ -1861,6 +1881,9 @@ module Aws::QuickSight
|
|
1861
1881
|
# query: "Query", # required
|
1862
1882
|
# max_rows: 1, # required
|
1863
1883
|
# },
|
1884
|
+
# amazon_open_search_parameters: {
|
1885
|
+
# domain: "Domain", # required
|
1886
|
+
# },
|
1864
1887
|
# },
|
1865
1888
|
# ],
|
1866
1889
|
# },
|
@@ -1892,7 +1915,7 @@ module Aws::QuickSight
|
|
1892
1915
|
#
|
1893
1916
|
# @!attribute [rw] data_source_id
|
1894
1917
|
# An ID for the data source. This ID is unique per Amazon Web Services
|
1895
|
-
# Region
|
1918
|
+
# Region for each Amazon Web Services account.
|
1896
1919
|
# @return [String]
|
1897
1920
|
#
|
1898
1921
|
# @!attribute [rw] name
|
@@ -1903,7 +1926,7 @@ module Aws::QuickSight
|
|
1903
1926
|
# The type of the data source. To return a list of all data sources,
|
1904
1927
|
# use `ListDataSources`.
|
1905
1928
|
#
|
1906
|
-
# Use `AMAZON_ELASTICSEARCH` for Amazon
|
1929
|
+
# Use `AMAZON_ELASTICSEARCH` for Amazon OpenSearch Service.
|
1907
1930
|
# @return [String]
|
1908
1931
|
#
|
1909
1932
|
# @!attribute [rw] data_source_parameters
|
@@ -1959,7 +1982,7 @@ module Aws::QuickSight
|
|
1959
1982
|
#
|
1960
1983
|
# @!attribute [rw] data_source_id
|
1961
1984
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
1962
|
-
# Region
|
1985
|
+
# Region for each Amazon Web Services account.
|
1963
1986
|
# @return [String]
|
1964
1987
|
#
|
1965
1988
|
# @!attribute [rw] creation_status
|
@@ -2394,9 +2417,10 @@ module Aws::QuickSight
|
|
2394
2417
|
# data as a hash:
|
2395
2418
|
#
|
2396
2419
|
# {
|
2397
|
-
# data_set_id: "
|
2420
|
+
# data_set_id: "String", # required
|
2398
2421
|
# ingestion_id: "IngestionId", # required
|
2399
2422
|
# aws_account_id: "AwsAccountId", # required
|
2423
|
+
# ingestion_type: "INCREMENTAL_REFRESH", # accepts INCREMENTAL_REFRESH, FULL_REFRESH
|
2400
2424
|
# }
|
2401
2425
|
#
|
2402
2426
|
# @!attribute [rw] data_set_id
|
@@ -2411,12 +2435,17 @@ module Aws::QuickSight
|
|
2411
2435
|
# The Amazon Web Services account ID.
|
2412
2436
|
# @return [String]
|
2413
2437
|
#
|
2438
|
+
# @!attribute [rw] ingestion_type
|
2439
|
+
# The type of ingestion that you want to create.
|
2440
|
+
# @return [String]
|
2441
|
+
#
|
2414
2442
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateIngestionRequest AWS API Documentation
|
2415
2443
|
#
|
2416
2444
|
class CreateIngestionRequest < Struct.new(
|
2417
2445
|
:data_set_id,
|
2418
2446
|
:ingestion_id,
|
2419
|
-
:aws_account_id
|
2447
|
+
:aws_account_id,
|
2448
|
+
:ingestion_type)
|
2420
2449
|
SENSITIVE = []
|
2421
2450
|
include Aws::Structure
|
2422
2451
|
end
|
@@ -2673,7 +2702,7 @@ module Aws::QuickSight
|
|
2673
2702
|
# (ARN). For `SourceTemplate`, specify the ARN of the source template.
|
2674
2703
|
# For `SourceAnalysis`, specify the ARN of the source analysis. The
|
2675
2704
|
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
2676
|
-
# any Amazon QuickSight-supported Amazon Web Services Region
|
2705
|
+
# any Amazon QuickSight-supported Amazon Web Services Region.
|
2677
2706
|
#
|
2678
2707
|
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
2679
2708
|
# `SourceAnalysis` to list the replacement datasets for the
|
@@ -3065,6 +3094,9 @@ module Aws::QuickSight
|
|
3065
3094
|
# query: "Query", # required
|
3066
3095
|
# max_rows: 1, # required
|
3067
3096
|
# },
|
3097
|
+
# amazon_open_search_parameters: {
|
3098
|
+
# domain: "Domain", # required
|
3099
|
+
# },
|
3068
3100
|
# },
|
3069
3101
|
# ],
|
3070
3102
|
# }
|
@@ -3782,7 +3814,7 @@ module Aws::QuickSight
|
|
3782
3814
|
#
|
3783
3815
|
# @!attribute [rw] data_source_id
|
3784
3816
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
3785
|
-
# Region
|
3817
|
+
# Region for each Amazon Web Services account.
|
3786
3818
|
# @return [String]
|
3787
3819
|
#
|
3788
3820
|
# @!attribute [rw] name
|
@@ -3962,6 +3994,9 @@ module Aws::QuickSight
|
|
3962
3994
|
# query: "Query", # required
|
3963
3995
|
# max_rows: 1, # required
|
3964
3996
|
# },
|
3997
|
+
# amazon_open_search_parameters: {
|
3998
|
+
# domain: "Domain", # required
|
3999
|
+
# },
|
3965
4000
|
# },
|
3966
4001
|
# ],
|
3967
4002
|
# },
|
@@ -4104,10 +4139,13 @@ module Aws::QuickSight
|
|
4104
4139
|
# query: "Query", # required
|
4105
4140
|
# max_rows: 1, # required
|
4106
4141
|
# },
|
4142
|
+
# amazon_open_search_parameters: {
|
4143
|
+
# domain: "Domain", # required
|
4144
|
+
# },
|
4107
4145
|
# }
|
4108
4146
|
#
|
4109
4147
|
# @!attribute [rw] amazon_elasticsearch_parameters
|
4110
|
-
# The parameters for
|
4148
|
+
# The parameters for OpenSearch.
|
4111
4149
|
# @return [Types::AmazonElasticsearchParameters]
|
4112
4150
|
#
|
4113
4151
|
# @!attribute [rw] athena_parameters
|
@@ -4186,6 +4224,9 @@ module Aws::QuickSight
|
|
4186
4224
|
# The parameters for Twitter.
|
4187
4225
|
# @return [Types::TwitterParameters]
|
4188
4226
|
#
|
4227
|
+
# @!attribute [rw] amazon_open_search_parameters
|
4228
|
+
# @return [Types::AmazonOpenSearchParameters]
|
4229
|
+
#
|
4189
4230
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSourceParameters AWS API Documentation
|
4190
4231
|
#
|
4191
4232
|
class DataSourceParameters < Struct.new(
|
@@ -4208,7 +4249,8 @@ module Aws::QuickSight
|
|
4208
4249
|
:spark_parameters,
|
4209
4250
|
:sql_server_parameters,
|
4210
4251
|
:teradata_parameters,
|
4211
|
-
:twitter_parameters
|
4252
|
+
:twitter_parameters,
|
4253
|
+
:amazon_open_search_parameters)
|
4212
4254
|
SENSITIVE = []
|
4213
4255
|
include Aws::Structure
|
4214
4256
|
end
|
@@ -4278,7 +4320,7 @@ module Aws::QuickSight
|
|
4278
4320
|
# @!attribute [rw] aws_account_id
|
4279
4321
|
# The ID for the Amazon Web Services account that you want to delete
|
4280
4322
|
# Amazon QuickSight customizations from in this Amazon Web Services
|
4281
|
-
# Region
|
4323
|
+
# Region.
|
4282
4324
|
# @return [String]
|
4283
4325
|
#
|
4284
4326
|
# @!attribute [rw] namespace
|
@@ -4463,8 +4505,7 @@ module Aws::QuickSight
|
|
4463
4505
|
#
|
4464
4506
|
# @!attribute [rw] data_set_id
|
4465
4507
|
# The ID for the dataset that you want to create. This ID is unique
|
4466
|
-
# per Amazon Web Services Region
|
4467
|
-
# account.
|
4508
|
+
# per Amazon Web Services Region for each Amazon Web Services account.
|
4468
4509
|
# @return [String]
|
4469
4510
|
#
|
4470
4511
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDataSetRequest AWS API Documentation
|
@@ -4482,8 +4523,7 @@ module Aws::QuickSight
|
|
4482
4523
|
#
|
4483
4524
|
# @!attribute [rw] data_set_id
|
4484
4525
|
# The ID for the dataset that you want to create. This ID is unique
|
4485
|
-
# per Amazon Web Services Region
|
4486
|
-
# account.
|
4526
|
+
# per Amazon Web Services Region for each Amazon Web Services account.
|
4487
4527
|
# @return [String]
|
4488
4528
|
#
|
4489
4529
|
# @!attribute [rw] request_id
|
@@ -4519,7 +4559,7 @@ module Aws::QuickSight
|
|
4519
4559
|
#
|
4520
4560
|
# @!attribute [rw] data_source_id
|
4521
4561
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
4522
|
-
# Region
|
4562
|
+
# Region for each Amazon Web Services account.
|
4523
4563
|
# @return [String]
|
4524
4564
|
#
|
4525
4565
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDataSourceRequest AWS API Documentation
|
@@ -4537,7 +4577,7 @@ module Aws::QuickSight
|
|
4537
4577
|
#
|
4538
4578
|
# @!attribute [rw] data_source_id
|
4539
4579
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
4540
|
-
# Region
|
4580
|
+
# Region for each Amazon Web Services account.
|
4541
4581
|
# @return [String]
|
4542
4582
|
#
|
4543
4583
|
# @!attribute [rw] request_id
|
@@ -5281,7 +5321,7 @@ module Aws::QuickSight
|
|
5281
5321
|
#
|
5282
5322
|
# @!attribute [rw] account_customization
|
5283
5323
|
# The Amazon QuickSight customizations that exist in the current
|
5284
|
-
# Amazon Web Services Region
|
5324
|
+
# Amazon Web Services Region.
|
5285
5325
|
# @return [Types::AccountCustomization]
|
5286
5326
|
#
|
5287
5327
|
# @!attribute [rw] request_id
|
@@ -5335,7 +5375,7 @@ module Aws::QuickSight
|
|
5335
5375
|
# technically not an account by itself. Instead, it's a subscription
|
5336
5376
|
# to the Amazon QuickSight service for your Amazon Web Services
|
5337
5377
|
# account. The edition that you subscribe to applies to Amazon
|
5338
|
-
# QuickSight in every Amazon Web Services Region
|
5378
|
+
# QuickSight in every Amazon Web Services Region where you use it.
|
5339
5379
|
# @return [Types::AccountSettings]
|
5340
5380
|
#
|
5341
5381
|
# @!attribute [rw] request_id
|
@@ -5602,8 +5642,7 @@ module Aws::QuickSight
|
|
5602
5642
|
#
|
5603
5643
|
# @!attribute [rw] data_set_id
|
5604
5644
|
# The ID for the dataset that you want to create. This ID is unique
|
5605
|
-
# per Amazon Web Services Region
|
5606
|
-
# account.
|
5645
|
+
# per Amazon Web Services Region for each Amazon Web Services account.
|
5607
5646
|
# @return [String]
|
5608
5647
|
#
|
5609
5648
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSetPermissionsRequest AWS API Documentation
|
@@ -5621,8 +5660,7 @@ module Aws::QuickSight
|
|
5621
5660
|
#
|
5622
5661
|
# @!attribute [rw] data_set_id
|
5623
5662
|
# The ID for the dataset that you want to create. This ID is unique
|
5624
|
-
# per Amazon Web Services Region
|
5625
|
-
# account.
|
5663
|
+
# per Amazon Web Services Region for each Amazon Web Services account.
|
5626
5664
|
# @return [String]
|
5627
5665
|
#
|
5628
5666
|
# @!attribute [rw] permissions
|
@@ -5663,8 +5701,7 @@ module Aws::QuickSight
|
|
5663
5701
|
#
|
5664
5702
|
# @!attribute [rw] data_set_id
|
5665
5703
|
# The ID for the dataset that you want to create. This ID is unique
|
5666
|
-
# per Amazon Web Services Region
|
5667
|
-
# account.
|
5704
|
+
# per Amazon Web Services Region for each Amazon Web Services account.
|
5668
5705
|
# @return [String]
|
5669
5706
|
#
|
5670
5707
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSetRequest AWS API Documentation
|
@@ -5712,7 +5749,7 @@ module Aws::QuickSight
|
|
5712
5749
|
#
|
5713
5750
|
# @!attribute [rw] data_source_id
|
5714
5751
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
5715
|
-
# Region
|
5752
|
+
# Region for each Amazon Web Services account.
|
5716
5753
|
# @return [String]
|
5717
5754
|
#
|
5718
5755
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSourcePermissionsRequest AWS API Documentation
|
@@ -5730,7 +5767,7 @@ module Aws::QuickSight
|
|
5730
5767
|
#
|
5731
5768
|
# @!attribute [rw] data_source_id
|
5732
5769
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
5733
|
-
# Region
|
5770
|
+
# Region for each Amazon Web Services account.
|
5734
5771
|
# @return [String]
|
5735
5772
|
#
|
5736
5773
|
# @!attribute [rw] permissions
|
@@ -5771,7 +5808,7 @@ module Aws::QuickSight
|
|
5771
5808
|
#
|
5772
5809
|
# @!attribute [rw] data_source_id
|
5773
5810
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
5774
|
-
# Region
|
5811
|
+
# Region for each Amazon Web Services account.
|
5775
5812
|
# @return [String]
|
5776
5813
|
#
|
5777
5814
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSourceRequest AWS API Documentation
|
@@ -6080,7 +6117,7 @@ module Aws::QuickSight
|
|
6080
6117
|
#
|
6081
6118
|
# {
|
6082
6119
|
# aws_account_id: "AwsAccountId", # required
|
6083
|
-
# data_set_id: "
|
6120
|
+
# data_set_id: "String", # required
|
6084
6121
|
# ingestion_id: "IngestionId", # required
|
6085
6122
|
# }
|
6086
6123
|
#
|
@@ -6128,6 +6165,58 @@ module Aws::QuickSight
|
|
6128
6165
|
include Aws::Structure
|
6129
6166
|
end
|
6130
6167
|
|
6168
|
+
# @note When making an API call, you may pass DescribeIpRestrictionRequest
|
6169
|
+
# data as a hash:
|
6170
|
+
#
|
6171
|
+
# {
|
6172
|
+
# aws_account_id: "AwsAccountId", # required
|
6173
|
+
# }
|
6174
|
+
#
|
6175
|
+
# @!attribute [rw] aws_account_id
|
6176
|
+
# Your AWS account ID.
|
6177
|
+
# @return [String]
|
6178
|
+
#
|
6179
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeIpRestrictionRequest AWS API Documentation
|
6180
|
+
#
|
6181
|
+
class DescribeIpRestrictionRequest < Struct.new(
|
6182
|
+
:aws_account_id)
|
6183
|
+
SENSITIVE = []
|
6184
|
+
include Aws::Structure
|
6185
|
+
end
|
6186
|
+
|
6187
|
+
# @!attribute [rw] aws_account_id
|
6188
|
+
# Your AWS account ID.
|
6189
|
+
# @return [String]
|
6190
|
+
#
|
6191
|
+
# @!attribute [rw] ip_restriction_rule_map
|
6192
|
+
# Describes the IP rules with CIDR range and description.
|
6193
|
+
# @return [Hash<String,String>]
|
6194
|
+
#
|
6195
|
+
# @!attribute [rw] enabled
|
6196
|
+
# Whether or not IP rules are enabled.
|
6197
|
+
# @return [Boolean]
|
6198
|
+
#
|
6199
|
+
# @!attribute [rw] request_id
|
6200
|
+
# The ID of the describe request.
|
6201
|
+
# @return [String]
|
6202
|
+
#
|
6203
|
+
# @!attribute [rw] status
|
6204
|
+
# The status of a set of IP restrictions. A successful request returns
|
6205
|
+
# a 200 status code.
|
6206
|
+
# @return [Integer]
|
6207
|
+
#
|
6208
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeIpRestrictionResponse AWS API Documentation
|
6209
|
+
#
|
6210
|
+
class DescribeIpRestrictionResponse < Struct.new(
|
6211
|
+
:aws_account_id,
|
6212
|
+
:ip_restriction_rule_map,
|
6213
|
+
:enabled,
|
6214
|
+
:request_id,
|
6215
|
+
:status)
|
6216
|
+
SENSITIVE = []
|
6217
|
+
include Aws::Structure
|
6218
|
+
end
|
6219
|
+
|
6131
6220
|
# @note When making an API call, you may pass DescribeNamespaceRequest
|
6132
6221
|
# data as a hash:
|
6133
6222
|
#
|
@@ -6157,7 +6246,7 @@ module Aws::QuickSight
|
|
6157
6246
|
# @!attribute [rw] namespace
|
6158
6247
|
# The information about the namespace that you're describing. The
|
6159
6248
|
# response includes the namespace ARN, name, Amazon Web Services
|
6160
|
-
# Region
|
6249
|
+
# Region, creation status, and identity store. `DescribeNamespace`
|
6161
6250
|
# also works for namespaces that are in the process of being created.
|
6162
6251
|
# For incomplete namespaces, this API operation lists the namespace
|
6163
6252
|
# error types and messages associated with the creation process.
|
@@ -6958,6 +7047,9 @@ module Aws::QuickSight
|
|
6958
7047
|
# quick_sight_console: {
|
6959
7048
|
# initial_path: "EntryPath",
|
6960
7049
|
# },
|
7050
|
+
# q_search_bar: {
|
7051
|
+
# initial_topic_id: "RestrictiveResourceId",
|
7052
|
+
# },
|
6961
7053
|
# },
|
6962
7054
|
# }
|
6963
7055
|
#
|
@@ -6977,8 +7069,8 @@ module Aws::QuickSight
|
|
6977
7069
|
#
|
6978
7070
|
# @!attribute [rw] experience_configuration
|
6979
7071
|
# The experience you are embedding. For registered users, you can
|
6980
|
-
# embed Amazon QuickSight dashboards
|
6981
|
-
# console.
|
7072
|
+
# embed Amazon QuickSight dashboards, the entire Amazon QuickSight
|
7073
|
+
# console, or the Amazon QuickSight Q search bar.
|
6982
7074
|
# @return [Types::RegisteredUserEmbeddingExperienceConfiguration]
|
6983
7075
|
#
|
6984
7076
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUserRequest AWS API Documentation
|
@@ -6993,7 +7085,8 @@ module Aws::QuickSight
|
|
6993
7085
|
end
|
6994
7086
|
|
6995
7087
|
# @!attribute [rw] embed_url
|
6996
|
-
# The embed URL for the Amazon QuickSight dashboard or
|
7088
|
+
# The embed URL for the Amazon QuickSight dashboard, console, or Q
|
7089
|
+
# search bar.
|
6997
7090
|
# @return [String]
|
6998
7091
|
#
|
6999
7092
|
# @!attribute [rw] status
|
@@ -8446,8 +8539,8 @@ module Aws::QuickSight
|
|
8446
8539
|
# data as a hash:
|
8447
8540
|
#
|
8448
8541
|
# {
|
8449
|
-
# data_set_id: "
|
8450
|
-
# next_token: "
|
8542
|
+
# data_set_id: "String", # required
|
8543
|
+
# next_token: "String",
|
8451
8544
|
# aws_account_id: "AwsAccountId", # required
|
8452
8545
|
# max_results: 1,
|
8453
8546
|
# }
|
@@ -8543,7 +8636,7 @@ module Aws::QuickSight
|
|
8543
8636
|
# @!attribute [rw] namespaces
|
8544
8637
|
# The information about the namespaces in this Amazon Web Services
|
8545
8638
|
# account. The response includes the namespace ARN, name, Amazon Web
|
8546
|
-
# Services Region
|
8639
|
+
# Services Region, notification email address, creation status, and
|
8547
8640
|
# identity store.
|
8548
8641
|
# @return [Array<Types::NamespaceInfoV2>]
|
8549
8642
|
#
|
@@ -9463,7 +9556,7 @@ module Aws::QuickSight
|
|
9463
9556
|
# @return [String]
|
9464
9557
|
#
|
9465
9558
|
# @!attribute [rw] capacity_region
|
9466
|
-
# The namespace Amazon Web Services Region
|
9559
|
+
# The namespace Amazon Web Services Region.
|
9467
9560
|
# @return [String]
|
9468
9561
|
#
|
9469
9562
|
# @!attribute [rw] creation_status
|
@@ -10138,6 +10231,9 @@ module Aws::QuickSight
|
|
10138
10231
|
# quick_sight_console: {
|
10139
10232
|
# initial_path: "EntryPath",
|
10140
10233
|
# },
|
10234
|
+
# q_search_bar: {
|
10235
|
+
# initial_topic_id: "RestrictiveResourceId",
|
10236
|
+
# },
|
10141
10237
|
# }
|
10142
10238
|
#
|
10143
10239
|
# @!attribute [rw] dashboard
|
@@ -10179,11 +10275,52 @@ module Aws::QuickSight
|
|
10179
10275
|
# [3]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html
|
10180
10276
|
# @return [Types::RegisteredUserQuickSightConsoleEmbeddingConfiguration]
|
10181
10277
|
#
|
10278
|
+
# @!attribute [rw] q_search_bar
|
10279
|
+
# The configuration details for embedding the Q search bar.
|
10280
|
+
#
|
10281
|
+
# For more information about embedding the Q search bar, see
|
10282
|
+
# [Embedding Overview][1].
|
10283
|
+
#
|
10284
|
+
#
|
10285
|
+
#
|
10286
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html
|
10287
|
+
# @return [Types::RegisteredUserQSearchBarEmbeddingConfiguration]
|
10288
|
+
#
|
10182
10289
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisteredUserEmbeddingExperienceConfiguration AWS API Documentation
|
10183
10290
|
#
|
10184
10291
|
class RegisteredUserEmbeddingExperienceConfiguration < Struct.new(
|
10185
10292
|
:dashboard,
|
10186
|
-
:quick_sight_console
|
10293
|
+
:quick_sight_console,
|
10294
|
+
:q_search_bar)
|
10295
|
+
SENSITIVE = []
|
10296
|
+
include Aws::Structure
|
10297
|
+
end
|
10298
|
+
|
10299
|
+
# Information about the Q search bar embedding experience.
|
10300
|
+
#
|
10301
|
+
# @note When making an API call, you may pass RegisteredUserQSearchBarEmbeddingConfiguration
|
10302
|
+
# data as a hash:
|
10303
|
+
#
|
10304
|
+
# {
|
10305
|
+
# initial_topic_id: "RestrictiveResourceId",
|
10306
|
+
# }
|
10307
|
+
#
|
10308
|
+
# @!attribute [rw] initial_topic_id
|
10309
|
+
# The ID of the Q topic that you want to make the starting topic in
|
10310
|
+
# the Q search bar. You can find a topic ID by navigating to the
|
10311
|
+
# Topics pane in the Amazon QuickSight application and opening a
|
10312
|
+
# topic. The ID is in the URL for the topic that you open.
|
10313
|
+
#
|
10314
|
+
# If you don't specify an initial topic, a list of all shared topics
|
10315
|
+
# is shown in the Q bar for your readers. When you select an initial
|
10316
|
+
# topic, you can specify whether or not readers are allowed to select
|
10317
|
+
# other topics from the available ones in the list.
|
10318
|
+
# @return [String]
|
10319
|
+
#
|
10320
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisteredUserQSearchBarEmbeddingConfiguration AWS API Documentation
|
10321
|
+
#
|
10322
|
+
class RegisteredUserQSearchBarEmbeddingConfiguration < Struct.new(
|
10323
|
+
:initial_topic_id)
|
10187
10324
|
SENSITIVE = []
|
10188
10325
|
include Aws::Structure
|
10189
10326
|
end
|
@@ -10478,11 +10615,16 @@ module Aws::QuickSight
|
|
10478
10615
|
# The number of rows that were not ingested.
|
10479
10616
|
# @return [Integer]
|
10480
10617
|
#
|
10618
|
+
# @!attribute [rw] total_rows_in_dataset
|
10619
|
+
# The total number of rows in the dataset.
|
10620
|
+
# @return [Integer]
|
10621
|
+
#
|
10481
10622
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RowInfo AWS API Documentation
|
10482
10623
|
#
|
10483
10624
|
class RowInfo < Struct.new(
|
10484
10625
|
:rows_ingested,
|
10485
|
-
:rows_dropped
|
10626
|
+
:rows_dropped,
|
10627
|
+
:total_rows_in_dataset)
|
10486
10628
|
SENSITIVE = []
|
10487
10629
|
include Aws::Structure
|
10488
10630
|
end
|
@@ -11365,7 +11507,7 @@ module Aws::QuickSight
|
|
11365
11507
|
#
|
11366
11508
|
# @!attribute [rw] template_id
|
11367
11509
|
# The ID for the template. This is unique per Amazon Web Services
|
11368
|
-
# Region
|
11510
|
+
# Region for each Amazon Web Services account.
|
11369
11511
|
# @return [String]
|
11370
11512
|
#
|
11371
11513
|
# @!attribute [rw] last_updated_time
|
@@ -11532,7 +11674,7 @@ module Aws::QuickSight
|
|
11532
11674
|
#
|
11533
11675
|
# @!attribute [rw] template_id
|
11534
11676
|
# The ID of the template. This ID is unique per Amazon Web Services
|
11535
|
-
# Region
|
11677
|
+
# Region for each Amazon Web Services account.
|
11536
11678
|
# @return [String]
|
11537
11679
|
#
|
11538
11680
|
# @!attribute [rw] name
|
@@ -11860,7 +12002,7 @@ module Aws::QuickSight
|
|
11860
12002
|
#
|
11861
12003
|
# @!attribute [rw] theme_id
|
11862
12004
|
# The ID of the theme. This ID is unique per Amazon Web Services
|
11863
|
-
# Region
|
12005
|
+
# Region for each Amazon Web Services account.
|
11864
12006
|
# @return [String]
|
11865
12007
|
#
|
11866
12008
|
# @!attribute [rw] latest_version_number
|
@@ -12441,7 +12583,7 @@ module Aws::QuickSight
|
|
12441
12583
|
#
|
12442
12584
|
# @!attribute [rw] account_customization
|
12443
12585
|
# The Amazon QuickSight customizations you're updating in the current
|
12444
|
-
# Amazon Web Services Region
|
12586
|
+
# Amazon Web Services Region.
|
12445
12587
|
# @return [Types::AccountCustomization]
|
12446
12588
|
#
|
12447
12589
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomizationRequest AWS API Documentation
|
@@ -12471,7 +12613,7 @@ module Aws::QuickSight
|
|
12471
12613
|
#
|
12472
12614
|
# @!attribute [rw] account_customization
|
12473
12615
|
# The Amazon QuickSight customizations you're updating in the current
|
12474
|
-
# Amazon Web Services Region
|
12616
|
+
# Amazon Web Services Region.
|
12475
12617
|
# @return [Types::AccountCustomization]
|
12476
12618
|
#
|
12477
12619
|
# @!attribute [rw] request_id
|
@@ -12979,7 +13121,7 @@ module Aws::QuickSight
|
|
12979
13121
|
# the CreateTemplate API operation. For `SourceTemplate`, specify the
|
12980
13122
|
# Amazon Resource Name (ARN) of the source template. The
|
12981
13123
|
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
12982
|
-
# any Amazon QuickSight-supported Amazon Web Services Region
|
13124
|
+
# any Amazon QuickSight-supported Amazon Web Services Region.
|
12983
13125
|
#
|
12984
13126
|
# Use the `DataSetReferences` entity within `SourceTemplate` to list
|
12985
13127
|
# the replacement datasets for the placeholders listed in the
|
@@ -13101,7 +13243,7 @@ module Aws::QuickSight
|
|
13101
13243
|
#
|
13102
13244
|
# @!attribute [rw] data_set_id
|
13103
13245
|
# The ID for the dataset whose permissions you want to update. This ID
|
13104
|
-
# is unique per Amazon Web Services Region
|
13246
|
+
# is unique per Amazon Web Services Region for each Amazon Web
|
13105
13247
|
# Services account.
|
13106
13248
|
# @return [String]
|
13107
13249
|
#
|
@@ -13130,7 +13272,7 @@ module Aws::QuickSight
|
|
13130
13272
|
#
|
13131
13273
|
# @!attribute [rw] data_set_id
|
13132
13274
|
# The ID for the dataset whose permissions you want to update. This ID
|
13133
|
-
# is unique per Amazon Web Services Region
|
13275
|
+
# is unique per Amazon Web Services Region for each Amazon Web
|
13134
13276
|
# Services account.
|
13135
13277
|
# @return [String]
|
13136
13278
|
#
|
@@ -13319,8 +13461,7 @@ module Aws::QuickSight
|
|
13319
13461
|
#
|
13320
13462
|
# @!attribute [rw] data_set_id
|
13321
13463
|
# The ID for the dataset that you want to update. This ID is unique
|
13322
|
-
# per Amazon Web Services Region
|
13323
|
-
# account.
|
13464
|
+
# per Amazon Web Services Region for each Amazon Web Services account.
|
13324
13465
|
# @return [String]
|
13325
13466
|
#
|
13326
13467
|
# @!attribute [rw] name
|
@@ -13396,8 +13537,7 @@ module Aws::QuickSight
|
|
13396
13537
|
#
|
13397
13538
|
# @!attribute [rw] data_set_id
|
13398
13539
|
# The ID for the dataset that you want to create. This ID is unique
|
13399
|
-
# per Amazon Web Services Region
|
13400
|
-
# account.
|
13540
|
+
# per Amazon Web Services Region for each Amazon Web Services account.
|
13401
13541
|
# @return [String]
|
13402
13542
|
#
|
13403
13543
|
# @!attribute [rw] ingestion_arn
|
@@ -13457,7 +13597,7 @@ module Aws::QuickSight
|
|
13457
13597
|
#
|
13458
13598
|
# @!attribute [rw] data_source_id
|
13459
13599
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
13460
|
-
# Region
|
13600
|
+
# Region for each Amazon Web Services account.
|
13461
13601
|
# @return [String]
|
13462
13602
|
#
|
13463
13603
|
# @!attribute [rw] grant_permissions
|
@@ -13487,7 +13627,7 @@ module Aws::QuickSight
|
|
13487
13627
|
#
|
13488
13628
|
# @!attribute [rw] data_source_id
|
13489
13629
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
13490
|
-
# Region
|
13630
|
+
# Region for each Amazon Web Services account.
|
13491
13631
|
# @return [String]
|
13492
13632
|
#
|
13493
13633
|
# @!attribute [rw] request_id
|
@@ -13606,6 +13746,9 @@ module Aws::QuickSight
|
|
13606
13746
|
# query: "Query", # required
|
13607
13747
|
# max_rows: 1, # required
|
13608
13748
|
# },
|
13749
|
+
# amazon_open_search_parameters: {
|
13750
|
+
# domain: "Domain", # required
|
13751
|
+
# },
|
13609
13752
|
# },
|
13610
13753
|
# credentials: {
|
13611
13754
|
# credential_pair: {
|
@@ -13702,6 +13845,9 @@ module Aws::QuickSight
|
|
13702
13845
|
# query: "Query", # required
|
13703
13846
|
# max_rows: 1, # required
|
13704
13847
|
# },
|
13848
|
+
# amazon_open_search_parameters: {
|
13849
|
+
# domain: "Domain", # required
|
13850
|
+
# },
|
13705
13851
|
# },
|
13706
13852
|
# ],
|
13707
13853
|
# },
|
@@ -13721,7 +13867,7 @@ module Aws::QuickSight
|
|
13721
13867
|
#
|
13722
13868
|
# @!attribute [rw] data_source_id
|
13723
13869
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
13724
|
-
# Region
|
13870
|
+
# Region for each Amazon Web Services account.
|
13725
13871
|
# @return [String]
|
13726
13872
|
#
|
13727
13873
|
# @!attribute [rw] name
|
@@ -13769,7 +13915,7 @@ module Aws::QuickSight
|
|
13769
13915
|
#
|
13770
13916
|
# @!attribute [rw] data_source_id
|
13771
13917
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
13772
|
-
# Region
|
13918
|
+
# Region for each Amazon Web Services account.
|
13773
13919
|
# @return [String]
|
13774
13920
|
#
|
13775
13921
|
# @!attribute [rw] update_status
|
@@ -14111,6 +14257,62 @@ module Aws::QuickSight
|
|
14111
14257
|
include Aws::Structure
|
14112
14258
|
end
|
14113
14259
|
|
14260
|
+
# @note When making an API call, you may pass UpdateIpRestrictionRequest
|
14261
|
+
# data as a hash:
|
14262
|
+
#
|
14263
|
+
# {
|
14264
|
+
# aws_account_id: "AwsAccountId", # required
|
14265
|
+
# ip_restriction_rule_map: {
|
14266
|
+
# "CIDR" => "IpRestrictionRuleDescription",
|
14267
|
+
# },
|
14268
|
+
# enabled: false,
|
14269
|
+
# }
|
14270
|
+
#
|
14271
|
+
# @!attribute [rw] aws_account_id
|
14272
|
+
# Your AWS account ID.
|
14273
|
+
# @return [String]
|
14274
|
+
#
|
14275
|
+
# @!attribute [rw] ip_restriction_rule_map
|
14276
|
+
# Describes updated IP rules.
|
14277
|
+
# @return [Hash<String,String>]
|
14278
|
+
#
|
14279
|
+
# @!attribute [rw] enabled
|
14280
|
+
# Whether or not IP rules are enabled.
|
14281
|
+
# @return [Boolean]
|
14282
|
+
#
|
14283
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateIpRestrictionRequest AWS API Documentation
|
14284
|
+
#
|
14285
|
+
class UpdateIpRestrictionRequest < Struct.new(
|
14286
|
+
:aws_account_id,
|
14287
|
+
:ip_restriction_rule_map,
|
14288
|
+
:enabled)
|
14289
|
+
SENSITIVE = []
|
14290
|
+
include Aws::Structure
|
14291
|
+
end
|
14292
|
+
|
14293
|
+
# @!attribute [rw] aws_account_id
|
14294
|
+
# Your AWS account ID.
|
14295
|
+
# @return [String]
|
14296
|
+
#
|
14297
|
+
# @!attribute [rw] request_id
|
14298
|
+
# The ID of the update request.
|
14299
|
+
# @return [String]
|
14300
|
+
#
|
14301
|
+
# @!attribute [rw] status
|
14302
|
+
# The status of the updated IP rules. A successful request returns a
|
14303
|
+
# 200 code.
|
14304
|
+
# @return [Integer]
|
14305
|
+
#
|
14306
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateIpRestrictionResponse AWS API Documentation
|
14307
|
+
#
|
14308
|
+
class UpdateIpRestrictionResponse < Struct.new(
|
14309
|
+
:aws_account_id,
|
14310
|
+
:request_id,
|
14311
|
+
:status)
|
14312
|
+
SENSITIVE = []
|
14313
|
+
include Aws::Structure
|
14314
|
+
end
|
14315
|
+
|
14114
14316
|
# @note When making an API call, you may pass UpdateTemplateAliasRequest
|
14115
14317
|
# data as a hash:
|
14116
14318
|
#
|