aws-sdk-quicksight 1.76.0 → 1.78.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight/client.rb +417 -28
- data/lib/aws-sdk-quicksight/client_api.rb +282 -0
- data/lib/aws-sdk-quicksight/endpoints.rb +112 -0
- data/lib/aws-sdk-quicksight/plugins/endpoints.rb +16 -0
- data/lib/aws-sdk-quicksight/types.rb +782 -182
- data/lib/aws-sdk-quicksight.rb +1 -1
- metadata +2 -2
@@ -14,7 +14,7 @@ module Aws::QuickSight
|
|
14
14
|
# couldn't be validated. You might not be authorized to carry out the
|
15
15
|
# request. Make sure that your account is authorized to use the Amazon
|
16
16
|
# QuickSight service, that your policies have the correct permissions,
|
17
|
-
# and that you are using the correct
|
17
|
+
# and that you are using the correct credentials.
|
18
18
|
#
|
19
19
|
# @!attribute [rw] message
|
20
20
|
# @return [String]
|
@@ -203,25 +203,25 @@ module Aws::QuickSight
|
|
203
203
|
# @!attribute [rw] categorical_aggregation_function
|
204
204
|
# Aggregation for categorical values.
|
205
205
|
#
|
206
|
-
# * `COUNT
|
206
|
+
# * `COUNT`: Aggregate by the total number of values, including
|
207
207
|
# duplicates.
|
208
208
|
#
|
209
|
-
# * `DISTINCT_COUNT
|
209
|
+
# * `DISTINCT_COUNT`: Aggregate by the total number of distinct
|
210
210
|
# values.
|
211
211
|
# @return [String]
|
212
212
|
#
|
213
213
|
# @!attribute [rw] date_aggregation_function
|
214
214
|
# Aggregation for date values.
|
215
215
|
#
|
216
|
-
# * `COUNT
|
216
|
+
# * `COUNT`: Aggregate by the total number of values, including
|
217
217
|
# duplicates.
|
218
218
|
#
|
219
|
-
# * `DISTINCT_COUNT
|
219
|
+
# * `DISTINCT_COUNT`: Aggregate by the total number of distinct
|
220
220
|
# values.
|
221
221
|
#
|
222
|
-
# * `MIN
|
222
|
+
# * `MIN`: Select the smallest date value.
|
223
223
|
#
|
224
|
-
# * `MAX
|
224
|
+
# * `MAX`: Select the largest date value.
|
225
225
|
# @return [String]
|
226
226
|
#
|
227
227
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AggregationFunction AWS API Documentation
|
@@ -243,9 +243,9 @@ module Aws::QuickSight
|
|
243
243
|
# @!attribute [rw] sort_direction
|
244
244
|
# The sort direction of values.
|
245
245
|
#
|
246
|
-
# * `ASC
|
246
|
+
# * `ASC`: Sort in ascending order.
|
247
247
|
#
|
248
|
-
# * `DESC
|
248
|
+
# * `DESC`: Sort in descending order.
|
249
249
|
# @return [String]
|
250
250
|
#
|
251
251
|
# @!attribute [rw] aggregation_function
|
@@ -442,6 +442,7 @@ module Aws::QuickSight
|
|
442
442
|
# @return [String]
|
443
443
|
#
|
444
444
|
# @!attribute [rw] violated_entities
|
445
|
+
# Lists the violated entities that caused the analysis error
|
445
446
|
# @return [Array<Types::Entity>]
|
446
447
|
#
|
447
448
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnalysisError AWS API Documentation
|
@@ -481,32 +482,32 @@ module Aws::QuickSight
|
|
481
482
|
#
|
482
483
|
# Valid values are defined as follows:
|
483
484
|
#
|
484
|
-
# * `QUICKSIGHT_VIEWER_OR_OWNER
|
485
|
+
# * `QUICKSIGHT_VIEWER_OR_OWNER`: Provide an ARN of a user or group,
|
485
486
|
# and any analyses with that ARN listed as one of the analysis'
|
486
487
|
# owners or viewers are returned. Implicit permissions from folders
|
487
488
|
# or groups are considered.
|
488
489
|
#
|
489
|
-
# * `QUICKSIGHT_OWNER
|
490
|
+
# * `QUICKSIGHT_OWNER`: Provide an ARN of a user or group, and any
|
490
491
|
# analyses with that ARN listed as one of the owners of the analyses
|
491
492
|
# are returned. Implicit permissions from folders or groups are
|
492
493
|
# considered.
|
493
494
|
#
|
494
|
-
# * `DIRECT_QUICKSIGHT_SOLE_OWNER
|
495
|
-
#
|
496
|
-
#
|
497
|
-
#
|
495
|
+
# * `DIRECT_QUICKSIGHT_SOLE_OWNER`: Provide an ARN of a user or group,
|
496
|
+
# and any analyses with that ARN listed as the only owner of the
|
497
|
+
# analysis are returned. Implicit permissions from folders or groups
|
498
|
+
# are not considered.
|
498
499
|
#
|
499
|
-
# * `DIRECT_QUICKSIGHT_OWNER
|
500
|
+
# * `DIRECT_QUICKSIGHT_OWNER`: Provide an ARN of a user or group, and
|
500
501
|
# any analyses with that ARN listed as one of the owners of the
|
501
502
|
# analyses are returned. Implicit permissions from folders or groups
|
502
503
|
# are not considered.
|
503
504
|
#
|
504
|
-
# * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER
|
505
|
+
# * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER`: Provide an ARN of a user or
|
505
506
|
# group, and any analyses with that ARN listed as one of the owners
|
506
507
|
# or viewers of the analyses are returned. Implicit permissions from
|
507
508
|
# folders or groups are not considered.
|
508
509
|
#
|
509
|
-
# * `ANALYSIS_NAME
|
510
|
+
# * `ANALYSIS_NAME`: Any analyses whose names have a substring match
|
510
511
|
# to this value will be returned.
|
511
512
|
# @return [String]
|
512
513
|
#
|
@@ -1150,11 +1151,11 @@ module Aws::QuickSight
|
|
1150
1151
|
# The orientation of the bars in a bar chart visual. There are two
|
1151
1152
|
# valid values in this structure:
|
1152
1153
|
#
|
1153
|
-
# * `HORIZONTAL
|
1154
|
+
# * `HORIZONTAL`: Used for charts that have horizontal bars. Visuals
|
1154
1155
|
# that use this value are horizontal bar charts, horizontal stacked
|
1155
1156
|
# bar charts, and horizontal stacked 100% bar charts.
|
1156
1157
|
#
|
1157
|
-
# * `VERTICAL
|
1158
|
+
# * `VERTICAL`: Used for charts that have vertical bars. Visuals that
|
1158
1159
|
# use this value are vertical bar charts, vertical stacked bar
|
1159
1160
|
# charts, and vertical stacked 100% bar charts.
|
1160
1161
|
# @return [String]
|
@@ -1995,9 +1996,9 @@ module Aws::QuickSight
|
|
1995
1996
|
# The visibility of an axis label on a chart. Choose one of the
|
1996
1997
|
# following options:
|
1997
1998
|
#
|
1998
|
-
# * `VISIBLE
|
1999
|
+
# * `VISIBLE`: Shows the axis.
|
1999
2000
|
#
|
2000
|
-
# * `HIDDEN
|
2001
|
+
# * `HIDDEN`: Hides the axis.
|
2001
2002
|
# @return [String]
|
2002
2003
|
#
|
2003
2004
|
# @!attribute [rw] sort_icon_visibility
|
@@ -2374,11 +2375,11 @@ module Aws::QuickSight
|
|
2374
2375
|
# Determines the bar arrangement in a combo chart. The following are
|
2375
2376
|
# valid values in this structure:
|
2376
2377
|
#
|
2377
|
-
# * `CLUSTERED
|
2378
|
+
# * `CLUSTERED`: For clustered bar combo charts.
|
2378
2379
|
#
|
2379
|
-
# * `STACKED
|
2380
|
+
# * `STACKED`: For stacked bar combo charts.
|
2380
2381
|
#
|
2381
|
-
# * `STACKED_PERCENT
|
2382
|
+
# * `STACKED_PERCENT`: Do not use. If you use this value, the
|
2382
2383
|
# operation returns a validation error.
|
2383
2384
|
# @return [String]
|
2384
2385
|
#
|
@@ -4116,6 +4117,55 @@ module Aws::QuickSight
|
|
4116
4117
|
include Aws::Structure
|
4117
4118
|
end
|
4118
4119
|
|
4120
|
+
# @!attribute [rw] data_set_id
|
4121
|
+
# The ID of the dataset.
|
4122
|
+
# @return [String]
|
4123
|
+
#
|
4124
|
+
# @!attribute [rw] aws_account_id
|
4125
|
+
# The Amazon Web Services account ID.
|
4126
|
+
# @return [String]
|
4127
|
+
#
|
4128
|
+
# @!attribute [rw] schedule
|
4129
|
+
# The refresh schedule.
|
4130
|
+
# @return [Types::RefreshSchedule]
|
4131
|
+
#
|
4132
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateRefreshScheduleRequest AWS API Documentation
|
4133
|
+
#
|
4134
|
+
class CreateRefreshScheduleRequest < Struct.new(
|
4135
|
+
:data_set_id,
|
4136
|
+
:aws_account_id,
|
4137
|
+
:schedule)
|
4138
|
+
SENSITIVE = []
|
4139
|
+
include Aws::Structure
|
4140
|
+
end
|
4141
|
+
|
4142
|
+
# @!attribute [rw] status
|
4143
|
+
# The HTTP status of the request.
|
4144
|
+
# @return [Integer]
|
4145
|
+
#
|
4146
|
+
# @!attribute [rw] request_id
|
4147
|
+
# The Amazon Web Services request ID for this operation.
|
4148
|
+
# @return [String]
|
4149
|
+
#
|
4150
|
+
# @!attribute [rw] schedule_id
|
4151
|
+
# The ID of the refresh schedule.
|
4152
|
+
# @return [String]
|
4153
|
+
#
|
4154
|
+
# @!attribute [rw] arn
|
4155
|
+
# The Amazon Resource Name (ARN) for the refresh schedule.
|
4156
|
+
# @return [String]
|
4157
|
+
#
|
4158
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateRefreshScheduleResponse AWS API Documentation
|
4159
|
+
#
|
4160
|
+
class CreateRefreshScheduleResponse < Struct.new(
|
4161
|
+
:status,
|
4162
|
+
:request_id,
|
4163
|
+
:schedule_id,
|
4164
|
+
:arn)
|
4165
|
+
SENSITIVE = []
|
4166
|
+
include Aws::Structure
|
4167
|
+
end
|
4168
|
+
|
4119
4169
|
# @!attribute [rw] aws_account_id
|
4120
4170
|
# The ID of the Amazon Web Services account that contains the template
|
4121
4171
|
# that you creating an alias for.
|
@@ -4576,11 +4626,11 @@ module Aws::QuickSight
|
|
4576
4626
|
#
|
4577
4627
|
# Valid values are defined as follows:
|
4578
4628
|
#
|
4579
|
-
# * `NEW_TAB
|
4629
|
+
# * `NEW_TAB`: Opens the target URL in a new browser tab.
|
4580
4630
|
#
|
4581
|
-
# * `NEW_WINDOW
|
4631
|
+
# * `NEW_WINDOW`: Opens the target URL in a new browser window.
|
4582
4632
|
#
|
4583
|
-
# * `SAME_TAB
|
4633
|
+
# * `SAME_TAB`: Opens the target URL in the same browser tab.
|
4584
4634
|
# @return [String]
|
4585
4635
|
#
|
4586
4636
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CustomActionURLOperation AWS API Documentation
|
@@ -4703,11 +4753,11 @@ module Aws::QuickSight
|
|
4703
4753
|
# This option determines how null values should be treated when
|
4704
4754
|
# filtering data.
|
4705
4755
|
#
|
4706
|
-
# * `ALL_VALUES
|
4756
|
+
# * `ALL_VALUES`: Include null values in filtered results.
|
4707
4757
|
#
|
4708
|
-
# * `NULLS_ONLY
|
4758
|
+
# * `NULLS_ONLY`: Only include null values in filtered results.
|
4709
4759
|
#
|
4710
|
-
# * `NON_NULLS_ONLY
|
4760
|
+
# * `NON_NULLS_ONLY`: Exclude null values from filtered results.
|
4711
4761
|
# @return [String]
|
4712
4762
|
#
|
4713
4763
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CustomFilterConfiguration AWS API Documentation
|
@@ -4746,11 +4796,11 @@ module Aws::QuickSight
|
|
4746
4796
|
# This option determines how null values should be treated when
|
4747
4797
|
# filtering data.
|
4748
4798
|
#
|
4749
|
-
# * `ALL_VALUES
|
4799
|
+
# * `ALL_VALUES`: Include null values in filtered results.
|
4750
4800
|
#
|
4751
|
-
# * `NULLS_ONLY
|
4801
|
+
# * `NULLS_ONLY`: Only include null values in filtered results.
|
4752
4802
|
#
|
4753
|
-
# * `NON_NULLS_ONLY
|
4803
|
+
# * `NON_NULLS_ONLY`: Exclude null values from filtered results.
|
4754
4804
|
# @return [String]
|
4755
4805
|
#
|
4756
4806
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CustomFilterListConfiguration AWS API Documentation
|
@@ -5021,32 +5071,32 @@ module Aws::QuickSight
|
|
5021
5071
|
#
|
5022
5072
|
# Valid values are defined as follows:
|
5023
5073
|
#
|
5024
|
-
# * `QUICKSIGHT_VIEWER_OR_OWNER
|
5074
|
+
# * `QUICKSIGHT_VIEWER_OR_OWNER`: Provide an ARN of a user or group,
|
5025
5075
|
# and any dashboards with that ARN listed as one of the
|
5026
5076
|
# dashboards's owners or viewers are returned. Implicit permissions
|
5027
5077
|
# from folders or groups are considered.
|
5028
5078
|
#
|
5029
|
-
# * `QUICKSIGHT_OWNER
|
5079
|
+
# * `QUICKSIGHT_OWNER`: Provide an ARN of a user or group, and any
|
5030
5080
|
# dashboards with that ARN listed as one of the owners of the
|
5031
5081
|
# dashboards are returned. Implicit permissions from folders or
|
5032
5082
|
# groups are considered.
|
5033
5083
|
#
|
5034
|
-
# * `DIRECT_QUICKSIGHT_SOLE_OWNER
|
5035
|
-
#
|
5036
|
-
#
|
5037
|
-
#
|
5084
|
+
# * `DIRECT_QUICKSIGHT_SOLE_OWNER`: Provide an ARN of a user or group,
|
5085
|
+
# and any dashboards with that ARN listed as the only owner of the
|
5086
|
+
# dashboard are returned. Implicit permissions from folders or
|
5087
|
+
# groups are not considered.
|
5038
5088
|
#
|
5039
|
-
# * `DIRECT_QUICKSIGHT_OWNER
|
5089
|
+
# * `DIRECT_QUICKSIGHT_OWNER`: Provide an ARN of a user or group, and
|
5040
5090
|
# any dashboards with that ARN listed as one of the owners of the
|
5041
5091
|
# dashboards are returned. Implicit permissions from folders or
|
5042
5092
|
# groups are not considered.
|
5043
5093
|
#
|
5044
|
-
# * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER
|
5094
|
+
# * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER`: Provide an ARN of a user or
|
5045
5095
|
# group, and any dashboards with that ARN listed as one of the
|
5046
5096
|
# owners or viewers of the dashboards are returned. Implicit
|
5047
5097
|
# permissions from folders or groups are not considered.
|
5048
5098
|
#
|
5049
|
-
# * `DASHBOARD_NAME
|
5099
|
+
# * `DASHBOARD_NAME`: Any dashboards whose names have a substring
|
5050
5100
|
# match to this value will be returned.
|
5051
5101
|
# @return [String]
|
5052
5102
|
#
|
@@ -5853,6 +5903,20 @@ module Aws::QuickSight
|
|
5853
5903
|
include Aws::Structure
|
5854
5904
|
end
|
5855
5905
|
|
5906
|
+
# The refresh properties of a dataset.
|
5907
|
+
#
|
5908
|
+
# @!attribute [rw] refresh_configuration
|
5909
|
+
# The refresh configuration for a dataset.
|
5910
|
+
# @return [Types::RefreshConfiguration]
|
5911
|
+
#
|
5912
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetRefreshProperties AWS API Documentation
|
5913
|
+
#
|
5914
|
+
class DataSetRefreshProperties < Struct.new(
|
5915
|
+
:refresh_configuration)
|
5916
|
+
SENSITIVE = []
|
5917
|
+
include Aws::Structure
|
5918
|
+
end
|
5919
|
+
|
5856
5920
|
# Dataset schema.
|
5857
5921
|
#
|
5858
5922
|
# @!attribute [rw] column_schema_list
|
@@ -5894,33 +5958,33 @@ module Aws::QuickSight
|
|
5894
5958
|
#
|
5895
5959
|
# Valid values are defined as follows:
|
5896
5960
|
#
|
5897
|
-
# * `QUICKSIGHT_VIEWER_OR_OWNER
|
5961
|
+
# * `QUICKSIGHT_VIEWER_OR_OWNER`: Provide an ARN of a user or group,
|
5898
5962
|
# and any datasets with that ARN listed as one of the dataset owners
|
5899
5963
|
# or viewers are returned. Implicit permissions from folders or
|
5900
5964
|
# groups are considered.
|
5901
5965
|
#
|
5902
|
-
# * `QUICKSIGHT_OWNER
|
5966
|
+
# * `QUICKSIGHT_OWNER`: Provide an ARN of a user or group, and any
|
5903
5967
|
# datasets with that ARN listed as one of the owners of the dataset
|
5904
5968
|
# are returned. Implicit permissions from folders or groups are
|
5905
5969
|
# considered.
|
5906
5970
|
#
|
5907
|
-
# * `DIRECT_QUICKSIGHT_SOLE_OWNER
|
5908
|
-
#
|
5909
|
-
#
|
5910
|
-
#
|
5971
|
+
# * `DIRECT_QUICKSIGHT_SOLE_OWNER`: Provide an ARN of a user or group,
|
5972
|
+
# and any datasets with that ARN listed as the only owner of the
|
5973
|
+
# dataset are returned. Implicit permissions from folders or groups
|
5974
|
+
# are not considered.
|
5911
5975
|
#
|
5912
|
-
# * `DIRECT_QUICKSIGHT_OWNER
|
5976
|
+
# * `DIRECT_QUICKSIGHT_OWNER`: Provide an ARN of a user or group, and
|
5913
5977
|
# any datasets with that ARN listed as one of the owners if the
|
5914
5978
|
# dataset are returned. Implicit permissions from folders or groups
|
5915
5979
|
# are not considered.
|
5916
5980
|
#
|
5917
|
-
# * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER
|
5981
|
+
# * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER`: Provide an ARN of a user or
|
5918
5982
|
# group, and any datasets with that ARN listed as one of the owners
|
5919
5983
|
# or viewers of the dataset are returned. Implicit permissions from
|
5920
5984
|
# folders or groups are not considered.
|
5921
5985
|
#
|
5922
|
-
# * `DATASET_NAME
|
5923
|
-
#
|
5986
|
+
# * `DATASET_NAME`: Any datasets whose names have a substring match to
|
5987
|
+
# this value will be returned.
|
5924
5988
|
# @return [String]
|
5925
5989
|
#
|
5926
5990
|
# @!attribute [rw] value
|
@@ -6312,22 +6376,22 @@ module Aws::QuickSight
|
|
6312
6376
|
#
|
6313
6377
|
# Valid values are defined as follows:
|
6314
6378
|
#
|
6315
|
-
# * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER
|
6379
|
+
# * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER`: Provide an ARN of a user or
|
6316
6380
|
# group, and any data sources with that ARN listed as one of the
|
6317
6381
|
# owners or viewers of the data sources are returned. Implicit
|
6318
6382
|
# permissions from folders or groups are not considered.
|
6319
6383
|
#
|
6320
|
-
# * `DIRECT_QUICKSIGHT_OWNER
|
6384
|
+
# * `DIRECT_QUICKSIGHT_OWNER`: Provide an ARN of a user or group, and
|
6321
6385
|
# any data sources with that ARN listed as one of the owners if the
|
6322
6386
|
# data source are returned. Implicit permissions from folders or
|
6323
6387
|
# groups are not considered.
|
6324
6388
|
#
|
6325
|
-
# * `DIRECT_QUICKSIGHT_SOLE_OWNER
|
6326
|
-
#
|
6327
|
-
#
|
6328
|
-
#
|
6389
|
+
# * `DIRECT_QUICKSIGHT_SOLE_OWNER`: Provide an ARN of a user or group,
|
6390
|
+
# and any data sources with that ARN listed as the only owner of the
|
6391
|
+
# data source are returned. Implicit permissions from folders or
|
6392
|
+
# groups are not considered.
|
6329
6393
|
#
|
6330
|
-
# * `DATASOURCE_NAME
|
6394
|
+
# * `DATASOURCE_NAME`: Any data sources whose names have a substring
|
6331
6395
|
# match to the provided value are returned.
|
6332
6396
|
# @return [String]
|
6333
6397
|
#
|
@@ -6657,9 +6721,9 @@ module Aws::QuickSight
|
|
6657
6721
|
# The built-in options for default values. The value can be one of the
|
6658
6722
|
# following:
|
6659
6723
|
#
|
6660
|
-
# * `RECOMMENDED
|
6724
|
+
# * `RECOMMENDED`: The recommended value.
|
6661
6725
|
#
|
6662
|
-
# * `NULL
|
6726
|
+
# * `NULL`: The `NULL` value.
|
6663
6727
|
# @return [String]
|
6664
6728
|
#
|
6665
6729
|
# @!attribute [rw] custom_value
|
@@ -6769,9 +6833,9 @@ module Aws::QuickSight
|
|
6769
6833
|
# The built-in options for default values. The value can be one of the
|
6770
6834
|
# following:
|
6771
6835
|
#
|
6772
|
-
# * `RECOMMENDED
|
6836
|
+
# * `RECOMMENDED`: The recommended value.
|
6773
6837
|
#
|
6774
|
-
# * `NULL
|
6838
|
+
# * `NULL`: The `NULL` value.
|
6775
6839
|
# @return [String]
|
6776
6840
|
#
|
6777
6841
|
# @!attribute [rw] custom_value
|
@@ -7083,6 +7147,40 @@ module Aws::QuickSight
|
|
7083
7147
|
include Aws::Structure
|
7084
7148
|
end
|
7085
7149
|
|
7150
|
+
# @!attribute [rw] aws_account_id
|
7151
|
+
# The Amazon Web Services account ID.
|
7152
|
+
# @return [String]
|
7153
|
+
#
|
7154
|
+
# @!attribute [rw] data_set_id
|
7155
|
+
# The ID of the dataset.
|
7156
|
+
# @return [String]
|
7157
|
+
#
|
7158
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDataSetRefreshPropertiesRequest AWS API Documentation
|
7159
|
+
#
|
7160
|
+
class DeleteDataSetRefreshPropertiesRequest < Struct.new(
|
7161
|
+
:aws_account_id,
|
7162
|
+
:data_set_id)
|
7163
|
+
SENSITIVE = []
|
7164
|
+
include Aws::Structure
|
7165
|
+
end
|
7166
|
+
|
7167
|
+
# @!attribute [rw] request_id
|
7168
|
+
# The Amazon Web Services request ID for this operation.
|
7169
|
+
# @return [String]
|
7170
|
+
#
|
7171
|
+
# @!attribute [rw] status
|
7172
|
+
# The HTTP status of the request.
|
7173
|
+
# @return [Integer]
|
7174
|
+
#
|
7175
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDataSetRefreshPropertiesResponse AWS API Documentation
|
7176
|
+
#
|
7177
|
+
class DeleteDataSetRefreshPropertiesResponse < Struct.new(
|
7178
|
+
:request_id,
|
7179
|
+
:status)
|
7180
|
+
SENSITIVE = []
|
7181
|
+
include Aws::Structure
|
7182
|
+
end
|
7183
|
+
|
7086
7184
|
# @!attribute [rw] aws_account_id
|
7087
7185
|
# The Amazon Web Services account ID.
|
7088
7186
|
# @return [String]
|
@@ -7433,6 +7531,55 @@ module Aws::QuickSight
|
|
7433
7531
|
include Aws::Structure
|
7434
7532
|
end
|
7435
7533
|
|
7534
|
+
# @!attribute [rw] data_set_id
|
7535
|
+
# The ID of the dataset.
|
7536
|
+
# @return [String]
|
7537
|
+
#
|
7538
|
+
# @!attribute [rw] aws_account_id
|
7539
|
+
# The Amazon Web Services account ID.
|
7540
|
+
# @return [String]
|
7541
|
+
#
|
7542
|
+
# @!attribute [rw] schedule_id
|
7543
|
+
# The ID of the refresh schedule.
|
7544
|
+
# @return [String]
|
7545
|
+
#
|
7546
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteRefreshScheduleRequest AWS API Documentation
|
7547
|
+
#
|
7548
|
+
class DeleteRefreshScheduleRequest < Struct.new(
|
7549
|
+
:data_set_id,
|
7550
|
+
:aws_account_id,
|
7551
|
+
:schedule_id)
|
7552
|
+
SENSITIVE = []
|
7553
|
+
include Aws::Structure
|
7554
|
+
end
|
7555
|
+
|
7556
|
+
# @!attribute [rw] status
|
7557
|
+
# The HTTP status of the request.
|
7558
|
+
# @return [Integer]
|
7559
|
+
#
|
7560
|
+
# @!attribute [rw] request_id
|
7561
|
+
# The Amazon Web Services request ID for this operation.
|
7562
|
+
# @return [String]
|
7563
|
+
#
|
7564
|
+
# @!attribute [rw] schedule_id
|
7565
|
+
# The ID of the refresh schedule.
|
7566
|
+
# @return [String]
|
7567
|
+
#
|
7568
|
+
# @!attribute [rw] arn
|
7569
|
+
# The Amazon Resource Name (ARN) for the refresh schedule.
|
7570
|
+
# @return [String]
|
7571
|
+
#
|
7572
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteRefreshScheduleResponse AWS API Documentation
|
7573
|
+
#
|
7574
|
+
class DeleteRefreshScheduleResponse < Struct.new(
|
7575
|
+
:status,
|
7576
|
+
:request_id,
|
7577
|
+
:schedule_id,
|
7578
|
+
:arn)
|
7579
|
+
SENSITIVE = []
|
7580
|
+
include Aws::Structure
|
7581
|
+
end
|
7582
|
+
|
7436
7583
|
# @!attribute [rw] aws_account_id
|
7437
7584
|
# The ID of the Amazon Web Services account that contains the item to
|
7438
7585
|
# delete.
|
@@ -8352,6 +8499,45 @@ module Aws::QuickSight
|
|
8352
8499
|
include Aws::Structure
|
8353
8500
|
end
|
8354
8501
|
|
8502
|
+
# @!attribute [rw] aws_account_id
|
8503
|
+
# The Amazon Web Services account ID.
|
8504
|
+
# @return [String]
|
8505
|
+
#
|
8506
|
+
# @!attribute [rw] data_set_id
|
8507
|
+
# The ID of the dataset.
|
8508
|
+
# @return [String]
|
8509
|
+
#
|
8510
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSetRefreshPropertiesRequest AWS API Documentation
|
8511
|
+
#
|
8512
|
+
class DescribeDataSetRefreshPropertiesRequest < Struct.new(
|
8513
|
+
:aws_account_id,
|
8514
|
+
:data_set_id)
|
8515
|
+
SENSITIVE = []
|
8516
|
+
include Aws::Structure
|
8517
|
+
end
|
8518
|
+
|
8519
|
+
# @!attribute [rw] request_id
|
8520
|
+
# The Amazon Web Services request ID for this operation.
|
8521
|
+
# @return [String]
|
8522
|
+
#
|
8523
|
+
# @!attribute [rw] status
|
8524
|
+
# The HTTP status of the request.
|
8525
|
+
# @return [Integer]
|
8526
|
+
#
|
8527
|
+
# @!attribute [rw] data_set_refresh_properties
|
8528
|
+
# The dataset refresh properties.
|
8529
|
+
# @return [Types::DataSetRefreshProperties]
|
8530
|
+
#
|
8531
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSetRefreshPropertiesResponse AWS API Documentation
|
8532
|
+
#
|
8533
|
+
class DescribeDataSetRefreshPropertiesResponse < Struct.new(
|
8534
|
+
:request_id,
|
8535
|
+
:status,
|
8536
|
+
:data_set_refresh_properties)
|
8537
|
+
SENSITIVE = []
|
8538
|
+
include Aws::Structure
|
8539
|
+
end
|
8540
|
+
|
8355
8541
|
# @!attribute [rw] aws_account_id
|
8356
8542
|
# The Amazon Web Services account ID.
|
8357
8543
|
# @return [String]
|
@@ -8898,6 +9084,55 @@ module Aws::QuickSight
|
|
8898
9084
|
include Aws::Structure
|
8899
9085
|
end
|
8900
9086
|
|
9087
|
+
# @!attribute [rw] aws_account_id
|
9088
|
+
# The Amazon Web Services account ID.
|
9089
|
+
# @return [String]
|
9090
|
+
#
|
9091
|
+
# @!attribute [rw] data_set_id
|
9092
|
+
# The ID of the dataset.
|
9093
|
+
# @return [String]
|
9094
|
+
#
|
9095
|
+
# @!attribute [rw] schedule_id
|
9096
|
+
# The ID of the refresh schedule.
|
9097
|
+
# @return [String]
|
9098
|
+
#
|
9099
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeRefreshScheduleRequest AWS API Documentation
|
9100
|
+
#
|
9101
|
+
class DescribeRefreshScheduleRequest < Struct.new(
|
9102
|
+
:aws_account_id,
|
9103
|
+
:data_set_id,
|
9104
|
+
:schedule_id)
|
9105
|
+
SENSITIVE = []
|
9106
|
+
include Aws::Structure
|
9107
|
+
end
|
9108
|
+
|
9109
|
+
# @!attribute [rw] refresh_schedule
|
9110
|
+
# The refresh schedule.
|
9111
|
+
# @return [Types::RefreshSchedule]
|
9112
|
+
#
|
9113
|
+
# @!attribute [rw] status
|
9114
|
+
# The HTTP status of the request.
|
9115
|
+
# @return [Integer]
|
9116
|
+
#
|
9117
|
+
# @!attribute [rw] request_id
|
9118
|
+
# The Amazon Web Services request ID for this operation.
|
9119
|
+
# @return [String]
|
9120
|
+
#
|
9121
|
+
# @!attribute [rw] arn
|
9122
|
+
# The Amazon Resource Name (ARN) for the refresh schedule.
|
9123
|
+
# @return [String]
|
9124
|
+
#
|
9125
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeRefreshScheduleResponse AWS API Documentation
|
9126
|
+
#
|
9127
|
+
class DescribeRefreshScheduleResponse < Struct.new(
|
9128
|
+
:refresh_schedule,
|
9129
|
+
:status,
|
9130
|
+
:request_id,
|
9131
|
+
:arn)
|
9132
|
+
SENSITIVE = []
|
9133
|
+
include Aws::Structure
|
9134
|
+
end
|
9135
|
+
|
8901
9136
|
# @!attribute [rw] aws_account_id
|
8902
9137
|
# The ID of the Amazon Web Services account that contains the template
|
8903
9138
|
# alias that you're describing.
|
@@ -9736,9 +9971,9 @@ module Aws::QuickSight
|
|
9736
9971
|
# The type for the >tooltip title. Choose one of the following
|
9737
9972
|
# options:
|
9738
9973
|
#
|
9739
|
-
# * `NONE
|
9974
|
+
# * `NONE`: Doesn't use the primary value as the title.
|
9740
9975
|
#
|
9741
|
-
# * `PRIMARY_VALUE
|
9976
|
+
# * `PRIMARY_VALUE`: Uses primary value as the title.
|
9742
9977
|
# @return [String]
|
9743
9978
|
#
|
9744
9979
|
# @!attribute [rw] tooltip_fields
|
@@ -9829,9 +10064,9 @@ module Aws::QuickSight
|
|
9829
10064
|
# @!attribute [rw] direction
|
9830
10065
|
# The sort direction. Choose one of the following options:
|
9831
10066
|
#
|
9832
|
-
# * `ASC
|
10067
|
+
# * `ASC`: Ascending
|
9833
10068
|
#
|
9834
|
-
# * `DESC
|
10069
|
+
# * `DESC`: Descending
|
9835
10070
|
# @return [String]
|
9836
10071
|
#
|
9837
10072
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FieldSort AWS API Documentation
|
@@ -10219,9 +10454,9 @@ module Aws::QuickSight
|
|
10219
10454
|
# The date time picker type of a `FilterDateTimePickerControl`. Choose
|
10220
10455
|
# one of the following options:
|
10221
10456
|
#
|
10222
|
-
# * `SINGLE_VALUED
|
10457
|
+
# * `SINGLE_VALUED`: The filter condition is a fixed date.
|
10223
10458
|
#
|
10224
|
-
# * `DATE_RANGE
|
10459
|
+
# * `DATE_RANGE`: The filter condition is a date time range.
|
10225
10460
|
# @return [String]
|
10226
10461
|
#
|
10227
10462
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FilterDateTimePickerControl AWS API Documentation
|
@@ -10259,10 +10494,10 @@ module Aws::QuickSight
|
|
10259
10494
|
# The type of the `FilterDropDownControl`. Choose one of the following
|
10260
10495
|
# options:
|
10261
10496
|
#
|
10262
|
-
# * `MULTI_SELECT
|
10497
|
+
# * `MULTI_SELECT`: The user can select multiple entries from a
|
10263
10498
|
# dropdown menu.
|
10264
10499
|
#
|
10265
|
-
# * `SINGLE_SELECT
|
10500
|
+
# * `SINGLE_SELECT`: The user can select a single entry from a
|
10266
10501
|
# dropdown menu.
|
10267
10502
|
# @return [String]
|
10268
10503
|
#
|
@@ -10395,11 +10630,10 @@ module Aws::QuickSight
|
|
10395
10630
|
# The type of `FilterListControl`. Choose one of the following
|
10396
10631
|
# options:
|
10397
10632
|
#
|
10398
|
-
# * `MULTI_SELECT
|
10633
|
+
# * `MULTI_SELECT`: The user can select multiple entries from the
|
10399
10634
|
# list.
|
10400
10635
|
#
|
10401
|
-
# * `SINGLE_SELECT
|
10402
|
-
# list.
|
10636
|
+
# * `SINGLE_SELECT`: The user can select a single entry from the list.
|
10403
10637
|
# @return [String]
|
10404
10638
|
#
|
10405
10639
|
# @!attribute [rw] selectable_values
|
@@ -10458,7 +10692,7 @@ module Aws::QuickSight
|
|
10458
10692
|
#
|
10459
10693
|
# Valid values are defined as follows:
|
10460
10694
|
#
|
10461
|
-
# * `ALL_FIELDS
|
10695
|
+
# * `ALL_FIELDS`: Applies the filter operation to all fields.
|
10462
10696
|
#
|
10463
10697
|
# ^
|
10464
10698
|
# @return [String]
|
@@ -10574,9 +10808,9 @@ module Aws::QuickSight
|
|
10574
10808
|
# The type of `FilterSliderControl`. Choose one of the following
|
10575
10809
|
# options:
|
10576
10810
|
#
|
10577
|
-
# * `SINGLE_POINT
|
10811
|
+
# * `SINGLE_POINT`: Filter against(equals) a single data point.
|
10578
10812
|
#
|
10579
|
-
# * `RANGE
|
10813
|
+
# * `RANGE`: Filter data that is in a specified range.
|
10580
10814
|
# @return [String]
|
10581
10815
|
#
|
10582
10816
|
# @!attribute [rw] maximum_value
|
@@ -10761,35 +10995,35 @@ module Aws::QuickSight
|
|
10761
10995
|
#
|
10762
10996
|
# Valid values are defined as follows:
|
10763
10997
|
#
|
10764
|
-
# * `QUICKSIGHT_VIEWER_OR_OWNER
|
10998
|
+
# * `QUICKSIGHT_VIEWER_OR_OWNER`: Provide an ARN of a user or group,
|
10765
10999
|
# and any folders with that ARN listed as one of the folder's
|
10766
11000
|
# owners or viewers are returned. Implicit permissions from folders
|
10767
11001
|
# or groups are considered.
|
10768
11002
|
#
|
10769
|
-
# * `QUICKSIGHT_OWNER
|
11003
|
+
# * `QUICKSIGHT_OWNER`: Provide an ARN of a user or group, and any
|
10770
11004
|
# folders with that ARN listed as one of the owners of the folders
|
10771
11005
|
# are returned. Implicit permissions from folders or groups are
|
10772
11006
|
# considered.
|
10773
11007
|
#
|
10774
|
-
# * `DIRECT_QUICKSIGHT_SOLE_OWNER
|
10775
|
-
#
|
10776
|
-
#
|
10777
|
-
#
|
11008
|
+
# * `DIRECT_QUICKSIGHT_SOLE_OWNER`: Provide an ARN of a user or group,
|
11009
|
+
# and any folders with that ARN listed as the only owner of the
|
11010
|
+
# folder are returned. Implicit permissions from folders or groups
|
11011
|
+
# are not considered.
|
10778
11012
|
#
|
10779
|
-
# * `DIRECT_QUICKSIGHT_OWNER
|
11013
|
+
# * `DIRECT_QUICKSIGHT_OWNER`: Provide an ARN of a user or group, and
|
10780
11014
|
# any folders with that ARN listed as one of the owners of the
|
10781
11015
|
# folders are returned. Implicit permissions from folders or groups
|
10782
11016
|
# are not considered.
|
10783
11017
|
#
|
10784
|
-
# * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER
|
11018
|
+
# * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER`: Provide an ARN of a user or
|
10785
11019
|
# group, and any folders with that ARN listed as one of the owners
|
10786
11020
|
# or viewers of the folders are returned. Implicit permissions from
|
10787
11021
|
# folders or groups are not considered.
|
10788
11022
|
#
|
10789
|
-
# * `FOLDER_NAME
|
11023
|
+
# * `FOLDER_NAME`: Any folders whose names have a substring match to
|
10790
11024
|
# this value will be returned.
|
10791
11025
|
#
|
10792
|
-
# * `PARENT_FOLDER_ARN
|
11026
|
+
# * `PARENT_FOLDER_ARN`: Provide an ARN of a folder, and any folders
|
10793
11027
|
# that are directly under that parent folder are returned. If you
|
10794
11028
|
# choose to use this option and leave the value blank, all
|
10795
11029
|
# root-level folders in the account are returned.
|
@@ -10972,7 +11206,7 @@ module Aws::QuickSight
|
|
10972
11206
|
#
|
10973
11207
|
# * `AUTOMATIC`
|
10974
11208
|
#
|
10975
|
-
# * `CUSTOM
|
11209
|
+
# * `CUSTOM`: Checks the custom seasonality value.
|
10976
11210
|
# @return [String]
|
10977
11211
|
#
|
10978
11212
|
# @!attribute [rw] custom_seasonality_value
|
@@ -12209,9 +12443,9 @@ module Aws::QuickSight
|
|
12209
12443
|
#
|
12210
12444
|
# 2. Invited nonfederated users
|
12211
12445
|
#
|
12212
|
-
# 3.
|
12213
|
-
#
|
12214
|
-
#
|
12446
|
+
# 3. IAM users and IAM role-based sessions authenticated through
|
12447
|
+
# Federated Single Sign-On using SAML, OpenID Connect, or IAM
|
12448
|
+
# federation
|
12215
12449
|
#
|
12216
12450
|
# Omit this parameter for users in the third group, IAM users and IAM
|
12217
12451
|
# role-based sessions.
|
@@ -12395,10 +12629,10 @@ module Aws::QuickSight
|
|
12395
12629
|
# This value determines the layout behavior when the viewport is
|
12396
12630
|
# resized.
|
12397
12631
|
#
|
12398
|
-
# * `FIXED
|
12399
|
-
#
|
12632
|
+
# * `FIXED`: A fixed width will be used when optimizing the layout. In
|
12633
|
+
# the Amazon QuickSight console, this option is called `Classic`.
|
12400
12634
|
#
|
12401
|
-
# * `RESPONSIVE
|
12635
|
+
# * `RESPONSIVE`: The width of the canvas will be responsive and
|
12402
12636
|
# optimized to the view port. In the Amazon QuickSight console, this
|
12403
12637
|
# option is called `Tiled`.
|
12404
12638
|
# @return [String]
|
@@ -12967,6 +13201,20 @@ module Aws::QuickSight
|
|
12967
13201
|
include Aws::Structure
|
12968
13202
|
end
|
12969
13203
|
|
13204
|
+
# The incremental refresh configuration for a dataset.
|
13205
|
+
#
|
13206
|
+
# @!attribute [rw] lookback_window
|
13207
|
+
# The lookback window setup for an incremental refresh configuration.
|
13208
|
+
# @return [Types::LookbackWindow]
|
13209
|
+
#
|
13210
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/IncrementalRefresh AWS API Documentation
|
13211
|
+
#
|
13212
|
+
class IncrementalRefresh < Struct.new(
|
13213
|
+
:lookback_window)
|
13214
|
+
SENSITIVE = []
|
13215
|
+
include Aws::Structure
|
13216
|
+
end
|
13217
|
+
|
12970
13218
|
# Information about the SPICE ingestion for a dataset.
|
12971
13219
|
#
|
12972
13220
|
# @!attribute [rw] arn
|
@@ -13199,9 +13447,9 @@ module Aws::QuickSight
|
|
13199
13447
|
# The built-in options for default values. The value can be one of the
|
13200
13448
|
# following:
|
13201
13449
|
#
|
13202
|
-
# * `RECOMMENDED
|
13450
|
+
# * `RECOMMENDED`: The recommended value.
|
13203
13451
|
#
|
13204
|
-
# * `NULL
|
13452
|
+
# * `NULL`: The `NULL` value.
|
13205
13453
|
# @return [String]
|
13206
13454
|
#
|
13207
13455
|
# @!attribute [rw] custom_value
|
@@ -13952,21 +14200,21 @@ module Aws::QuickSight
|
|
13952
14200
|
# @!attribute [rw] line_interpolation
|
13953
14201
|
# Interpolation style for line series.
|
13954
14202
|
#
|
13955
|
-
# * `LINEAR
|
14203
|
+
# * `LINEAR`: Show as default, linear style.
|
13956
14204
|
#
|
13957
|
-
# * `SMOOTH
|
14205
|
+
# * `SMOOTH`: Show as a smooth curve.
|
13958
14206
|
#
|
13959
|
-
# * `STEPPED
|
14207
|
+
# * `STEPPED`: Show steps in line.
|
13960
14208
|
# @return [String]
|
13961
14209
|
#
|
13962
14210
|
# @!attribute [rw] line_style
|
13963
14211
|
# Line style for line series.
|
13964
14212
|
#
|
13965
|
-
# * `SOLID
|
14213
|
+
# * `SOLID`: Show as a solid line.
|
13966
14214
|
#
|
13967
|
-
# * `DOTTED
|
14215
|
+
# * `DOTTED`: Show as a dotted line.
|
13968
14216
|
#
|
13969
|
-
# * `DASHED
|
14217
|
+
# * `DASHED`: Show as a dashed line.
|
13970
14218
|
# @return [String]
|
13971
14219
|
#
|
13972
14220
|
# @!attribute [rw] line_width
|
@@ -13994,15 +14242,15 @@ module Aws::QuickSight
|
|
13994
14242
|
# @!attribute [rw] marker_shape
|
13995
14243
|
# Shape option for markers in the series.
|
13996
14244
|
#
|
13997
|
-
# * `CIRCLE
|
14245
|
+
# * `CIRCLE`: Show marker as a circle.
|
13998
14246
|
#
|
13999
|
-
# * `TRIANGLE
|
14247
|
+
# * `TRIANGLE`: Show marker as a triangle.
|
14000
14248
|
#
|
14001
|
-
# * `SQUARE
|
14249
|
+
# * `SQUARE`: Show marker as a square.
|
14002
14250
|
#
|
14003
|
-
# * `DIAMOND
|
14251
|
+
# * `DIAMOND`: Show marker as a diamond.
|
14004
14252
|
#
|
14005
|
-
# * `ROUNDED_SQUARE
|
14253
|
+
# * `ROUNDED_SQUARE`: Show marker as a rounded square.
|
14006
14254
|
# @return [String]
|
14007
14255
|
#
|
14008
14256
|
# @!attribute [rw] marker_size
|
@@ -14955,6 +15203,45 @@ module Aws::QuickSight
|
|
14955
15203
|
include Aws::Structure
|
14956
15204
|
end
|
14957
15205
|
|
15206
|
+
# @!attribute [rw] aws_account_id
|
15207
|
+
# The Amazon Web Services account ID.
|
15208
|
+
# @return [String]
|
15209
|
+
#
|
15210
|
+
# @!attribute [rw] data_set_id
|
15211
|
+
# The ID of the dataset.
|
15212
|
+
# @return [String]
|
15213
|
+
#
|
15214
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListRefreshSchedulesRequest AWS API Documentation
|
15215
|
+
#
|
15216
|
+
class ListRefreshSchedulesRequest < Struct.new(
|
15217
|
+
:aws_account_id,
|
15218
|
+
:data_set_id)
|
15219
|
+
SENSITIVE = []
|
15220
|
+
include Aws::Structure
|
15221
|
+
end
|
15222
|
+
|
15223
|
+
# @!attribute [rw] refresh_schedules
|
15224
|
+
# The list of refresh schedules for the dataset.
|
15225
|
+
# @return [Array<Types::RefreshSchedule>]
|
15226
|
+
#
|
15227
|
+
# @!attribute [rw] status
|
15228
|
+
# The HTTP status of the request.
|
15229
|
+
# @return [Integer]
|
15230
|
+
#
|
15231
|
+
# @!attribute [rw] request_id
|
15232
|
+
# The Amazon Web Services request ID for this operation.
|
15233
|
+
# @return [String]
|
15234
|
+
#
|
15235
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListRefreshSchedulesResponse AWS API Documentation
|
15236
|
+
#
|
15237
|
+
class ListRefreshSchedulesResponse < Struct.new(
|
15238
|
+
:refresh_schedules,
|
15239
|
+
:status,
|
15240
|
+
:request_id)
|
15241
|
+
SENSITIVE = []
|
15242
|
+
include Aws::Structure
|
15243
|
+
end
|
15244
|
+
|
14958
15245
|
# @!attribute [rw] resource_arn
|
14959
15246
|
# The Amazon Resource Name (ARN) of the resource that you want a list
|
14960
15247
|
# of tags for.
|
@@ -15563,6 +15850,31 @@ module Aws::QuickSight
|
|
15563
15850
|
include Aws::Structure
|
15564
15851
|
end
|
15565
15852
|
|
15853
|
+
# The lookback window setup of an incremental refresh configuration.
|
15854
|
+
#
|
15855
|
+
# @!attribute [rw] column_name
|
15856
|
+
# The name of the lookback window column.
|
15857
|
+
# @return [String]
|
15858
|
+
#
|
15859
|
+
# @!attribute [rw] size
|
15860
|
+
# The lookback window column size.
|
15861
|
+
# @return [Integer]
|
15862
|
+
#
|
15863
|
+
# @!attribute [rw] size_unit
|
15864
|
+
# The size unit that is used for the lookback window column. Valid
|
15865
|
+
# values for this structure are `HOUR`, `DAY`, and `WEEK`.
|
15866
|
+
# @return [String]
|
15867
|
+
#
|
15868
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/LookbackWindow AWS API Documentation
|
15869
|
+
#
|
15870
|
+
class LookbackWindow < Struct.new(
|
15871
|
+
:column_name,
|
15872
|
+
:size,
|
15873
|
+
:size_unit)
|
15874
|
+
SENSITIVE = []
|
15875
|
+
include Aws::Structure
|
15876
|
+
end
|
15877
|
+
|
15566
15878
|
# Amazon S3 manifest file location.
|
15567
15879
|
#
|
15568
15880
|
# @!attribute [rw] bucket
|
@@ -15776,12 +16088,12 @@ module Aws::QuickSight
|
|
15776
16088
|
# The treatment option that determines how missing data should be
|
15777
16089
|
# rendered. Choose from the following options:
|
15778
16090
|
#
|
15779
|
-
# * `INTERPOLATE
|
16091
|
+
# * `INTERPOLATE`: Interpolate missing values between the prior and
|
15780
16092
|
# the next known value.
|
15781
16093
|
#
|
15782
|
-
# * `SHOW_AS_ZERO
|
16094
|
+
# * `SHOW_AS_ZERO`: Show missing values as the value `0`.
|
15783
16095
|
#
|
15784
|
-
# * `SHOW_AS_BLANK
|
16096
|
+
# * `SHOW_AS_BLANK`: Display a blank space when rendering missing
|
15785
16097
|
# data.
|
15786
16098
|
# @return [String]
|
15787
16099
|
#
|
@@ -16042,11 +16354,11 @@ module Aws::QuickSight
|
|
16042
16354
|
# This option determines how null values should be treated when
|
16043
16355
|
# filtering data.
|
16044
16356
|
#
|
16045
|
-
# * `ALL_VALUES
|
16357
|
+
# * `ALL_VALUES`: Include null values in filtered results.
|
16046
16358
|
#
|
16047
|
-
# * `NULLS_ONLY
|
16359
|
+
# * `NULLS_ONLY`: Only include null values in filtered results.
|
16048
16360
|
#
|
16049
|
-
# * `NON_NULLS_ONLY
|
16361
|
+
# * `NON_NULLS_ONLY`: Exclude null values from filtered results.
|
16050
16362
|
# @return [String]
|
16051
16363
|
#
|
16052
16364
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/NumericEqualityFilter AWS API Documentation
|
@@ -16139,11 +16451,11 @@ module Aws::QuickSight
|
|
16139
16451
|
# This option determines how null values should be treated when
|
16140
16452
|
# filtering data.
|
16141
16453
|
#
|
16142
|
-
# * `ALL_VALUES
|
16454
|
+
# * `ALL_VALUES`: Include null values in filtered results.
|
16143
16455
|
#
|
16144
|
-
# * `NULLS_ONLY
|
16456
|
+
# * `NULLS_ONLY`: Only include null values in filtered results.
|
16145
16457
|
#
|
16146
|
-
# * `NON_NULLS_ONLY
|
16458
|
+
# * `NON_NULLS_ONLY`: Exclude null values from filtered results.
|
16147
16459
|
# @return [String]
|
16148
16460
|
#
|
16149
16461
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/NumericRangeFilter AWS API Documentation
|
@@ -16205,29 +16517,29 @@ module Aws::QuickSight
|
|
16205
16517
|
# @!attribute [rw] simple_numerical_aggregation
|
16206
16518
|
# Built-in aggregation functions for numerical values.
|
16207
16519
|
#
|
16208
|
-
# * `SUM
|
16520
|
+
# * `SUM`: The sum of a dimension or measure.
|
16209
16521
|
#
|
16210
|
-
# * `AVERAGE
|
16522
|
+
# * `AVERAGE`: The average of a dimension or measure.
|
16211
16523
|
#
|
16212
|
-
# * `MIN
|
16524
|
+
# * `MIN`: The minimum value of a dimension or measure.
|
16213
16525
|
#
|
16214
|
-
# * `MAX
|
16526
|
+
# * `MAX`: The maximum value of a dimension or measure.
|
16215
16527
|
#
|
16216
|
-
# * `COUNT
|
16528
|
+
# * `COUNT`: The count of a dimension or measure.
|
16217
16529
|
#
|
16218
|
-
# * `DISTINCT_COUNT
|
16530
|
+
# * `DISTINCT_COUNT`: The count of distinct values in a dimension or
|
16219
16531
|
# measure.
|
16220
16532
|
#
|
16221
|
-
# * `VAR
|
16533
|
+
# * `VAR`: The variance of a dimension or measure.
|
16222
16534
|
#
|
16223
|
-
# * `VARP
|
16535
|
+
# * `VARP`: The partitioned variance of a dimension or measure.
|
16224
16536
|
#
|
16225
|
-
# * `STDEV
|
16537
|
+
# * `STDEV`: The standard deviation of a dimension or measure.
|
16226
16538
|
#
|
16227
|
-
# * `STDEVP
|
16539
|
+
# * `STDEVP`: The partitioned standard deviation of a dimension or
|
16228
16540
|
# measure.
|
16229
16541
|
#
|
16230
|
-
# * `MEDIAN
|
16542
|
+
# * `MEDIAN`: The median value of a dimension or measure.
|
16231
16543
|
# @return [String]
|
16232
16544
|
#
|
16233
16545
|
# @!attribute [rw] percentile_aggregation
|
@@ -17477,6 +17789,13 @@ module Aws::QuickSight
|
|
17477
17789
|
# colors).
|
17478
17790
|
# @return [Types::RowAlternateColorOptions]
|
17479
17791
|
#
|
17792
|
+
# @!attribute [rw] collapsed_row_dimensions_visibility
|
17793
|
+
# The visibility setting of a pivot table's collapsed row dimension
|
17794
|
+
# fields. If the value of this structure is `HIDDEN`, all collapsed
|
17795
|
+
# columns in a pivot table are automatically hidden. The default value
|
17796
|
+
# is `VISIBLE`.
|
17797
|
+
# @return [String]
|
17798
|
+
#
|
17480
17799
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/PivotTableOptions AWS API Documentation
|
17481
17800
|
#
|
17482
17801
|
class PivotTableOptions < Struct.new(
|
@@ -17488,7 +17807,8 @@ module Aws::QuickSight
|
|
17488
17807
|
:row_header_style,
|
17489
17808
|
:cell_style,
|
17490
17809
|
:row_field_names_style,
|
17491
|
-
:row_alternate_color_options
|
17810
|
+
:row_alternate_color_options,
|
17811
|
+
:collapsed_row_dimensions_visibility)
|
17492
17812
|
SENSITIVE = []
|
17493
17813
|
include Aws::Structure
|
17494
17814
|
end
|
@@ -17798,6 +18118,45 @@ module Aws::QuickSight
|
|
17798
18118
|
include Aws::Structure
|
17799
18119
|
end
|
17800
18120
|
|
18121
|
+
# @!attribute [rw] aws_account_id
|
18122
|
+
# The Amazon Web Services account ID.
|
18123
|
+
# @return [String]
|
18124
|
+
#
|
18125
|
+
# @!attribute [rw] data_set_id
|
18126
|
+
# The ID of the dataset.
|
18127
|
+
# @return [String]
|
18128
|
+
#
|
18129
|
+
# @!attribute [rw] data_set_refresh_properties
|
18130
|
+
# The dataset refresh properties.
|
18131
|
+
# @return [Types::DataSetRefreshProperties]
|
18132
|
+
#
|
18133
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/PutDataSetRefreshPropertiesRequest AWS API Documentation
|
18134
|
+
#
|
18135
|
+
class PutDataSetRefreshPropertiesRequest < Struct.new(
|
18136
|
+
:aws_account_id,
|
18137
|
+
:data_set_id,
|
18138
|
+
:data_set_refresh_properties)
|
18139
|
+
SENSITIVE = []
|
18140
|
+
include Aws::Structure
|
18141
|
+
end
|
18142
|
+
|
18143
|
+
# @!attribute [rw] request_id
|
18144
|
+
# The Amazon Web Services request ID for this operation.
|
18145
|
+
# @return [String]
|
18146
|
+
#
|
18147
|
+
# @!attribute [rw] status
|
18148
|
+
# The HTTP status of the request.
|
18149
|
+
# @return [Integer]
|
18150
|
+
#
|
18151
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/PutDataSetRefreshPropertiesResponse AWS API Documentation
|
18152
|
+
#
|
18153
|
+
class PutDataSetRefreshPropertiesResponse < Struct.new(
|
18154
|
+
:request_id,
|
18155
|
+
:status)
|
18156
|
+
SENSITIVE = []
|
18157
|
+
include Aws::Structure
|
18158
|
+
end
|
18159
|
+
|
17801
18160
|
# Information about a queued dataset SPICE ingestion.
|
17802
18161
|
#
|
17803
18162
|
# @!attribute [rw] waiting_on_ingestion
|
@@ -18340,14 +18699,127 @@ module Aws::QuickSight
|
|
18340
18699
|
include Aws::Structure
|
18341
18700
|
end
|
18342
18701
|
|
18702
|
+
# The refresh configuration of a dataset.
|
18703
|
+
#
|
18704
|
+
# @!attribute [rw] incremental_refresh
|
18705
|
+
# The incremental refresh for the dataset.
|
18706
|
+
# @return [Types::IncrementalRefresh]
|
18707
|
+
#
|
18708
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RefreshConfiguration AWS API Documentation
|
18709
|
+
#
|
18710
|
+
class RefreshConfiguration < Struct.new(
|
18711
|
+
:incremental_refresh)
|
18712
|
+
SENSITIVE = []
|
18713
|
+
include Aws::Structure
|
18714
|
+
end
|
18715
|
+
|
18716
|
+
# Specifies the interval between each scheduled refresh of a dataset.
|
18717
|
+
#
|
18718
|
+
# @!attribute [rw] interval
|
18719
|
+
# The interval between scheduled refreshes. Valid values are as
|
18720
|
+
# follows:
|
18721
|
+
#
|
18722
|
+
# * `MINUTE15`: The dataset refreshes every 15 minutes. This value is
|
18723
|
+
# only supported for incremental refreshes. This interval can only
|
18724
|
+
# be used for one schedule per dataset.
|
18725
|
+
#
|
18726
|
+
# * `MINUTE30`:The dataset refreshes every 30 minutes. This value is
|
18727
|
+
# only supported for incremental refreshes. This interval can only
|
18728
|
+
# be used for one schedule per dataset.
|
18729
|
+
#
|
18730
|
+
# * `HOURLY`: The dataset refreshes every hour. This interval can only
|
18731
|
+
# be used for one schedule per dataset.
|
18732
|
+
#
|
18733
|
+
# * `DAILY`: The dataset refreshes every day.
|
18734
|
+
#
|
18735
|
+
# * `WEEKLY`: The dataset refreshes every week.
|
18736
|
+
#
|
18737
|
+
# * `MONTHLY`: The dataset refreshes every month.
|
18738
|
+
# @return [String]
|
18739
|
+
#
|
18740
|
+
# @!attribute [rw] refresh_on_day
|
18741
|
+
# The day of the week that you want to schedule the refresh on. This
|
18742
|
+
# value is required for weekly and monthly refresh intervals.
|
18743
|
+
# @return [Types::ScheduleRefreshOnEntity]
|
18744
|
+
#
|
18745
|
+
# @!attribute [rw] timezone
|
18746
|
+
# The timezone that you want the refresh schedule to use. The timezone
|
18747
|
+
# ID must match a corresponding ID found on
|
18748
|
+
# `java.util.time.getAvailableIDs()`.
|
18749
|
+
# @return [String]
|
18750
|
+
#
|
18751
|
+
# @!attribute [rw] time_of_the_day
|
18752
|
+
# The time of day that you want the datset to refresh. This value is
|
18753
|
+
# expressed in HH:MM format. This field is not required for schedules
|
18754
|
+
# that refresh hourly.
|
18755
|
+
# @return [String]
|
18756
|
+
#
|
18757
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RefreshFrequency AWS API Documentation
|
18758
|
+
#
|
18759
|
+
class RefreshFrequency < Struct.new(
|
18760
|
+
:interval,
|
18761
|
+
:refresh_on_day,
|
18762
|
+
:timezone,
|
18763
|
+
:time_of_the_day)
|
18764
|
+
SENSITIVE = []
|
18765
|
+
include Aws::Structure
|
18766
|
+
end
|
18767
|
+
|
18768
|
+
# The refresh schedule of a dataset.
|
18769
|
+
#
|
18770
|
+
# @!attribute [rw] schedule_id
|
18771
|
+
# An identifier for the refresh schedule.
|
18772
|
+
# @return [String]
|
18773
|
+
#
|
18774
|
+
# @!attribute [rw] schedule_frequency
|
18775
|
+
# The frequency for the refresh schedule.
|
18776
|
+
# @return [Types::RefreshFrequency]
|
18777
|
+
#
|
18778
|
+
# @!attribute [rw] start_after_date_time
|
18779
|
+
# Time after which the refresh schedule can be started, expressed in
|
18780
|
+
# `YYYY-MM-DDTHH:MM:SS` format.
|
18781
|
+
# @return [Time]
|
18782
|
+
#
|
18783
|
+
# @!attribute [rw] refresh_type
|
18784
|
+
# The type of refresh that a datset undergoes. Valid values are as
|
18785
|
+
# follows:
|
18786
|
+
#
|
18787
|
+
# * `FULL_REFRESH`: A complete refresh of a dataset.
|
18788
|
+
#
|
18789
|
+
# * `INCREMENTAL_REFRESH`: A partial refresh of some rows of a
|
18790
|
+
# dataset, based on the time window specified.
|
18791
|
+
#
|
18792
|
+
# For more information on full and incremental refreshes, see
|
18793
|
+
# [Refreshing SPICE data][1] in the *Amazon QuickSight User Guide*.
|
18794
|
+
#
|
18795
|
+
#
|
18796
|
+
#
|
18797
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/refreshing-imported-data.html
|
18798
|
+
# @return [String]
|
18799
|
+
#
|
18800
|
+
# @!attribute [rw] arn
|
18801
|
+
# The Amazon Resource Name (ARN) for the refresh schedule.
|
18802
|
+
# @return [String]
|
18803
|
+
#
|
18804
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RefreshSchedule AWS API Documentation
|
18805
|
+
#
|
18806
|
+
class RefreshSchedule < Struct.new(
|
18807
|
+
:schedule_id,
|
18808
|
+
:schedule_frequency,
|
18809
|
+
:start_after_date_time,
|
18810
|
+
:refresh_type,
|
18811
|
+
:arn)
|
18812
|
+
SENSITIVE = []
|
18813
|
+
include Aws::Structure
|
18814
|
+
end
|
18815
|
+
|
18343
18816
|
# @!attribute [rw] identity_type
|
18344
18817
|
# Amazon QuickSight supports several ways of managing the identity of
|
18345
18818
|
# users. This parameter accepts two values:
|
18346
18819
|
#
|
18347
|
-
# * `IAM
|
18348
|
-
# role.
|
18820
|
+
# * `IAM`: A user whose identity maps to an existing IAM user or role.
|
18349
18821
|
#
|
18350
|
-
# * `QUICKSIGHT
|
18822
|
+
# * `QUICKSIGHT`: A user whose identity is owned and managed
|
18351
18823
|
# internally by Amazon QuickSight.
|
18352
18824
|
# @return [String]
|
18353
18825
|
#
|
@@ -18359,19 +18831,17 @@ module Aws::QuickSight
|
|
18359
18831
|
# The Amazon QuickSight role for the user. The user role can be one of
|
18360
18832
|
# the following:
|
18361
18833
|
#
|
18362
|
-
# * `READER
|
18834
|
+
# * `READER`: A user who has read-only access to dashboards.
|
18363
18835
|
#
|
18364
|
-
# * `AUTHOR
|
18836
|
+
# * `AUTHOR`: A user who can create data sources, datasets, analyses,
|
18365
18837
|
# and dashboards.
|
18366
18838
|
#
|
18367
|
-
# * `ADMIN
|
18839
|
+
# * `ADMIN`: A user who is an author, who can also manage Amazon
|
18368
18840
|
# QuickSight settings.
|
18369
18841
|
#
|
18370
|
-
# * `RESTRICTED_READER
|
18371
|
-
# use.
|
18842
|
+
# * `RESTRICTED_READER`: This role isn't currently available for use.
|
18372
18843
|
#
|
18373
|
-
# * `RESTRICTED_AUTHOR
|
18374
|
-
# use.
|
18844
|
+
# * `RESTRICTED_AUTHOR`: This role isn't currently available for use.
|
18375
18845
|
# @return [String]
|
18376
18846
|
#
|
18377
18847
|
# @!attribute [rw] iam_arn
|
@@ -18446,13 +18916,13 @@ module Aws::QuickSight
|
|
18446
18916
|
# Identity and Access Management(IAM) role. The type of supported
|
18447
18917
|
# external login provider can be one of the following.
|
18448
18918
|
#
|
18449
|
-
# * `COGNITO
|
18919
|
+
# * `COGNITO`: Amazon Cognito. The provider URL is
|
18450
18920
|
# cognito-identity.amazonaws.com. When choosing the `COGNITO`
|
18451
18921
|
# provider type, don’t use the "CustomFederationProviderUrl"
|
18452
18922
|
# parameter which is only needed when the external provider is
|
18453
18923
|
# custom.
|
18454
18924
|
#
|
18455
|
-
# * `CUSTOM_OIDC
|
18925
|
+
# * `CUSTOM_OIDC`: Custom OpenID Connect (OIDC) provider. When
|
18456
18926
|
# choosing `CUSTOM_OIDC` type, use the `CustomFederationProviderUrl`
|
18457
18927
|
# parameter to provide the custom OIDC provider URL.
|
18458
18928
|
# @return [String]
|
@@ -18517,6 +18987,21 @@ module Aws::QuickSight
|
|
18517
18987
|
include Aws::Structure
|
18518
18988
|
end
|
18519
18989
|
|
18990
|
+
# The feature configurations of an embedded Amazon QuickSight console.
|
18991
|
+
#
|
18992
|
+
# @!attribute [rw] state_persistence
|
18993
|
+
# The state persistence configurations of an embedded Amazon
|
18994
|
+
# QuickSight console.
|
18995
|
+
# @return [Types::StatePersistenceConfigurations]
|
18996
|
+
#
|
18997
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisteredUserConsoleFeatureConfigurations AWS API Documentation
|
18998
|
+
#
|
18999
|
+
class RegisteredUserConsoleFeatureConfigurations < Struct.new(
|
19000
|
+
:state_persistence)
|
19001
|
+
SENSITIVE = []
|
19002
|
+
include Aws::Structure
|
19003
|
+
end
|
19004
|
+
|
18520
19005
|
# Information about the dashboard you want to embed.
|
18521
19006
|
#
|
18522
19007
|
# @!attribute [rw] initial_dashboard_id
|
@@ -18529,10 +19014,30 @@ module Aws::QuickSight
|
|
18529
19014
|
# see a permissions error message.
|
18530
19015
|
# @return [String]
|
18531
19016
|
#
|
19017
|
+
# @!attribute [rw] feature_configurations
|
19018
|
+
# The feature configurations of an embbedded Amazon QuickSight
|
19019
|
+
# dashboard.
|
19020
|
+
# @return [Types::RegisteredUserDashboardFeatureConfigurations]
|
19021
|
+
#
|
18532
19022
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisteredUserDashboardEmbeddingConfiguration AWS API Documentation
|
18533
19023
|
#
|
18534
19024
|
class RegisteredUserDashboardEmbeddingConfiguration < Struct.new(
|
18535
|
-
:initial_dashboard_id
|
19025
|
+
:initial_dashboard_id,
|
19026
|
+
:feature_configurations)
|
19027
|
+
SENSITIVE = []
|
19028
|
+
include Aws::Structure
|
19029
|
+
end
|
19030
|
+
|
19031
|
+
# The feature configuration for an embedded dashboard.
|
19032
|
+
#
|
19033
|
+
# @!attribute [rw] state_persistence
|
19034
|
+
# The state persistence settings of an embedded dashboard.
|
19035
|
+
# @return [Types::StatePersistenceConfigurations]
|
19036
|
+
#
|
19037
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisteredUserDashboardFeatureConfigurations AWS API Documentation
|
19038
|
+
#
|
19039
|
+
class RegisteredUserDashboardFeatureConfigurations < Struct.new(
|
19040
|
+
:state_persistence)
|
18536
19041
|
SENSITIVE = []
|
18537
19042
|
include Aws::Structure
|
18538
19043
|
end
|
@@ -18590,7 +19095,7 @@ module Aws::QuickSight
|
|
18590
19095
|
# the ` UpdateUser ` API operation. Use the ` RegisterUser ` API
|
18591
19096
|
# operation to add a new user with a custom permission profile
|
18592
19097
|
# attached. For more information, see the following sections in the
|
18593
|
-
# *Amazon QuickSight User Guide
|
19098
|
+
# *Amazon QuickSight User Guide*:
|
18594
19099
|
#
|
18595
19100
|
# * [Embedding the Full Functionality of the Amazon QuickSight Console
|
18596
19101
|
# for Authenticated Users][2]
|
@@ -18681,10 +19186,16 @@ module Aws::QuickSight
|
|
18681
19186
|
# Amazon QuickSight console URL of the analysis.
|
18682
19187
|
# @return [String]
|
18683
19188
|
#
|
19189
|
+
# @!attribute [rw] feature_configurations
|
19190
|
+
# The embedding configuration of an embedded Amazon QuickSight
|
19191
|
+
# console.
|
19192
|
+
# @return [Types::RegisteredUserConsoleFeatureConfigurations]
|
19193
|
+
#
|
18684
19194
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisteredUserQuickSightConsoleEmbeddingConfiguration AWS API Documentation
|
18685
19195
|
#
|
18686
19196
|
class RegisteredUserQuickSightConsoleEmbeddingConfiguration < Struct.new(
|
18687
|
-
:initial_path
|
19197
|
+
:initial_path,
|
19198
|
+
:feature_configurations)
|
18688
19199
|
SENSITIVE = []
|
18689
19200
|
include Aws::Structure
|
18690
19201
|
end
|
@@ -18794,11 +19305,11 @@ module Aws::QuickSight
|
|
18794
19305
|
# This option determines how null values should be treated when
|
18795
19306
|
# filtering data.
|
18796
19307
|
#
|
18797
|
-
# * `ALL_VALUES
|
19308
|
+
# * `ALL_VALUES`: Include null values in filtered results.
|
18798
19309
|
#
|
18799
|
-
# * `NULLS_ONLY
|
19310
|
+
# * `NULLS_ONLY`: Only include null values in filtered results.
|
18800
19311
|
#
|
18801
|
-
# * `NON_NULLS_ONLY
|
19312
|
+
# * `NON_NULLS_ONLY`: Exclude null values from filtered results.
|
18802
19313
|
# @return [String]
|
18803
19314
|
#
|
18804
19315
|
# @!attribute [rw] exclude_period_configuration
|
@@ -19117,11 +19628,20 @@ module Aws::QuickSight
|
|
19117
19628
|
# names and columns that they are assigned to.
|
19118
19629
|
# @return [Array<Types::RowLevelPermissionTagRule>]
|
19119
19630
|
#
|
19631
|
+
# @!attribute [rw] tag_rule_configurations
|
19632
|
+
# A list of tag configuration rules to apply to a dataset. All tag
|
19633
|
+
# configurations have the OR condition. Tags within each tile will be
|
19634
|
+
# joined (AND). At least one rule in this structure must have all tag
|
19635
|
+
# values assigned to it to apply Row-level security (RLS) to the
|
19636
|
+
# dataset.
|
19637
|
+
# @return [Array<Array<String>>]
|
19638
|
+
#
|
19120
19639
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RowLevelPermissionTagConfiguration AWS API Documentation
|
19121
19640
|
#
|
19122
19641
|
class RowLevelPermissionTagConfiguration < Struct.new(
|
19123
19642
|
:status,
|
19124
|
-
:tag_rules
|
19643
|
+
:tag_rules,
|
19644
|
+
:tag_rule_configurations)
|
19125
19645
|
SENSITIVE = []
|
19126
19646
|
include Aws::Structure
|
19127
19647
|
end
|
@@ -19230,7 +19750,7 @@ module Aws::QuickSight
|
|
19230
19750
|
#
|
19231
19751
|
# Valid values are defined as follows:
|
19232
19752
|
#
|
19233
|
-
# * `ALL_VISUALS
|
19753
|
+
# * `ALL_VISUALS`: Applies the filter operation to all visuals in the
|
19234
19754
|
# same sheet.
|
19235
19755
|
#
|
19236
19756
|
# ^
|
@@ -19572,6 +20092,25 @@ module Aws::QuickSight
|
|
19572
20092
|
include Aws::Structure
|
19573
20093
|
end
|
19574
20094
|
|
20095
|
+
# The refresh on entity for weekly or monthly schedules.
|
20096
|
+
#
|
20097
|
+
# @!attribute [rw] day_of_week
|
20098
|
+
# The day of the week that you want to schedule a refresh on.
|
20099
|
+
# @return [String]
|
20100
|
+
#
|
20101
|
+
# @!attribute [rw] day_of_month
|
20102
|
+
# The day of the month that you want to schedule refresh on.
|
20103
|
+
# @return [String]
|
20104
|
+
#
|
20105
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ScheduleRefreshOnEntity AWS API Documentation
|
20106
|
+
#
|
20107
|
+
class ScheduleRefreshOnEntity < Struct.new(
|
20108
|
+
:day_of_week,
|
20109
|
+
:day_of_month)
|
20110
|
+
SENSITIVE = []
|
20111
|
+
include Aws::Structure
|
20112
|
+
end
|
20113
|
+
|
19575
20114
|
# The visual display options for a data zoom scroll bar.
|
19576
20115
|
#
|
19577
20116
|
# @!attribute [rw] visibility
|
@@ -20370,9 +20909,9 @@ module Aws::QuickSight
|
|
20370
20909
|
# The layout content type of the sheet. Choose one of the following
|
20371
20910
|
# options:
|
20372
20911
|
#
|
20373
|
-
# * `PAGINATED
|
20912
|
+
# * `PAGINATED`: Creates a sheet for a paginated report.
|
20374
20913
|
#
|
20375
|
-
# * `INTERACTIVE
|
20914
|
+
# * `INTERACTIVE`: Creates a sheet for an interactive dashboard.
|
20376
20915
|
# @return [String]
|
20377
20916
|
#
|
20378
20917
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SheetDefinition AWS API Documentation
|
@@ -20743,6 +21282,21 @@ module Aws::QuickSight
|
|
20743
21282
|
include Aws::Structure
|
20744
21283
|
end
|
20745
21284
|
|
21285
|
+
# The state perssitence configuration of an embedded dashboard.
|
21286
|
+
#
|
21287
|
+
# @!attribute [rw] enabled
|
21288
|
+
# Determines if a Amazon QuickSight dashboard's state persistence
|
21289
|
+
# settings are turned on or off.
|
21290
|
+
# @return [Boolean]
|
21291
|
+
#
|
21292
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/StatePersistenceConfigurations AWS API Documentation
|
21293
|
+
#
|
21294
|
+
class StatePersistenceConfigurations < Struct.new(
|
21295
|
+
:enabled)
|
21296
|
+
SENSITIVE = []
|
21297
|
+
include Aws::Structure
|
21298
|
+
end
|
21299
|
+
|
20746
21300
|
# The default values of the `StringParameterDeclaration`.
|
20747
21301
|
#
|
20748
21302
|
# @!attribute [rw] dynamic_value
|
@@ -20841,9 +21395,9 @@ module Aws::QuickSight
|
|
20841
21395
|
# The built-in options for default values. The value can be one of the
|
20842
21396
|
# following:
|
20843
21397
|
#
|
20844
|
-
# * `RECOMMENDED
|
21398
|
+
# * `RECOMMENDED`: The recommended value.
|
20845
21399
|
#
|
20846
|
-
# * `NULL
|
21400
|
+
# * `NULL`: The `NULL` value.
|
20847
21401
|
# @return [String]
|
20848
21402
|
#
|
20849
21403
|
# @!attribute [rw] custom_value
|
@@ -22388,9 +22942,9 @@ module Aws::QuickSight
|
|
22388
22942
|
# The seasonality setup of a forecast computation. Choose one of the
|
22389
22943
|
# following options:
|
22390
22944
|
#
|
22391
|
-
# * `NULL
|
22945
|
+
# * `NULL`: The input is set to `NULL`.
|
22392
22946
|
#
|
22393
|
-
# * `NON_NULL
|
22947
|
+
# * `NON_NULL`: The input is set to a custom value.
|
22394
22948
|
# @return [Integer]
|
22395
22949
|
#
|
22396
22950
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TimeBasedForecastProperties AWS API Documentation
|
@@ -22510,11 +23064,11 @@ module Aws::QuickSight
|
|
22510
23064
|
# This option determines how null values should be treated when
|
22511
23065
|
# filtering data.
|
22512
23066
|
#
|
22513
|
-
# * `ALL_VALUES
|
23067
|
+
# * `ALL_VALUES`: Include null values in filtered results.
|
22514
23068
|
#
|
22515
|
-
# * `NULLS_ONLY
|
23069
|
+
# * `NULLS_ONLY`: Only include null values in filtered results.
|
22516
23070
|
#
|
22517
|
-
# * `NON_NULLS_ONLY
|
23071
|
+
# * `NON_NULLS_ONLY`: Exclude null values from filtered results.
|
22518
23072
|
# @return [String]
|
22519
23073
|
#
|
22520
23074
|
# @!attribute [rw] exclude_period_configuration
|
@@ -22601,9 +23155,9 @@ module Aws::QuickSight
|
|
22601
23155
|
# The selected type for the tooltip. Choose one of the following
|
22602
23156
|
# options:
|
22603
23157
|
#
|
22604
|
-
# * `BASIC
|
23158
|
+
# * `BASIC`: A basic tooltip.
|
22605
23159
|
#
|
22606
|
-
# * `DETAILED
|
23160
|
+
# * `DETAILED`: A detailed tooltip.
|
22607
23161
|
# @return [String]
|
22608
23162
|
#
|
22609
23163
|
# @!attribute [rw] field_based_tooltip
|
@@ -23417,10 +23971,9 @@ module Aws::QuickSight
|
|
23417
23971
|
#
|
23418
23972
|
# @!attribute [rw] default_namespace
|
23419
23973
|
# The default namespace for this Amazon Web Services account.
|
23420
|
-
# Currently, the default is `default`.
|
23421
|
-
#
|
23422
|
-
#
|
23423
|
-
# namespace.
|
23974
|
+
# Currently, the default is `default`. IAM users that register for the
|
23975
|
+
# first time with Amazon QuickSight provide an email address that
|
23976
|
+
# becomes associated with the default namespace.
|
23424
23977
|
# @return [String]
|
23425
23978
|
#
|
23426
23979
|
# @!attribute [rw] notification_email
|
@@ -24528,6 +25081,55 @@ module Aws::QuickSight
|
|
24528
25081
|
include Aws::Structure
|
24529
25082
|
end
|
24530
25083
|
|
25084
|
+
# @!attribute [rw] data_set_id
|
25085
|
+
# The ID of the dataset.
|
25086
|
+
# @return [String]
|
25087
|
+
#
|
25088
|
+
# @!attribute [rw] aws_account_id
|
25089
|
+
# The Amazon Web Services account ID.
|
25090
|
+
# @return [String]
|
25091
|
+
#
|
25092
|
+
# @!attribute [rw] schedule
|
25093
|
+
# The refresh schedule.
|
25094
|
+
# @return [Types::RefreshSchedule]
|
25095
|
+
#
|
25096
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateRefreshScheduleRequest AWS API Documentation
|
25097
|
+
#
|
25098
|
+
class UpdateRefreshScheduleRequest < Struct.new(
|
25099
|
+
:data_set_id,
|
25100
|
+
:aws_account_id,
|
25101
|
+
:schedule)
|
25102
|
+
SENSITIVE = []
|
25103
|
+
include Aws::Structure
|
25104
|
+
end
|
25105
|
+
|
25106
|
+
# @!attribute [rw] status
|
25107
|
+
# The HTTP status of the request.
|
25108
|
+
# @return [Integer]
|
25109
|
+
#
|
25110
|
+
# @!attribute [rw] request_id
|
25111
|
+
# The Amazon Web Services request ID for this operation.
|
25112
|
+
# @return [String]
|
25113
|
+
#
|
25114
|
+
# @!attribute [rw] schedule_id
|
25115
|
+
# The ID of the refresh schedule.
|
25116
|
+
# @return [String]
|
25117
|
+
#
|
25118
|
+
# @!attribute [rw] arn
|
25119
|
+
# The Amazon Resource Name (ARN) for the refresh schedule.
|
25120
|
+
# @return [String]
|
25121
|
+
#
|
25122
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateRefreshScheduleResponse AWS API Documentation
|
25123
|
+
#
|
25124
|
+
class UpdateRefreshScheduleResponse < Struct.new(
|
25125
|
+
:status,
|
25126
|
+
:request_id,
|
25127
|
+
:schedule_id,
|
25128
|
+
:arn)
|
25129
|
+
SENSITIVE = []
|
25130
|
+
include Aws::Structure
|
25131
|
+
end
|
25132
|
+
|
24531
25133
|
# @!attribute [rw] aws_account_id
|
24532
25134
|
# The ID of the Amazon Web Services account that contains the template
|
24533
25135
|
# alias that you're updating.
|
@@ -24948,12 +25550,12 @@ module Aws::QuickSight
|
|
24948
25550
|
# The Amazon QuickSight role of the user. The role can be one of the
|
24949
25551
|
# following default security cohorts:
|
24950
25552
|
#
|
24951
|
-
# * `READER
|
25553
|
+
# * `READER`: A user who has read-only access to dashboards.
|
24952
25554
|
#
|
24953
|
-
# * `AUTHOR
|
25555
|
+
# * `AUTHOR`: A user who can create data sources, datasets, analyses,
|
24954
25556
|
# and dashboards.
|
24955
25557
|
#
|
24956
|
-
# * `ADMIN
|
25558
|
+
# * `ADMIN`: A user who is an author, who can also manage Amazon
|
24957
25559
|
# QuickSight settings.
|
24958
25560
|
#
|
24959
25561
|
# The name of the Amazon QuickSight role is invisible to the user
|
@@ -25003,17 +25605,17 @@ module Aws::QuickSight
|
|
25003
25605
|
# Identity and Access Management(IAM) role. The type of supported
|
25004
25606
|
# external login provider can be one of the following.
|
25005
25607
|
#
|
25006
|
-
# * `COGNITO
|
25608
|
+
# * `COGNITO`: Amazon Cognito. The provider URL is
|
25007
25609
|
# cognito-identity.amazonaws.com. When choosing the `COGNITO`
|
25008
25610
|
# provider type, don’t use the "CustomFederationProviderUrl"
|
25009
25611
|
# parameter which is only needed when the external provider is
|
25010
25612
|
# custom.
|
25011
25613
|
#
|
25012
|
-
# * `CUSTOM_OIDC
|
25614
|
+
# * `CUSTOM_OIDC`: Custom OpenID Connect (OIDC) provider. When
|
25013
25615
|
# choosing `CUSTOM_OIDC` type, use the `CustomFederationProviderUrl`
|
25014
25616
|
# parameter to provide the custom OIDC provider URL.
|
25015
25617
|
#
|
25016
|
-
# * `NONE
|
25618
|
+
# * `NONE`: This clears all the previously saved external login
|
25017
25619
|
# information for a user. Use the ` DescribeUser ` API operation to
|
25018
25620
|
# check the external login information.
|
25019
25621
|
# @return [String]
|
@@ -25125,19 +25727,17 @@ module Aws::QuickSight
|
|
25125
25727
|
# The Amazon QuickSight role for the user. The user role can be one of
|
25126
25728
|
# the following:.
|
25127
25729
|
#
|
25128
|
-
# * `READER
|
25730
|
+
# * `READER`: A user who has read-only access to dashboards.
|
25129
25731
|
#
|
25130
|
-
# * `AUTHOR
|
25732
|
+
# * `AUTHOR`: A user who can create data sources, datasets, analyses,
|
25131
25733
|
# and dashboards.
|
25132
25734
|
#
|
25133
|
-
# * `ADMIN
|
25735
|
+
# * `ADMIN`: A user who is an author, who can also manage Amazon
|
25134
25736
|
# Amazon QuickSight settings.
|
25135
25737
|
#
|
25136
|
-
# * `RESTRICTED_READER
|
25137
|
-
# use.
|
25738
|
+
# * `RESTRICTED_READER`: This role isn't currently available for use.
|
25138
25739
|
#
|
25139
|
-
# * `RESTRICTED_AUTHOR
|
25140
|
-
# use.
|
25740
|
+
# * `RESTRICTED_AUTHOR`: This role isn't currently available for use.
|
25141
25741
|
# @return [String]
|
25142
25742
|
#
|
25143
25743
|
# @!attribute [rw] identity_type
|
@@ -25146,7 +25746,7 @@ module Aws::QuickSight
|
|
25146
25746
|
#
|
25147
25747
|
# @!attribute [rw] active
|
25148
25748
|
# The active status of user. When you create an Amazon QuickSight user
|
25149
|
-
# that
|
25749
|
+
# that's not an IAM user or an Active Directory user, that user is
|
25150
25750
|
# inactive until they sign in and provide a password.
|
25151
25751
|
# @return [Boolean]
|
25152
25752
|
#
|
@@ -25163,10 +25763,10 @@ module Aws::QuickSight
|
|
25163
25763
|
# to let the user federate into Amazon QuickSight with an associated
|
25164
25764
|
# IAM role. The type can be one of the following.
|
25165
25765
|
#
|
25166
|
-
# * `COGNITO
|
25766
|
+
# * `COGNITO`: Amazon Cognito. The provider URL is
|
25167
25767
|
# cognito-identity.amazonaws.com.
|
25168
25768
|
#
|
25169
|
-
# * `CUSTOM_OIDC
|
25769
|
+
# * `CUSTOM_OIDC`: Custom OpenID Connect (OIDC) provider.
|
25170
25770
|
# @return [String]
|
25171
25771
|
#
|
25172
25772
|
# @!attribute [rw] external_login_federation_provider_url
|
@@ -25523,10 +26123,10 @@ module Aws::QuickSight
|
|
25523
26123
|
#
|
25524
26124
|
# Valid values are defined as follows:
|
25525
26125
|
#
|
25526
|
-
# * `DATA_POINT_CLICK
|
26126
|
+
# * `DATA_POINT_CLICK`: Initiates a custom action by a left pointer
|
25527
26127
|
# click on a data point.
|
25528
26128
|
#
|
25529
|
-
# * `DATA_POINT_MENU
|
26129
|
+
# * `DATA_POINT_MENU`: Initiates a custom action by right pointer
|
25530
26130
|
# click from the menu.
|
25531
26131
|
# @return [String]
|
25532
26132
|
#
|