aws-sdk-quicksight 1.77.0 → 1.78.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -203,25 +203,25 @@ module Aws::QuickSight
203
203
  # @!attribute [rw] categorical_aggregation_function
204
204
  # Aggregation for categorical values.
205
205
  #
206
- # * `COUNT`\: Aggregate by the total number of values, including
206
+ # * `COUNT`: Aggregate by the total number of values, including
207
207
  # duplicates.
208
208
  #
209
- # * `DISTINCT_COUNT`\: Aggregate by the total number of distinct
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`\: Aggregate by the total number of values, including
216
+ # * `COUNT`: Aggregate by the total number of values, including
217
217
  # duplicates.
218
218
  #
219
- # * `DISTINCT_COUNT`\: Aggregate by the total number of distinct
219
+ # * `DISTINCT_COUNT`: Aggregate by the total number of distinct
220
220
  # values.
221
221
  #
222
- # * `MIN`\: Select the smallest date value.
222
+ # * `MIN`: Select the smallest date value.
223
223
  #
224
- # * `MAX`\: Select the largest date value.
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`\: Sort in ascending order.
246
+ # * `ASC`: Sort in ascending order.
247
247
  #
248
- # * `DESC`\: Sort in descending order.
248
+ # * `DESC`: Sort in descending order.
249
249
  # @return [String]
250
250
  #
251
251
  # @!attribute [rw] aggregation_function
@@ -482,32 +482,32 @@ module Aws::QuickSight
482
482
  #
483
483
  # Valid values are defined as follows:
484
484
  #
485
- # * `QUICKSIGHT_VIEWER_OR_OWNER`\: Provide an ARN of a user or group,
485
+ # * `QUICKSIGHT_VIEWER_OR_OWNER`: Provide an ARN of a user or group,
486
486
  # and any analyses with that ARN listed as one of the analysis'
487
487
  # owners or viewers are returned. Implicit permissions from folders
488
488
  # or groups are considered.
489
489
  #
490
- # * `QUICKSIGHT_OWNER`\: Provide an ARN of a user or group, and any
490
+ # * `QUICKSIGHT_OWNER`: Provide an ARN of a user or group, and any
491
491
  # analyses with that ARN listed as one of the owners of the analyses
492
492
  # are returned. Implicit permissions from folders or groups are
493
493
  # considered.
494
494
  #
495
- # * `DIRECT_QUICKSIGHT_SOLE_OWNER`\: Provide an ARN of a user or
496
- # group, and any analyses with that ARN listed as the only owner of
497
- # the analysis are returned. Implicit permissions from folders or
498
- # groups are not considered.
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.
499
499
  #
500
- # * `DIRECT_QUICKSIGHT_OWNER`\: Provide an ARN of a user or group, and
500
+ # * `DIRECT_QUICKSIGHT_OWNER`: Provide an ARN of a user or group, and
501
501
  # any analyses with that ARN listed as one of the owners of the
502
502
  # analyses are returned. Implicit permissions from folders or groups
503
503
  # are not considered.
504
504
  #
505
- # * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER`\: Provide an ARN of a user or
505
+ # * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER`: Provide an ARN of a user or
506
506
  # group, and any analyses with that ARN listed as one of the owners
507
507
  # or viewers of the analyses are returned. Implicit permissions from
508
508
  # folders or groups are not considered.
509
509
  #
510
- # * `ANALYSIS_NAME`\: Any analyses whose names have a substring match
510
+ # * `ANALYSIS_NAME`: Any analyses whose names have a substring match
511
511
  # to this value will be returned.
512
512
  # @return [String]
513
513
  #
@@ -1151,11 +1151,11 @@ module Aws::QuickSight
1151
1151
  # The orientation of the bars in a bar chart visual. There are two
1152
1152
  # valid values in this structure:
1153
1153
  #
1154
- # * `HORIZONTAL`\: Used for charts that have horizontal bars. Visuals
1154
+ # * `HORIZONTAL`: Used for charts that have horizontal bars. Visuals
1155
1155
  # that use this value are horizontal bar charts, horizontal stacked
1156
1156
  # bar charts, and horizontal stacked 100% bar charts.
1157
1157
  #
1158
- # * `VERTICAL`\: Used for charts that have vertical bars. Visuals that
1158
+ # * `VERTICAL`: Used for charts that have vertical bars. Visuals that
1159
1159
  # use this value are vertical bar charts, vertical stacked bar
1160
1160
  # charts, and vertical stacked 100% bar charts.
1161
1161
  # @return [String]
@@ -1996,9 +1996,9 @@ module Aws::QuickSight
1996
1996
  # The visibility of an axis label on a chart. Choose one of the
1997
1997
  # following options:
1998
1998
  #
1999
- # * `VISIBLE`\: Shows the axis.
1999
+ # * `VISIBLE`: Shows the axis.
2000
2000
  #
2001
- # * `HIDDEN`\: Hides the axis.
2001
+ # * `HIDDEN`: Hides the axis.
2002
2002
  # @return [String]
2003
2003
  #
2004
2004
  # @!attribute [rw] sort_icon_visibility
@@ -2375,11 +2375,11 @@ module Aws::QuickSight
2375
2375
  # Determines the bar arrangement in a combo chart. The following are
2376
2376
  # valid values in this structure:
2377
2377
  #
2378
- # * `CLUSTERED`\: For clustered bar combo charts.
2378
+ # * `CLUSTERED`: For clustered bar combo charts.
2379
2379
  #
2380
- # * `STACKED`\: For stacked bar combo charts.
2380
+ # * `STACKED`: For stacked bar combo charts.
2381
2381
  #
2382
- # * `STACKED_PERCENT`\: Do not use. If you use this value, the
2382
+ # * `STACKED_PERCENT`: Do not use. If you use this value, the
2383
2383
  # operation returns a validation error.
2384
2384
  # @return [String]
2385
2385
  #
@@ -4117,6 +4117,55 @@ module Aws::QuickSight
4117
4117
  include Aws::Structure
4118
4118
  end
4119
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
+
4120
4169
  # @!attribute [rw] aws_account_id
4121
4170
  # The ID of the Amazon Web Services account that contains the template
4122
4171
  # that you creating an alias for.
@@ -4577,11 +4626,11 @@ module Aws::QuickSight
4577
4626
  #
4578
4627
  # Valid values are defined as follows:
4579
4628
  #
4580
- # * `NEW_TAB`\: Opens the target URL in a new browser tab.
4629
+ # * `NEW_TAB`: Opens the target URL in a new browser tab.
4581
4630
  #
4582
- # * `NEW_WINDOW`\: Opens the target URL in a new browser window.
4631
+ # * `NEW_WINDOW`: Opens the target URL in a new browser window.
4583
4632
  #
4584
- # * `SAME_TAB`\: Opens the target URL in the same browser tab.
4633
+ # * `SAME_TAB`: Opens the target URL in the same browser tab.
4585
4634
  # @return [String]
4586
4635
  #
4587
4636
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CustomActionURLOperation AWS API Documentation
@@ -4704,11 +4753,11 @@ module Aws::QuickSight
4704
4753
  # This option determines how null values should be treated when
4705
4754
  # filtering data.
4706
4755
  #
4707
- # * `ALL_VALUES`\: Include null values in filtered results.
4756
+ # * `ALL_VALUES`: Include null values in filtered results.
4708
4757
  #
4709
- # * `NULLS_ONLY`\: Only include null values in filtered results.
4758
+ # * `NULLS_ONLY`: Only include null values in filtered results.
4710
4759
  #
4711
- # * `NON_NULLS_ONLY`\: Exclude null values from filtered results.
4760
+ # * `NON_NULLS_ONLY`: Exclude null values from filtered results.
4712
4761
  # @return [String]
4713
4762
  #
4714
4763
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CustomFilterConfiguration AWS API Documentation
@@ -4747,11 +4796,11 @@ module Aws::QuickSight
4747
4796
  # This option determines how null values should be treated when
4748
4797
  # filtering data.
4749
4798
  #
4750
- # * `ALL_VALUES`\: Include null values in filtered results.
4799
+ # * `ALL_VALUES`: Include null values in filtered results.
4751
4800
  #
4752
- # * `NULLS_ONLY`\: Only include null values in filtered results.
4801
+ # * `NULLS_ONLY`: Only include null values in filtered results.
4753
4802
  #
4754
- # * `NON_NULLS_ONLY`\: Exclude null values from filtered results.
4803
+ # * `NON_NULLS_ONLY`: Exclude null values from filtered results.
4755
4804
  # @return [String]
4756
4805
  #
4757
4806
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CustomFilterListConfiguration AWS API Documentation
@@ -5022,32 +5071,32 @@ module Aws::QuickSight
5022
5071
  #
5023
5072
  # Valid values are defined as follows:
5024
5073
  #
5025
- # * `QUICKSIGHT_VIEWER_OR_OWNER`\: Provide an ARN of a user or group,
5074
+ # * `QUICKSIGHT_VIEWER_OR_OWNER`: Provide an ARN of a user or group,
5026
5075
  # and any dashboards with that ARN listed as one of the
5027
5076
  # dashboards's owners or viewers are returned. Implicit permissions
5028
5077
  # from folders or groups are considered.
5029
5078
  #
5030
- # * `QUICKSIGHT_OWNER`\: Provide an ARN of a user or group, and any
5079
+ # * `QUICKSIGHT_OWNER`: Provide an ARN of a user or group, and any
5031
5080
  # dashboards with that ARN listed as one of the owners of the
5032
5081
  # dashboards are returned. Implicit permissions from folders or
5033
5082
  # groups are considered.
5034
5083
  #
5035
- # * `DIRECT_QUICKSIGHT_SOLE_OWNER`\: Provide an ARN of a user or
5036
- # group, and any dashboards with that ARN listed as the only owner
5037
- # of the dashboard are returned. Implicit permissions from folders
5038
- # or groups are not considered.
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.
5039
5088
  #
5040
- # * `DIRECT_QUICKSIGHT_OWNER`\: Provide an ARN of a user or group, and
5089
+ # * `DIRECT_QUICKSIGHT_OWNER`: Provide an ARN of a user or group, and
5041
5090
  # any dashboards with that ARN listed as one of the owners of the
5042
5091
  # dashboards are returned. Implicit permissions from folders or
5043
5092
  # groups are not considered.
5044
5093
  #
5045
- # * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER`\: Provide an ARN of a user or
5094
+ # * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER`: Provide an ARN of a user or
5046
5095
  # group, and any dashboards with that ARN listed as one of the
5047
5096
  # owners or viewers of the dashboards are returned. Implicit
5048
5097
  # permissions from folders or groups are not considered.
5049
5098
  #
5050
- # * `DASHBOARD_NAME`\: Any dashboards whose names have a substring
5099
+ # * `DASHBOARD_NAME`: Any dashboards whose names have a substring
5051
5100
  # match to this value will be returned.
5052
5101
  # @return [String]
5053
5102
  #
@@ -5854,6 +5903,20 @@ module Aws::QuickSight
5854
5903
  include Aws::Structure
5855
5904
  end
5856
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
+
5857
5920
  # Dataset schema.
5858
5921
  #
5859
5922
  # @!attribute [rw] column_schema_list
@@ -5895,33 +5958,33 @@ module Aws::QuickSight
5895
5958
  #
5896
5959
  # Valid values are defined as follows:
5897
5960
  #
5898
- # * `QUICKSIGHT_VIEWER_OR_OWNER`\: Provide an ARN of a user or group,
5961
+ # * `QUICKSIGHT_VIEWER_OR_OWNER`: Provide an ARN of a user or group,
5899
5962
  # and any datasets with that ARN listed as one of the dataset owners
5900
5963
  # or viewers are returned. Implicit permissions from folders or
5901
5964
  # groups are considered.
5902
5965
  #
5903
- # * `QUICKSIGHT_OWNER`\: Provide an ARN of a user or group, and any
5966
+ # * `QUICKSIGHT_OWNER`: Provide an ARN of a user or group, and any
5904
5967
  # datasets with that ARN listed as one of the owners of the dataset
5905
5968
  # are returned. Implicit permissions from folders or groups are
5906
5969
  # considered.
5907
5970
  #
5908
- # * `DIRECT_QUICKSIGHT_SOLE_OWNER`\: Provide an ARN of a user or
5909
- # group, and any datasets with that ARN listed as the only owner of
5910
- # the dataset are returned. Implicit permissions from folders or
5911
- # groups are not considered.
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.
5912
5975
  #
5913
- # * `DIRECT_QUICKSIGHT_OWNER`\: Provide an ARN of a user or group, and
5976
+ # * `DIRECT_QUICKSIGHT_OWNER`: Provide an ARN of a user or group, and
5914
5977
  # any datasets with that ARN listed as one of the owners if the
5915
5978
  # dataset are returned. Implicit permissions from folders or groups
5916
5979
  # are not considered.
5917
5980
  #
5918
- # * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER`\: Provide an ARN of a user or
5981
+ # * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER`: Provide an ARN of a user or
5919
5982
  # group, and any datasets with that ARN listed as one of the owners
5920
5983
  # or viewers of the dataset are returned. Implicit permissions from
5921
5984
  # folders or groups are not considered.
5922
5985
  #
5923
- # * `DATASET_NAME`\: Any datasets whose names have a substring match
5924
- # to this value will be returned.
5986
+ # * `DATASET_NAME`: Any datasets whose names have a substring match to
5987
+ # this value will be returned.
5925
5988
  # @return [String]
5926
5989
  #
5927
5990
  # @!attribute [rw] value
@@ -6313,22 +6376,22 @@ module Aws::QuickSight
6313
6376
  #
6314
6377
  # Valid values are defined as follows:
6315
6378
  #
6316
- # * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER`\: Provide an ARN of a user or
6379
+ # * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER`: Provide an ARN of a user or
6317
6380
  # group, and any data sources with that ARN listed as one of the
6318
6381
  # owners or viewers of the data sources are returned. Implicit
6319
6382
  # permissions from folders or groups are not considered.
6320
6383
  #
6321
- # * `DIRECT_QUICKSIGHT_OWNER`\: Provide an ARN of a user or group, and
6384
+ # * `DIRECT_QUICKSIGHT_OWNER`: Provide an ARN of a user or group, and
6322
6385
  # any data sources with that ARN listed as one of the owners if the
6323
6386
  # data source are returned. Implicit permissions from folders or
6324
6387
  # groups are not considered.
6325
6388
  #
6326
- # * `DIRECT_QUICKSIGHT_SOLE_OWNER`\: Provide an ARN of a user or
6327
- # group, and any data sources with that ARN listed as the only owner
6328
- # of the data source are returned. Implicit permissions from folders
6329
- # or groups are not considered.
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.
6330
6393
  #
6331
- # * `DATASOURCE_NAME`\: Any data sources whose names have a substring
6394
+ # * `DATASOURCE_NAME`: Any data sources whose names have a substring
6332
6395
  # match to the provided value are returned.
6333
6396
  # @return [String]
6334
6397
  #
@@ -6658,9 +6721,9 @@ module Aws::QuickSight
6658
6721
  # The built-in options for default values. The value can be one of the
6659
6722
  # following:
6660
6723
  #
6661
- # * `RECOMMENDED`\: The recommended value.
6724
+ # * `RECOMMENDED`: The recommended value.
6662
6725
  #
6663
- # * `NULL`\: The `NULL` value.
6726
+ # * `NULL`: The `NULL` value.
6664
6727
  # @return [String]
6665
6728
  #
6666
6729
  # @!attribute [rw] custom_value
@@ -6770,9 +6833,9 @@ module Aws::QuickSight
6770
6833
  # The built-in options for default values. The value can be one of the
6771
6834
  # following:
6772
6835
  #
6773
- # * `RECOMMENDED`\: The recommended value.
6836
+ # * `RECOMMENDED`: The recommended value.
6774
6837
  #
6775
- # * `NULL`\: The `NULL` value.
6838
+ # * `NULL`: The `NULL` value.
6776
6839
  # @return [String]
6777
6840
  #
6778
6841
  # @!attribute [rw] custom_value
@@ -7084,6 +7147,40 @@ module Aws::QuickSight
7084
7147
  include Aws::Structure
7085
7148
  end
7086
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
+
7087
7184
  # @!attribute [rw] aws_account_id
7088
7185
  # The Amazon Web Services account ID.
7089
7186
  # @return [String]
@@ -7434,6 +7531,55 @@ module Aws::QuickSight
7434
7531
  include Aws::Structure
7435
7532
  end
7436
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
+
7437
7583
  # @!attribute [rw] aws_account_id
7438
7584
  # The ID of the Amazon Web Services account that contains the item to
7439
7585
  # delete.
@@ -8353,6 +8499,45 @@ module Aws::QuickSight
8353
8499
  include Aws::Structure
8354
8500
  end
8355
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
+
8356
8541
  # @!attribute [rw] aws_account_id
8357
8542
  # The Amazon Web Services account ID.
8358
8543
  # @return [String]
@@ -8899,6 +9084,55 @@ module Aws::QuickSight
8899
9084
  include Aws::Structure
8900
9085
  end
8901
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
+
8902
9136
  # @!attribute [rw] aws_account_id
8903
9137
  # The ID of the Amazon Web Services account that contains the template
8904
9138
  # alias that you're describing.
@@ -9737,9 +9971,9 @@ module Aws::QuickSight
9737
9971
  # The type for the &gt;tooltip title. Choose one of the following
9738
9972
  # options:
9739
9973
  #
9740
- # * `NONE`\: Doesn't use the primary value as the title.
9974
+ # * `NONE`: Doesn't use the primary value as the title.
9741
9975
  #
9742
- # * `PRIMARY_VALUE`\: Uses primary value as the title.
9976
+ # * `PRIMARY_VALUE`: Uses primary value as the title.
9743
9977
  # @return [String]
9744
9978
  #
9745
9979
  # @!attribute [rw] tooltip_fields
@@ -9830,9 +10064,9 @@ module Aws::QuickSight
9830
10064
  # @!attribute [rw] direction
9831
10065
  # The sort direction. Choose one of the following options:
9832
10066
  #
9833
- # * `ASC`\: Ascending
10067
+ # * `ASC`: Ascending
9834
10068
  #
9835
- # * `DESC`\: Descending
10069
+ # * `DESC`: Descending
9836
10070
  # @return [String]
9837
10071
  #
9838
10072
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FieldSort AWS API Documentation
@@ -10220,9 +10454,9 @@ module Aws::QuickSight
10220
10454
  # The date time picker type of a `FilterDateTimePickerControl`. Choose
10221
10455
  # one of the following options:
10222
10456
  #
10223
- # * `SINGLE_VALUED`\: The filter condition is a fixed date.
10457
+ # * `SINGLE_VALUED`: The filter condition is a fixed date.
10224
10458
  #
10225
- # * `DATE_RANGE`\: The filter condition is a date time range.
10459
+ # * `DATE_RANGE`: The filter condition is a date time range.
10226
10460
  # @return [String]
10227
10461
  #
10228
10462
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FilterDateTimePickerControl AWS API Documentation
@@ -10260,10 +10494,10 @@ module Aws::QuickSight
10260
10494
  # The type of the `FilterDropDownControl`. Choose one of the following
10261
10495
  # options:
10262
10496
  #
10263
- # * `MULTI_SELECT`\: The user can select multiple entries from a
10497
+ # * `MULTI_SELECT`: The user can select multiple entries from a
10264
10498
  # dropdown menu.
10265
10499
  #
10266
- # * `SINGLE_SELECT`\: The user can select a single entry from a
10500
+ # * `SINGLE_SELECT`: The user can select a single entry from a
10267
10501
  # dropdown menu.
10268
10502
  # @return [String]
10269
10503
  #
@@ -10396,11 +10630,10 @@ module Aws::QuickSight
10396
10630
  # The type of `FilterListControl`. Choose one of the following
10397
10631
  # options:
10398
10632
  #
10399
- # * `MULTI_SELECT`\: The user can select multiple entries from the
10633
+ # * `MULTI_SELECT`: The user can select multiple entries from the
10400
10634
  # list.
10401
10635
  #
10402
- # * `SINGLE_SELECT`\: The user can select a single entry from the
10403
- # list.
10636
+ # * `SINGLE_SELECT`: The user can select a single entry from the list.
10404
10637
  # @return [String]
10405
10638
  #
10406
10639
  # @!attribute [rw] selectable_values
@@ -10459,7 +10692,7 @@ module Aws::QuickSight
10459
10692
  #
10460
10693
  # Valid values are defined as follows:
10461
10694
  #
10462
- # * `ALL_FIELDS`\: Applies the filter operation to all fields.
10695
+ # * `ALL_FIELDS`: Applies the filter operation to all fields.
10463
10696
  #
10464
10697
  # ^
10465
10698
  # @return [String]
@@ -10575,9 +10808,9 @@ module Aws::QuickSight
10575
10808
  # The type of `FilterSliderControl`. Choose one of the following
10576
10809
  # options:
10577
10810
  #
10578
- # * `SINGLE_POINT`\: Filter against(equals) a single data point.
10811
+ # * `SINGLE_POINT`: Filter against(equals) a single data point.
10579
10812
  #
10580
- # * `RANGE`\: Filter data that is in a specified range.
10813
+ # * `RANGE`: Filter data that is in a specified range.
10581
10814
  # @return [String]
10582
10815
  #
10583
10816
  # @!attribute [rw] maximum_value
@@ -10762,35 +10995,35 @@ module Aws::QuickSight
10762
10995
  #
10763
10996
  # Valid values are defined as follows:
10764
10997
  #
10765
- # * `QUICKSIGHT_VIEWER_OR_OWNER`\: Provide an ARN of a user or group,
10998
+ # * `QUICKSIGHT_VIEWER_OR_OWNER`: Provide an ARN of a user or group,
10766
10999
  # and any folders with that ARN listed as one of the folder's
10767
11000
  # owners or viewers are returned. Implicit permissions from folders
10768
11001
  # or groups are considered.
10769
11002
  #
10770
- # * `QUICKSIGHT_OWNER`\: Provide an ARN of a user or group, and any
11003
+ # * `QUICKSIGHT_OWNER`: Provide an ARN of a user or group, and any
10771
11004
  # folders with that ARN listed as one of the owners of the folders
10772
11005
  # are returned. Implicit permissions from folders or groups are
10773
11006
  # considered.
10774
11007
  #
10775
- # * `DIRECT_QUICKSIGHT_SOLE_OWNER`\: Provide an ARN of a user or
10776
- # group, and any folders with that ARN listed as the only owner of
10777
- # the folder are returned. Implicit permissions from folders or
10778
- # groups are not considered.
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.
10779
11012
  #
10780
- # * `DIRECT_QUICKSIGHT_OWNER`\: Provide an ARN of a user or group, and
11013
+ # * `DIRECT_QUICKSIGHT_OWNER`: Provide an ARN of a user or group, and
10781
11014
  # any folders with that ARN listed as one of the owners of the
10782
11015
  # folders are returned. Implicit permissions from folders or groups
10783
11016
  # are not considered.
10784
11017
  #
10785
- # * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER`\: Provide an ARN of a user or
11018
+ # * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER`: Provide an ARN of a user or
10786
11019
  # group, and any folders with that ARN listed as one of the owners
10787
11020
  # or viewers of the folders are returned. Implicit permissions from
10788
11021
  # folders or groups are not considered.
10789
11022
  #
10790
- # * `FOLDER_NAME`\: Any folders whose names have a substring match to
11023
+ # * `FOLDER_NAME`: Any folders whose names have a substring match to
10791
11024
  # this value will be returned.
10792
11025
  #
10793
- # * `PARENT_FOLDER_ARN`\: Provide an ARN of a folder, and any folders
11026
+ # * `PARENT_FOLDER_ARN`: Provide an ARN of a folder, and any folders
10794
11027
  # that are directly under that parent folder are returned. If you
10795
11028
  # choose to use this option and leave the value blank, all
10796
11029
  # root-level folders in the account are returned.
@@ -10973,7 +11206,7 @@ module Aws::QuickSight
10973
11206
  #
10974
11207
  # * `AUTOMATIC`
10975
11208
  #
10976
- # * `CUSTOM`\: Checks the custom seasonality value.
11209
+ # * `CUSTOM`: Checks the custom seasonality value.
10977
11210
  # @return [String]
10978
11211
  #
10979
11212
  # @!attribute [rw] custom_seasonality_value
@@ -12396,10 +12629,10 @@ module Aws::QuickSight
12396
12629
  # This value determines the layout behavior when the viewport is
12397
12630
  # resized.
12398
12631
  #
12399
- # * `FIXED`\: A fixed width will be used when optimizing the layout.
12400
- # In the Amazon QuickSight console, this option is called `Classic`.
12632
+ # * `FIXED`: A fixed width will be used when optimizing the layout. In
12633
+ # the Amazon QuickSight console, this option is called `Classic`.
12401
12634
  #
12402
- # * `RESPONSIVE`\: The width of the canvas will be responsive and
12635
+ # * `RESPONSIVE`: The width of the canvas will be responsive and
12403
12636
  # optimized to the view port. In the Amazon QuickSight console, this
12404
12637
  # option is called `Tiled`.
12405
12638
  # @return [String]
@@ -12968,6 +13201,20 @@ module Aws::QuickSight
12968
13201
  include Aws::Structure
12969
13202
  end
12970
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
+
12971
13218
  # Information about the SPICE ingestion for a dataset.
12972
13219
  #
12973
13220
  # @!attribute [rw] arn
@@ -13200,9 +13447,9 @@ module Aws::QuickSight
13200
13447
  # The built-in options for default values. The value can be one of the
13201
13448
  # following:
13202
13449
  #
13203
- # * `RECOMMENDED`\: The recommended value.
13450
+ # * `RECOMMENDED`: The recommended value.
13204
13451
  #
13205
- # * `NULL`\: The `NULL` value.
13452
+ # * `NULL`: The `NULL` value.
13206
13453
  # @return [String]
13207
13454
  #
13208
13455
  # @!attribute [rw] custom_value
@@ -13953,21 +14200,21 @@ module Aws::QuickSight
13953
14200
  # @!attribute [rw] line_interpolation
13954
14201
  # Interpolation style for line series.
13955
14202
  #
13956
- # * `LINEAR`\: Show as default, linear style.
14203
+ # * `LINEAR`: Show as default, linear style.
13957
14204
  #
13958
- # * `SMOOTH`\: Show as a smooth curve.
14205
+ # * `SMOOTH`: Show as a smooth curve.
13959
14206
  #
13960
- # * `STEPPED`\: Show steps in line.
14207
+ # * `STEPPED`: Show steps in line.
13961
14208
  # @return [String]
13962
14209
  #
13963
14210
  # @!attribute [rw] line_style
13964
14211
  # Line style for line series.
13965
14212
  #
13966
- # * `SOLID`\: Show as a solid line.
14213
+ # * `SOLID`: Show as a solid line.
13967
14214
  #
13968
- # * `DOTTED`\: Show as a dotted line.
14215
+ # * `DOTTED`: Show as a dotted line.
13969
14216
  #
13970
- # * `DASHED`\: Show as a dashed line.
14217
+ # * `DASHED`: Show as a dashed line.
13971
14218
  # @return [String]
13972
14219
  #
13973
14220
  # @!attribute [rw] line_width
@@ -13995,15 +14242,15 @@ module Aws::QuickSight
13995
14242
  # @!attribute [rw] marker_shape
13996
14243
  # Shape option for markers in the series.
13997
14244
  #
13998
- # * `CIRCLE`\: Show marker as a circle.
14245
+ # * `CIRCLE`: Show marker as a circle.
13999
14246
  #
14000
- # * `TRIANGLE`\: Show marker as a triangle.
14247
+ # * `TRIANGLE`: Show marker as a triangle.
14001
14248
  #
14002
- # * `SQUARE`\: Show marker as a square.
14249
+ # * `SQUARE`: Show marker as a square.
14003
14250
  #
14004
- # * `DIAMOND`\: Show marker as a diamond.
14251
+ # * `DIAMOND`: Show marker as a diamond.
14005
14252
  #
14006
- # * `ROUNDED_SQUARE`\: Show marker as a rounded square.
14253
+ # * `ROUNDED_SQUARE`: Show marker as a rounded square.
14007
14254
  # @return [String]
14008
14255
  #
14009
14256
  # @!attribute [rw] marker_size
@@ -14956,6 +15203,45 @@ module Aws::QuickSight
14956
15203
  include Aws::Structure
14957
15204
  end
14958
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
+
14959
15245
  # @!attribute [rw] resource_arn
14960
15246
  # The Amazon Resource Name (ARN) of the resource that you want a list
14961
15247
  # of tags for.
@@ -15564,6 +15850,31 @@ module Aws::QuickSight
15564
15850
  include Aws::Structure
15565
15851
  end
15566
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
+
15567
15878
  # Amazon S3 manifest file location.
15568
15879
  #
15569
15880
  # @!attribute [rw] bucket
@@ -15777,12 +16088,12 @@ module Aws::QuickSight
15777
16088
  # The treatment option that determines how missing data should be
15778
16089
  # rendered. Choose from the following options:
15779
16090
  #
15780
- # * `INTERPOLATE`\: Interpolate missing values between the prior and
16091
+ # * `INTERPOLATE`: Interpolate missing values between the prior and
15781
16092
  # the next known value.
15782
16093
  #
15783
- # * `SHOW_AS_ZERO`\: Show missing values as the value `0`.
16094
+ # * `SHOW_AS_ZERO`: Show missing values as the value `0`.
15784
16095
  #
15785
- # * `SHOW_AS_BLANK`\: Display a blank space when rendering missing
16096
+ # * `SHOW_AS_BLANK`: Display a blank space when rendering missing
15786
16097
  # data.
15787
16098
  # @return [String]
15788
16099
  #
@@ -16043,11 +16354,11 @@ module Aws::QuickSight
16043
16354
  # This option determines how null values should be treated when
16044
16355
  # filtering data.
16045
16356
  #
16046
- # * `ALL_VALUES`\: Include null values in filtered results.
16357
+ # * `ALL_VALUES`: Include null values in filtered results.
16047
16358
  #
16048
- # * `NULLS_ONLY`\: Only include null values in filtered results.
16359
+ # * `NULLS_ONLY`: Only include null values in filtered results.
16049
16360
  #
16050
- # * `NON_NULLS_ONLY`\: Exclude null values from filtered results.
16361
+ # * `NON_NULLS_ONLY`: Exclude null values from filtered results.
16051
16362
  # @return [String]
16052
16363
  #
16053
16364
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/NumericEqualityFilter AWS API Documentation
@@ -16140,11 +16451,11 @@ module Aws::QuickSight
16140
16451
  # This option determines how null values should be treated when
16141
16452
  # filtering data.
16142
16453
  #
16143
- # * `ALL_VALUES`\: Include null values in filtered results.
16454
+ # * `ALL_VALUES`: Include null values in filtered results.
16144
16455
  #
16145
- # * `NULLS_ONLY`\: Only include null values in filtered results.
16456
+ # * `NULLS_ONLY`: Only include null values in filtered results.
16146
16457
  #
16147
- # * `NON_NULLS_ONLY`\: Exclude null values from filtered results.
16458
+ # * `NON_NULLS_ONLY`: Exclude null values from filtered results.
16148
16459
  # @return [String]
16149
16460
  #
16150
16461
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/NumericRangeFilter AWS API Documentation
@@ -16206,29 +16517,29 @@ module Aws::QuickSight
16206
16517
  # @!attribute [rw] simple_numerical_aggregation
16207
16518
  # Built-in aggregation functions for numerical values.
16208
16519
  #
16209
- # * `SUM`\: The sum of a dimension or measure.
16520
+ # * `SUM`: The sum of a dimension or measure.
16210
16521
  #
16211
- # * `AVERAGE`\: The average of a dimension or measure.
16522
+ # * `AVERAGE`: The average of a dimension or measure.
16212
16523
  #
16213
- # * `MIN`\: The minimum value of a dimension or measure.
16524
+ # * `MIN`: The minimum value of a dimension or measure.
16214
16525
  #
16215
- # * `MAX`\: The maximum value of a dimension or measure.
16526
+ # * `MAX`: The maximum value of a dimension or measure.
16216
16527
  #
16217
- # * `COUNT`\: The count of a dimension or measure.
16528
+ # * `COUNT`: The count of a dimension or measure.
16218
16529
  #
16219
- # * `DISTINCT_COUNT`\: The count of distinct values in a dimension or
16530
+ # * `DISTINCT_COUNT`: The count of distinct values in a dimension or
16220
16531
  # measure.
16221
16532
  #
16222
- # * `VAR`\: The variance of a dimension or measure.
16533
+ # * `VAR`: The variance of a dimension or measure.
16223
16534
  #
16224
- # * `VARP`\: The partitioned variance of a dimension or measure.
16535
+ # * `VARP`: The partitioned variance of a dimension or measure.
16225
16536
  #
16226
- # * `STDEV`\: The standard deviation of a dimension or measure.
16537
+ # * `STDEV`: The standard deviation of a dimension or measure.
16227
16538
  #
16228
- # * `STDEVP`\: The partitioned standard deviation of a dimension or
16539
+ # * `STDEVP`: The partitioned standard deviation of a dimension or
16229
16540
  # measure.
16230
16541
  #
16231
- # * `MEDIAN`\: The median value of a dimension or measure.
16542
+ # * `MEDIAN`: The median value of a dimension or measure.
16232
16543
  # @return [String]
16233
16544
  #
16234
16545
  # @!attribute [rw] percentile_aggregation
@@ -17807,6 +18118,45 @@ module Aws::QuickSight
17807
18118
  include Aws::Structure
17808
18119
  end
17809
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
+
17810
18160
  # Information about a queued dataset SPICE ingestion.
17811
18161
  #
17812
18162
  # @!attribute [rw] waiting_on_ingestion
@@ -18349,14 +18699,127 @@ module Aws::QuickSight
18349
18699
  include Aws::Structure
18350
18700
  end
18351
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
+
18352
18816
  # @!attribute [rw] identity_type
18353
18817
  # Amazon QuickSight supports several ways of managing the identity of
18354
18818
  # users. This parameter accepts two values:
18355
18819
  #
18356
- # * `IAM`\: A user whose identity maps to an existing IAM user or
18357
- # role.
18820
+ # * `IAM`: A user whose identity maps to an existing IAM user or role.
18358
18821
  #
18359
- # * `QUICKSIGHT`\: A user whose identity is owned and managed
18822
+ # * `QUICKSIGHT`: A user whose identity is owned and managed
18360
18823
  # internally by Amazon QuickSight.
18361
18824
  # @return [String]
18362
18825
  #
@@ -18368,19 +18831,17 @@ module Aws::QuickSight
18368
18831
  # The Amazon QuickSight role for the user. The user role can be one of
18369
18832
  # the following:
18370
18833
  #
18371
- # * `READER`\: A user who has read-only access to dashboards.
18834
+ # * `READER`: A user who has read-only access to dashboards.
18372
18835
  #
18373
- # * `AUTHOR`\: A user who can create data sources, datasets, analyses,
18836
+ # * `AUTHOR`: A user who can create data sources, datasets, analyses,
18374
18837
  # and dashboards.
18375
18838
  #
18376
- # * `ADMIN`\: A user who is an author, who can also manage Amazon
18839
+ # * `ADMIN`: A user who is an author, who can also manage Amazon
18377
18840
  # QuickSight settings.
18378
18841
  #
18379
- # * `RESTRICTED_READER`\: This role isn't currently available for
18380
- # use.
18842
+ # * `RESTRICTED_READER`: This role isn't currently available for use.
18381
18843
  #
18382
- # * `RESTRICTED_AUTHOR`\: This role isn't currently available for
18383
- # use.
18844
+ # * `RESTRICTED_AUTHOR`: This role isn't currently available for use.
18384
18845
  # @return [String]
18385
18846
  #
18386
18847
  # @!attribute [rw] iam_arn
@@ -18455,13 +18916,13 @@ module Aws::QuickSight
18455
18916
  # Identity and Access Management(IAM) role. The type of supported
18456
18917
  # external login provider can be one of the following.
18457
18918
  #
18458
- # * `COGNITO`\: Amazon Cognito. The provider URL is
18919
+ # * `COGNITO`: Amazon Cognito. The provider URL is
18459
18920
  # cognito-identity.amazonaws.com. When choosing the `COGNITO`
18460
18921
  # provider type, don’t use the "CustomFederationProviderUrl"
18461
18922
  # parameter which is only needed when the external provider is
18462
18923
  # custom.
18463
18924
  #
18464
- # * `CUSTOM_OIDC`\: Custom OpenID Connect (OIDC) provider. When
18925
+ # * `CUSTOM_OIDC`: Custom OpenID Connect (OIDC) provider. When
18465
18926
  # choosing `CUSTOM_OIDC` type, use the `CustomFederationProviderUrl`
18466
18927
  # parameter to provide the custom OIDC provider URL.
18467
18928
  # @return [String]
@@ -18634,7 +19095,7 @@ module Aws::QuickSight
18634
19095
  # the ` UpdateUser ` API operation. Use the ` RegisterUser ` API
18635
19096
  # operation to add a new user with a custom permission profile
18636
19097
  # attached. For more information, see the following sections in the
18637
- # *Amazon QuickSight User Guide*\:
19098
+ # *Amazon QuickSight User Guide*:
18638
19099
  #
18639
19100
  # * [Embedding the Full Functionality of the Amazon QuickSight Console
18640
19101
  # for Authenticated Users][2]
@@ -18844,11 +19305,11 @@ module Aws::QuickSight
18844
19305
  # This option determines how null values should be treated when
18845
19306
  # filtering data.
18846
19307
  #
18847
- # * `ALL_VALUES`\: Include null values in filtered results.
19308
+ # * `ALL_VALUES`: Include null values in filtered results.
18848
19309
  #
18849
- # * `NULLS_ONLY`\: Only include null values in filtered results.
19310
+ # * `NULLS_ONLY`: Only include null values in filtered results.
18850
19311
  #
18851
- # * `NON_NULLS_ONLY`\: Exclude null values from filtered results.
19312
+ # * `NON_NULLS_ONLY`: Exclude null values from filtered results.
18852
19313
  # @return [String]
18853
19314
  #
18854
19315
  # @!attribute [rw] exclude_period_configuration
@@ -19167,11 +19628,20 @@ module Aws::QuickSight
19167
19628
  # names and columns that they are assigned to.
19168
19629
  # @return [Array<Types::RowLevelPermissionTagRule>]
19169
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
+ #
19170
19639
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RowLevelPermissionTagConfiguration AWS API Documentation
19171
19640
  #
19172
19641
  class RowLevelPermissionTagConfiguration < Struct.new(
19173
19642
  :status,
19174
- :tag_rules)
19643
+ :tag_rules,
19644
+ :tag_rule_configurations)
19175
19645
  SENSITIVE = []
19176
19646
  include Aws::Structure
19177
19647
  end
@@ -19280,7 +19750,7 @@ module Aws::QuickSight
19280
19750
  #
19281
19751
  # Valid values are defined as follows:
19282
19752
  #
19283
- # * `ALL_VISUALS`\: Applies the filter operation to all visuals in the
19753
+ # * `ALL_VISUALS`: Applies the filter operation to all visuals in the
19284
19754
  # same sheet.
19285
19755
  #
19286
19756
  # ^
@@ -19622,6 +20092,25 @@ module Aws::QuickSight
19622
20092
  include Aws::Structure
19623
20093
  end
19624
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
+
19625
20114
  # The visual display options for a data zoom scroll bar.
19626
20115
  #
19627
20116
  # @!attribute [rw] visibility
@@ -20420,9 +20909,9 @@ module Aws::QuickSight
20420
20909
  # The layout content type of the sheet. Choose one of the following
20421
20910
  # options:
20422
20911
  #
20423
- # * `PAGINATED`\: Creates a sheet for a paginated report.
20912
+ # * `PAGINATED`: Creates a sheet for a paginated report.
20424
20913
  #
20425
- # * `INTERACTIVE`\: Creates a sheet for an interactive dashboard.
20914
+ # * `INTERACTIVE`: Creates a sheet for an interactive dashboard.
20426
20915
  # @return [String]
20427
20916
  #
20428
20917
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SheetDefinition AWS API Documentation
@@ -20906,9 +21395,9 @@ module Aws::QuickSight
20906
21395
  # The built-in options for default values. The value can be one of the
20907
21396
  # following:
20908
21397
  #
20909
- # * `RECOMMENDED`\: The recommended value.
21398
+ # * `RECOMMENDED`: The recommended value.
20910
21399
  #
20911
- # * `NULL`\: The `NULL` value.
21400
+ # * `NULL`: The `NULL` value.
20912
21401
  # @return [String]
20913
21402
  #
20914
21403
  # @!attribute [rw] custom_value
@@ -22453,9 +22942,9 @@ module Aws::QuickSight
22453
22942
  # The seasonality setup of a forecast computation. Choose one of the
22454
22943
  # following options:
22455
22944
  #
22456
- # * `NULL`\: The input is set to `NULL`.
22945
+ # * `NULL`: The input is set to `NULL`.
22457
22946
  #
22458
- # * `NON_NULL`\: The input is set to a custom value.
22947
+ # * `NON_NULL`: The input is set to a custom value.
22459
22948
  # @return [Integer]
22460
22949
  #
22461
22950
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TimeBasedForecastProperties AWS API Documentation
@@ -22575,11 +23064,11 @@ module Aws::QuickSight
22575
23064
  # This option determines how null values should be treated when
22576
23065
  # filtering data.
22577
23066
  #
22578
- # * `ALL_VALUES`\: Include null values in filtered results.
23067
+ # * `ALL_VALUES`: Include null values in filtered results.
22579
23068
  #
22580
- # * `NULLS_ONLY`\: Only include null values in filtered results.
23069
+ # * `NULLS_ONLY`: Only include null values in filtered results.
22581
23070
  #
22582
- # * `NON_NULLS_ONLY`\: Exclude null values from filtered results.
23071
+ # * `NON_NULLS_ONLY`: Exclude null values from filtered results.
22583
23072
  # @return [String]
22584
23073
  #
22585
23074
  # @!attribute [rw] exclude_period_configuration
@@ -22666,9 +23155,9 @@ module Aws::QuickSight
22666
23155
  # The selected type for the tooltip. Choose one of the following
22667
23156
  # options:
22668
23157
  #
22669
- # * `BASIC`\: A basic tooltip.
23158
+ # * `BASIC`: A basic tooltip.
22670
23159
  #
22671
- # * `DETAILED`\: A detailed tooltip.
23160
+ # * `DETAILED`: A detailed tooltip.
22672
23161
  # @return [String]
22673
23162
  #
22674
23163
  # @!attribute [rw] field_based_tooltip
@@ -24592,6 +25081,55 @@ module Aws::QuickSight
24592
25081
  include Aws::Structure
24593
25082
  end
24594
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
+
24595
25133
  # @!attribute [rw] aws_account_id
24596
25134
  # The ID of the Amazon Web Services account that contains the template
24597
25135
  # alias that you're updating.
@@ -25012,12 +25550,12 @@ module Aws::QuickSight
25012
25550
  # The Amazon QuickSight role of the user. The role can be one of the
25013
25551
  # following default security cohorts:
25014
25552
  #
25015
- # * `READER`\: A user who has read-only access to dashboards.
25553
+ # * `READER`: A user who has read-only access to dashboards.
25016
25554
  #
25017
- # * `AUTHOR`\: A user who can create data sources, datasets, analyses,
25555
+ # * `AUTHOR`: A user who can create data sources, datasets, analyses,
25018
25556
  # and dashboards.
25019
25557
  #
25020
- # * `ADMIN`\: A user who is an author, who can also manage Amazon
25558
+ # * `ADMIN`: A user who is an author, who can also manage Amazon
25021
25559
  # QuickSight settings.
25022
25560
  #
25023
25561
  # The name of the Amazon QuickSight role is invisible to the user
@@ -25067,17 +25605,17 @@ module Aws::QuickSight
25067
25605
  # Identity and Access Management(IAM) role. The type of supported
25068
25606
  # external login provider can be one of the following.
25069
25607
  #
25070
- # * `COGNITO`\: Amazon Cognito. The provider URL is
25608
+ # * `COGNITO`: Amazon Cognito. The provider URL is
25071
25609
  # cognito-identity.amazonaws.com. When choosing the `COGNITO`
25072
25610
  # provider type, don’t use the "CustomFederationProviderUrl"
25073
25611
  # parameter which is only needed when the external provider is
25074
25612
  # custom.
25075
25613
  #
25076
- # * `CUSTOM_OIDC`\: Custom OpenID Connect (OIDC) provider. When
25614
+ # * `CUSTOM_OIDC`: Custom OpenID Connect (OIDC) provider. When
25077
25615
  # choosing `CUSTOM_OIDC` type, use the `CustomFederationProviderUrl`
25078
25616
  # parameter to provide the custom OIDC provider URL.
25079
25617
  #
25080
- # * `NONE`\: This clears all the previously saved external login
25618
+ # * `NONE`: This clears all the previously saved external login
25081
25619
  # information for a user. Use the ` DescribeUser ` API operation to
25082
25620
  # check the external login information.
25083
25621
  # @return [String]
@@ -25189,19 +25727,17 @@ module Aws::QuickSight
25189
25727
  # The Amazon QuickSight role for the user. The user role can be one of
25190
25728
  # the following:.
25191
25729
  #
25192
- # * `READER`\: A user who has read-only access to dashboards.
25730
+ # * `READER`: A user who has read-only access to dashboards.
25193
25731
  #
25194
- # * `AUTHOR`\: A user who can create data sources, datasets, analyses,
25732
+ # * `AUTHOR`: A user who can create data sources, datasets, analyses,
25195
25733
  # and dashboards.
25196
25734
  #
25197
- # * `ADMIN`\: A user who is an author, who can also manage Amazon
25735
+ # * `ADMIN`: A user who is an author, who can also manage Amazon
25198
25736
  # Amazon QuickSight settings.
25199
25737
  #
25200
- # * `RESTRICTED_READER`\: This role isn't currently available for
25201
- # use.
25738
+ # * `RESTRICTED_READER`: This role isn't currently available for use.
25202
25739
  #
25203
- # * `RESTRICTED_AUTHOR`\: This role isn't currently available for
25204
- # use.
25740
+ # * `RESTRICTED_AUTHOR`: This role isn't currently available for use.
25205
25741
  # @return [String]
25206
25742
  #
25207
25743
  # @!attribute [rw] identity_type
@@ -25227,10 +25763,10 @@ module Aws::QuickSight
25227
25763
  # to let the user federate into Amazon QuickSight with an associated
25228
25764
  # IAM role. The type can be one of the following.
25229
25765
  #
25230
- # * `COGNITO`\: Amazon Cognito. The provider URL is
25766
+ # * `COGNITO`: Amazon Cognito. The provider URL is
25231
25767
  # cognito-identity.amazonaws.com.
25232
25768
  #
25233
- # * `CUSTOM_OIDC`\: Custom OpenID Connect (OIDC) provider.
25769
+ # * `CUSTOM_OIDC`: Custom OpenID Connect (OIDC) provider.
25234
25770
  # @return [String]
25235
25771
  #
25236
25772
  # @!attribute [rw] external_login_federation_provider_url
@@ -25587,10 +26123,10 @@ module Aws::QuickSight
25587
26123
  #
25588
26124
  # Valid values are defined as follows:
25589
26125
  #
25590
- # * `DATA_POINT_CLICK`\: Initiates a custom action by a left pointer
26126
+ # * `DATA_POINT_CLICK`: Initiates a custom action by a left pointer
25591
26127
  # click on a data point.
25592
26128
  #
25593
- # * `DATA_POINT_MENU`\: Initiates a custom action by right pointer
26129
+ # * `DATA_POINT_MENU`: Initiates a custom action by right pointer
25594
26130
  # click from the menu.
25595
26131
  # @return [String]
25596
26132
  #