aws-sdk-quicksight 1.77.0 → 1.79.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight/client.rb +2132 -71
- data/lib/aws-sdk-quicksight/client_api.rb +1281 -4
- data/lib/aws-sdk-quicksight/endpoints.rb +364 -0
- data/lib/aws-sdk-quicksight/plugins/endpoints.rb +52 -0
- data/lib/aws-sdk-quicksight/types.rb +3537 -330
- data/lib/aws-sdk-quicksight.rb +1 -1
- metadata +2 -2
@@ -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
|
@@ -482,32 +482,32 @@ module Aws::QuickSight
|
|
482
482
|
#
|
483
483
|
# Valid values are defined as follows:
|
484
484
|
#
|
485
|
-
# * `QUICKSIGHT_VIEWER_OR_OWNER
|
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
|
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
|
496
|
-
#
|
497
|
-
#
|
498
|
-
#
|
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
|
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
|
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
|
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
|
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
|
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]
|
@@ -1441,6 +1441,21 @@ module Aws::QuickSight
|
|
1441
1441
|
include Aws::Structure
|
1442
1442
|
end
|
1443
1443
|
|
1444
|
+
# The bookmarks configuration of an embedded dashboard.
|
1445
|
+
#
|
1446
|
+
# @!attribute [rw] enabled
|
1447
|
+
# A Boolean value that determines whether a user can bookmark an
|
1448
|
+
# embedded dashboard.
|
1449
|
+
# @return [Boolean]
|
1450
|
+
#
|
1451
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/BookmarksConfigurations AWS API Documentation
|
1452
|
+
#
|
1453
|
+
class BookmarksConfigurations < Struct.new(
|
1454
|
+
:enabled)
|
1455
|
+
SENSITIVE = []
|
1456
|
+
include Aws::Structure
|
1457
|
+
end
|
1458
|
+
|
1444
1459
|
# The display options for tile borders for visuals.
|
1445
1460
|
#
|
1446
1461
|
# @!attribute [rw] show
|
@@ -1990,15 +2005,34 @@ module Aws::QuickSight
|
|
1990
2005
|
include Aws::Structure
|
1991
2006
|
end
|
1992
2007
|
|
2008
|
+
# A structure that represents the cell value synonym.
|
2009
|
+
#
|
2010
|
+
# @!attribute [rw] cell_value
|
2011
|
+
# The cell value.
|
2012
|
+
# @return [String]
|
2013
|
+
#
|
2014
|
+
# @!attribute [rw] synonyms
|
2015
|
+
# Other names or aliases for the cell value.
|
2016
|
+
# @return [Array<String>]
|
2017
|
+
#
|
2018
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CellValueSynonym AWS API Documentation
|
2019
|
+
#
|
2020
|
+
class CellValueSynonym < Struct.new(
|
2021
|
+
:cell_value,
|
2022
|
+
:synonyms)
|
2023
|
+
SENSITIVE = []
|
2024
|
+
include Aws::Structure
|
2025
|
+
end
|
2026
|
+
|
1993
2027
|
# The label options for an axis on a chart.
|
1994
2028
|
#
|
1995
2029
|
# @!attribute [rw] visibility
|
1996
2030
|
# The visibility of an axis label on a chart. Choose one of the
|
1997
2031
|
# following options:
|
1998
2032
|
#
|
1999
|
-
# * `VISIBLE
|
2033
|
+
# * `VISIBLE`: Shows the axis.
|
2000
2034
|
#
|
2001
|
-
# * `HIDDEN
|
2035
|
+
# * `HIDDEN`: Hides the axis.
|
2002
2036
|
# @return [String]
|
2003
2037
|
#
|
2004
2038
|
# @!attribute [rw] sort_icon_visibility
|
@@ -2050,6 +2084,20 @@ module Aws::QuickSight
|
|
2050
2084
|
include Aws::Structure
|
2051
2085
|
end
|
2052
2086
|
|
2087
|
+
# A structure that represents a collective constant.
|
2088
|
+
#
|
2089
|
+
# @!attribute [rw] value_list
|
2090
|
+
# A list of values for the collective constant.
|
2091
|
+
# @return [Array<String>]
|
2092
|
+
#
|
2093
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CollectiveConstant AWS API Documentation
|
2094
|
+
#
|
2095
|
+
class CollectiveConstant < Struct.new(
|
2096
|
+
:value_list)
|
2097
|
+
SENSITIVE = []
|
2098
|
+
include Aws::Structure
|
2099
|
+
end
|
2100
|
+
|
2053
2101
|
# Determines the color scale that is applied to the visual.
|
2054
2102
|
#
|
2055
2103
|
# @!attribute [rw] colors
|
@@ -2375,11 +2423,11 @@ module Aws::QuickSight
|
|
2375
2423
|
# Determines the bar arrangement in a combo chart. The following are
|
2376
2424
|
# valid values in this structure:
|
2377
2425
|
#
|
2378
|
-
# * `CLUSTERED
|
2426
|
+
# * `CLUSTERED`: For clustered bar combo charts.
|
2379
2427
|
#
|
2380
|
-
# * `STACKED
|
2428
|
+
# * `STACKED`: For stacked bar combo charts.
|
2381
2429
|
#
|
2382
|
-
# * `STACKED_PERCENT
|
2430
|
+
# * `STACKED_PERCENT`: Do not use. If you use this value, the
|
2383
2431
|
# operation returns a validation error.
|
2384
2432
|
# @return [String]
|
2385
2433
|
#
|
@@ -2570,6 +2618,32 @@ module Aws::QuickSight
|
|
2570
2618
|
include Aws::Structure
|
2571
2619
|
end
|
2572
2620
|
|
2621
|
+
# A structure that represents a comparative order.
|
2622
|
+
#
|
2623
|
+
# @!attribute [rw] use_ordering
|
2624
|
+
# The ordering type for a column. Valid values for this structure are
|
2625
|
+
# `GREATER_IS_BETTER`, `LESSER_IS_BETTER` and `SPECIFIED`.
|
2626
|
+
# @return [String]
|
2627
|
+
#
|
2628
|
+
# @!attribute [rw] specifed_order
|
2629
|
+
# The list of columns to be used in the ordering.
|
2630
|
+
# @return [Array<String>]
|
2631
|
+
#
|
2632
|
+
# @!attribute [rw] treat_undefined_specified_values
|
2633
|
+
# The treat of undefined specified values. Valid values for this
|
2634
|
+
# structure are `LEAST` and `MOST`.
|
2635
|
+
# @return [String]
|
2636
|
+
#
|
2637
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ComparativeOrder AWS API Documentation
|
2638
|
+
#
|
2639
|
+
class ComparativeOrder < Struct.new(
|
2640
|
+
:use_ordering,
|
2641
|
+
:specifed_order,
|
2642
|
+
:treat_undefined_specified_values)
|
2643
|
+
SENSITIVE = []
|
2644
|
+
include Aws::Structure
|
2645
|
+
end
|
2646
|
+
|
2573
2647
|
# The comparison display configuration of a KPI or gauge chart.
|
2574
2648
|
#
|
2575
2649
|
# @!attribute [rw] comparison_method
|
@@ -3482,6 +3556,10 @@ module Aws::QuickSight
|
|
3482
3556
|
# this dataset as a source.
|
3483
3557
|
# @return [Types::DataSetUsageConfiguration]
|
3484
3558
|
#
|
3559
|
+
# @!attribute [rw] dataset_parameters
|
3560
|
+
# The parameter declarations of the dataset.
|
3561
|
+
# @return [Array<Types::DatasetParameter>]
|
3562
|
+
#
|
3485
3563
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateDataSetRequest AWS API Documentation
|
3486
3564
|
#
|
3487
3565
|
class CreateDataSetRequest < Struct.new(
|
@@ -3498,7 +3576,8 @@ module Aws::QuickSight
|
|
3498
3576
|
:row_level_permission_tag_configuration,
|
3499
3577
|
:column_level_permission_rules,
|
3500
3578
|
:tags,
|
3501
|
-
:data_set_usage_configuration
|
3579
|
+
:data_set_usage_configuration,
|
3580
|
+
:dataset_parameters)
|
3502
3581
|
SENSITIVE = []
|
3503
3582
|
include Aws::Structure
|
3504
3583
|
end
|
@@ -3881,8 +3960,8 @@ module Aws::QuickSight
|
|
3881
3960
|
# @return [String]
|
3882
3961
|
#
|
3883
3962
|
# @!attribute [rw] assignment_name
|
3884
|
-
# The name of the assignment, also called a rule.
|
3885
|
-
# within
|
3963
|
+
# The name of the assignment, also called a rule. The name must be
|
3964
|
+
# unique within the Amazon Web Services account.
|
3886
3965
|
# @return [String]
|
3887
3966
|
#
|
3888
3967
|
# @!attribute [rw] assignment_status
|
@@ -3926,7 +4005,7 @@ module Aws::QuickSight
|
|
3926
4005
|
end
|
3927
4006
|
|
3928
4007
|
# @!attribute [rw] assignment_name
|
3929
|
-
# The name of the assignment.
|
4008
|
+
# The name of the assignment. The name must be unique within the
|
3930
4009
|
# Amazon Web Services account.
|
3931
4010
|
# @return [String]
|
3932
4011
|
#
|
@@ -4117,6 +4196,55 @@ module Aws::QuickSight
|
|
4117
4196
|
include Aws::Structure
|
4118
4197
|
end
|
4119
4198
|
|
4199
|
+
# @!attribute [rw] data_set_id
|
4200
|
+
# The ID of the dataset.
|
4201
|
+
# @return [String]
|
4202
|
+
#
|
4203
|
+
# @!attribute [rw] aws_account_id
|
4204
|
+
# The Amazon Web Services account ID.
|
4205
|
+
# @return [String]
|
4206
|
+
#
|
4207
|
+
# @!attribute [rw] schedule
|
4208
|
+
# The refresh schedule.
|
4209
|
+
# @return [Types::RefreshSchedule]
|
4210
|
+
#
|
4211
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateRefreshScheduleRequest AWS API Documentation
|
4212
|
+
#
|
4213
|
+
class CreateRefreshScheduleRequest < Struct.new(
|
4214
|
+
:data_set_id,
|
4215
|
+
:aws_account_id,
|
4216
|
+
:schedule)
|
4217
|
+
SENSITIVE = []
|
4218
|
+
include Aws::Structure
|
4219
|
+
end
|
4220
|
+
|
4221
|
+
# @!attribute [rw] status
|
4222
|
+
# The HTTP status of the request.
|
4223
|
+
# @return [Integer]
|
4224
|
+
#
|
4225
|
+
# @!attribute [rw] request_id
|
4226
|
+
# The Amazon Web Services request ID for this operation.
|
4227
|
+
# @return [String]
|
4228
|
+
#
|
4229
|
+
# @!attribute [rw] schedule_id
|
4230
|
+
# The ID of the refresh schedule.
|
4231
|
+
# @return [String]
|
4232
|
+
#
|
4233
|
+
# @!attribute [rw] arn
|
4234
|
+
# The Amazon Resource Name (ARN) for the refresh schedule.
|
4235
|
+
# @return [String]
|
4236
|
+
#
|
4237
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateRefreshScheduleResponse AWS API Documentation
|
4238
|
+
#
|
4239
|
+
class CreateRefreshScheduleResponse < Struct.new(
|
4240
|
+
:status,
|
4241
|
+
:request_id,
|
4242
|
+
:schedule_id,
|
4243
|
+
:arn)
|
4244
|
+
SENSITIVE = []
|
4245
|
+
include Aws::Structure
|
4246
|
+
end
|
4247
|
+
|
4120
4248
|
# @!attribute [rw] aws_account_id
|
4121
4249
|
# The ID of the Amazon Web Services account that contains the template
|
4122
4250
|
# that you creating an alias for.
|
@@ -4430,6 +4558,227 @@ module Aws::QuickSight
|
|
4430
4558
|
include Aws::Structure
|
4431
4559
|
end
|
4432
4560
|
|
4561
|
+
# @!attribute [rw] aws_account_id
|
4562
|
+
# The ID of the Amazon Web Services account that contains the topic
|
4563
|
+
# you're creating a refresh schedule for.
|
4564
|
+
# @return [String]
|
4565
|
+
#
|
4566
|
+
# @!attribute [rw] topic_id
|
4567
|
+
# The ID of the topic that you want to modify. This ID is unique per
|
4568
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
4569
|
+
# @return [String]
|
4570
|
+
#
|
4571
|
+
# @!attribute [rw] dataset_arn
|
4572
|
+
# The Amazon Resource Name (ARN) of the dataset.
|
4573
|
+
# @return [String]
|
4574
|
+
#
|
4575
|
+
# @!attribute [rw] dataset_name
|
4576
|
+
# The name of the dataset.
|
4577
|
+
# @return [String]
|
4578
|
+
#
|
4579
|
+
# @!attribute [rw] refresh_schedule
|
4580
|
+
# The definition of a refresh schedule.
|
4581
|
+
# @return [Types::TopicRefreshSchedule]
|
4582
|
+
#
|
4583
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateTopicRefreshScheduleRequest AWS API Documentation
|
4584
|
+
#
|
4585
|
+
class CreateTopicRefreshScheduleRequest < Struct.new(
|
4586
|
+
:aws_account_id,
|
4587
|
+
:topic_id,
|
4588
|
+
:dataset_arn,
|
4589
|
+
:dataset_name,
|
4590
|
+
:refresh_schedule)
|
4591
|
+
SENSITIVE = []
|
4592
|
+
include Aws::Structure
|
4593
|
+
end
|
4594
|
+
|
4595
|
+
# @!attribute [rw] topic_id
|
4596
|
+
# The ID of the topic that you want to modify. This ID is unique per
|
4597
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
4598
|
+
# @return [String]
|
4599
|
+
#
|
4600
|
+
# @!attribute [rw] topic_arn
|
4601
|
+
# The Amazon Resource Name (ARN) of the topic.
|
4602
|
+
# @return [String]
|
4603
|
+
#
|
4604
|
+
# @!attribute [rw] dataset_arn
|
4605
|
+
# The Amazon Resource Name (ARN) of the dataset.
|
4606
|
+
# @return [String]
|
4607
|
+
#
|
4608
|
+
# @!attribute [rw] status
|
4609
|
+
# The HTTP status of the request.
|
4610
|
+
# @return [Integer]
|
4611
|
+
#
|
4612
|
+
# @!attribute [rw] request_id
|
4613
|
+
# The Amazon Web Services request ID for this operation.
|
4614
|
+
# @return [String]
|
4615
|
+
#
|
4616
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateTopicRefreshScheduleResponse AWS API Documentation
|
4617
|
+
#
|
4618
|
+
class CreateTopicRefreshScheduleResponse < Struct.new(
|
4619
|
+
:topic_id,
|
4620
|
+
:topic_arn,
|
4621
|
+
:dataset_arn,
|
4622
|
+
:status,
|
4623
|
+
:request_id)
|
4624
|
+
SENSITIVE = []
|
4625
|
+
include Aws::Structure
|
4626
|
+
end
|
4627
|
+
|
4628
|
+
# @!attribute [rw] aws_account_id
|
4629
|
+
# The ID of the Amazon Web Services account that you want to create a
|
4630
|
+
# topic in.
|
4631
|
+
# @return [String]
|
4632
|
+
#
|
4633
|
+
# @!attribute [rw] topic_id
|
4634
|
+
# The ID for the topic that you want to create. This ID is unique per
|
4635
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
4636
|
+
# @return [String]
|
4637
|
+
#
|
4638
|
+
# @!attribute [rw] topic
|
4639
|
+
# The definition of a topic to create.
|
4640
|
+
# @return [Types::TopicDetails]
|
4641
|
+
#
|
4642
|
+
# @!attribute [rw] tags
|
4643
|
+
# Contains a map of the key-value pairs for the resource tag or tags
|
4644
|
+
# that are assigned to the dataset.
|
4645
|
+
# @return [Array<Types::Tag>]
|
4646
|
+
#
|
4647
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateTopicRequest AWS API Documentation
|
4648
|
+
#
|
4649
|
+
class CreateTopicRequest < Struct.new(
|
4650
|
+
:aws_account_id,
|
4651
|
+
:topic_id,
|
4652
|
+
:topic,
|
4653
|
+
:tags)
|
4654
|
+
SENSITIVE = []
|
4655
|
+
include Aws::Structure
|
4656
|
+
end
|
4657
|
+
|
4658
|
+
# @!attribute [rw] arn
|
4659
|
+
# The Amazon Resource Name (ARN) of the topic.
|
4660
|
+
# @return [String]
|
4661
|
+
#
|
4662
|
+
# @!attribute [rw] topic_id
|
4663
|
+
# The ID for the topic that you want to create. This ID is unique per
|
4664
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
4665
|
+
# @return [String]
|
4666
|
+
#
|
4667
|
+
# @!attribute [rw] refresh_arn
|
4668
|
+
# The Amazon Resource Name (ARN) of the topic refresh.
|
4669
|
+
# @return [String]
|
4670
|
+
#
|
4671
|
+
# @!attribute [rw] request_id
|
4672
|
+
# The Amazon Web Services request ID for this operation.
|
4673
|
+
# @return [String]
|
4674
|
+
#
|
4675
|
+
# @!attribute [rw] status
|
4676
|
+
# The HTTP status of the request.
|
4677
|
+
# @return [Integer]
|
4678
|
+
#
|
4679
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateTopicResponse AWS API Documentation
|
4680
|
+
#
|
4681
|
+
class CreateTopicResponse < Struct.new(
|
4682
|
+
:arn,
|
4683
|
+
:topic_id,
|
4684
|
+
:refresh_arn,
|
4685
|
+
:request_id,
|
4686
|
+
:status)
|
4687
|
+
SENSITIVE = []
|
4688
|
+
include Aws::Structure
|
4689
|
+
end
|
4690
|
+
|
4691
|
+
# @!attribute [rw] aws_account_id
|
4692
|
+
# The Amazon Web Services account ID of the account where you want to
|
4693
|
+
# create a new VPC connection.
|
4694
|
+
# @return [String]
|
4695
|
+
#
|
4696
|
+
# @!attribute [rw] vpc_connection_id
|
4697
|
+
# The ID of the VPC connection that you're creating. This ID is a
|
4698
|
+
# unique identifier for each Amazon Web Services Region in an Amazon
|
4699
|
+
# Web Services account.
|
4700
|
+
# @return [String]
|
4701
|
+
#
|
4702
|
+
# @!attribute [rw] name
|
4703
|
+
# The display name for the VPC connection.
|
4704
|
+
# @return [String]
|
4705
|
+
#
|
4706
|
+
# @!attribute [rw] subnet_ids
|
4707
|
+
# A list of subnet IDs for the VPC connection.
|
4708
|
+
# @return [Array<String>]
|
4709
|
+
#
|
4710
|
+
# @!attribute [rw] security_group_ids
|
4711
|
+
# A list of security group IDs for the VPC connection.
|
4712
|
+
# @return [Array<String>]
|
4713
|
+
#
|
4714
|
+
# @!attribute [rw] dns_resolvers
|
4715
|
+
# A list of IP addresses of DNS resolver endpoints for the VPC
|
4716
|
+
# connection.
|
4717
|
+
# @return [Array<String>]
|
4718
|
+
#
|
4719
|
+
# @!attribute [rw] role_arn
|
4720
|
+
# The IAM role to associate with the VPC connection.
|
4721
|
+
# @return [String]
|
4722
|
+
#
|
4723
|
+
# @!attribute [rw] tags
|
4724
|
+
# A map of the key-value pairs for the resource tag or tags assigned
|
4725
|
+
# to the VPC connection.
|
4726
|
+
# @return [Array<Types::Tag>]
|
4727
|
+
#
|
4728
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateVPCConnectionRequest AWS API Documentation
|
4729
|
+
#
|
4730
|
+
class CreateVPCConnectionRequest < Struct.new(
|
4731
|
+
:aws_account_id,
|
4732
|
+
:vpc_connection_id,
|
4733
|
+
:name,
|
4734
|
+
:subnet_ids,
|
4735
|
+
:security_group_ids,
|
4736
|
+
:dns_resolvers,
|
4737
|
+
:role_arn,
|
4738
|
+
:tags)
|
4739
|
+
SENSITIVE = []
|
4740
|
+
include Aws::Structure
|
4741
|
+
end
|
4742
|
+
|
4743
|
+
# @!attribute [rw] arn
|
4744
|
+
# The Amazon Resource Name (ARN) of the VPC connection.
|
4745
|
+
# @return [String]
|
4746
|
+
#
|
4747
|
+
# @!attribute [rw] vpc_connection_id
|
4748
|
+
# The ID for the VPC connection that you're creating. This ID is
|
4749
|
+
# unique per Amazon Web Services Region for each Amazon Web Services
|
4750
|
+
# account.
|
4751
|
+
# @return [String]
|
4752
|
+
#
|
4753
|
+
# @!attribute [rw] creation_status
|
4754
|
+
# The status of the creation of the VPC connection.
|
4755
|
+
# @return [String]
|
4756
|
+
#
|
4757
|
+
# @!attribute [rw] availability_status
|
4758
|
+
# The availability status of the VPC connection.
|
4759
|
+
# @return [String]
|
4760
|
+
#
|
4761
|
+
# @!attribute [rw] request_id
|
4762
|
+
# The Amazon Web Services request ID for this operation.
|
4763
|
+
# @return [String]
|
4764
|
+
#
|
4765
|
+
# @!attribute [rw] status
|
4766
|
+
# The HTTP status of the request.
|
4767
|
+
# @return [Integer]
|
4768
|
+
#
|
4769
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateVPCConnectionResponse AWS API Documentation
|
4770
|
+
#
|
4771
|
+
class CreateVPCConnectionResponse < Struct.new(
|
4772
|
+
:arn,
|
4773
|
+
:vpc_connection_id,
|
4774
|
+
:creation_status,
|
4775
|
+
:availability_status,
|
4776
|
+
:request_id,
|
4777
|
+
:status)
|
4778
|
+
SENSITIVE = []
|
4779
|
+
include Aws::Structure
|
4780
|
+
end
|
4781
|
+
|
4433
4782
|
# The combination of user name and password that are used as
|
4434
4783
|
# credentials.
|
4435
4784
|
#
|
@@ -4577,11 +4926,11 @@ module Aws::QuickSight
|
|
4577
4926
|
#
|
4578
4927
|
# Valid values are defined as follows:
|
4579
4928
|
#
|
4580
|
-
# * `NEW_TAB
|
4929
|
+
# * `NEW_TAB`: Opens the target URL in a new browser tab.
|
4581
4930
|
#
|
4582
|
-
# * `NEW_WINDOW
|
4931
|
+
# * `NEW_WINDOW`: Opens the target URL in a new browser window.
|
4583
4932
|
#
|
4584
|
-
# * `SAME_TAB
|
4933
|
+
# * `SAME_TAB`: Opens the target URL in the same browser tab.
|
4585
4934
|
# @return [String]
|
4586
4935
|
#
|
4587
4936
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CustomActionURLOperation AWS API Documentation
|
@@ -4704,11 +5053,11 @@ module Aws::QuickSight
|
|
4704
5053
|
# This option determines how null values should be treated when
|
4705
5054
|
# filtering data.
|
4706
5055
|
#
|
4707
|
-
# * `ALL_VALUES
|
5056
|
+
# * `ALL_VALUES`: Include null values in filtered results.
|
4708
5057
|
#
|
4709
|
-
# * `NULLS_ONLY
|
5058
|
+
# * `NULLS_ONLY`: Only include null values in filtered results.
|
4710
5059
|
#
|
4711
|
-
# * `NON_NULLS_ONLY
|
5060
|
+
# * `NON_NULLS_ONLY`: Exclude null values from filtered results.
|
4712
5061
|
# @return [String]
|
4713
5062
|
#
|
4714
5063
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CustomFilterConfiguration AWS API Documentation
|
@@ -4747,11 +5096,11 @@ module Aws::QuickSight
|
|
4747
5096
|
# This option determines how null values should be treated when
|
4748
5097
|
# filtering data.
|
4749
5098
|
#
|
4750
|
-
# * `ALL_VALUES
|
5099
|
+
# * `ALL_VALUES`: Include null values in filtered results.
|
4751
5100
|
#
|
4752
|
-
# * `NULLS_ONLY
|
5101
|
+
# * `NULLS_ONLY`: Only include null values in filtered results.
|
4753
5102
|
#
|
4754
|
-
# * `NON_NULLS_ONLY
|
5103
|
+
# * `NON_NULLS_ONLY`: Exclude null values from filtered results.
|
4755
5104
|
# @return [String]
|
4756
5105
|
#
|
4757
5106
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CustomFilterListConfiguration AWS API Documentation
|
@@ -5022,32 +5371,32 @@ module Aws::QuickSight
|
|
5022
5371
|
#
|
5023
5372
|
# Valid values are defined as follows:
|
5024
5373
|
#
|
5025
|
-
# * `QUICKSIGHT_VIEWER_OR_OWNER
|
5374
|
+
# * `QUICKSIGHT_VIEWER_OR_OWNER`: Provide an ARN of a user or group,
|
5026
5375
|
# and any dashboards with that ARN listed as one of the
|
5027
5376
|
# dashboards's owners or viewers are returned. Implicit permissions
|
5028
5377
|
# from folders or groups are considered.
|
5029
5378
|
#
|
5030
|
-
# * `QUICKSIGHT_OWNER
|
5379
|
+
# * `QUICKSIGHT_OWNER`: Provide an ARN of a user or group, and any
|
5031
5380
|
# dashboards with that ARN listed as one of the owners of the
|
5032
5381
|
# dashboards are returned. Implicit permissions from folders or
|
5033
5382
|
# groups are considered.
|
5034
5383
|
#
|
5035
|
-
# * `DIRECT_QUICKSIGHT_SOLE_OWNER
|
5036
|
-
#
|
5037
|
-
#
|
5038
|
-
#
|
5384
|
+
# * `DIRECT_QUICKSIGHT_SOLE_OWNER`: Provide an ARN of a user or group,
|
5385
|
+
# and any dashboards with that ARN listed as the only owner of the
|
5386
|
+
# dashboard are returned. Implicit permissions from folders or
|
5387
|
+
# groups are not considered.
|
5039
5388
|
#
|
5040
|
-
# * `DIRECT_QUICKSIGHT_OWNER
|
5389
|
+
# * `DIRECT_QUICKSIGHT_OWNER`: Provide an ARN of a user or group, and
|
5041
5390
|
# any dashboards with that ARN listed as one of the owners of the
|
5042
5391
|
# dashboards are returned. Implicit permissions from folders or
|
5043
5392
|
# groups are not considered.
|
5044
5393
|
#
|
5045
|
-
# * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER
|
5394
|
+
# * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER`: Provide an ARN of a user or
|
5046
5395
|
# group, and any dashboards with that ARN listed as one of the
|
5047
5396
|
# owners or viewers of the dashboards are returned. Implicit
|
5048
5397
|
# permissions from folders or groups are not considered.
|
5049
5398
|
#
|
5050
|
-
# * `DASHBOARD_NAME
|
5399
|
+
# * `DASHBOARD_NAME`: Any dashboards whose names have a substring
|
5051
5400
|
# match to this value will be returned.
|
5052
5401
|
# @return [String]
|
5053
5402
|
#
|
@@ -5368,6 +5717,26 @@ module Aws::QuickSight
|
|
5368
5717
|
include Aws::Structure
|
5369
5718
|
end
|
5370
5719
|
|
5720
|
+
# A structure that represents a data aggregation.
|
5721
|
+
#
|
5722
|
+
# @!attribute [rw] dataset_row_date_granularity
|
5723
|
+
# The level of time precision that is used to aggregate `DateTime`
|
5724
|
+
# values.
|
5725
|
+
# @return [String]
|
5726
|
+
#
|
5727
|
+
# @!attribute [rw] default_date_column_name
|
5728
|
+
# The column name for the default date.
|
5729
|
+
# @return [String]
|
5730
|
+
#
|
5731
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataAggregation AWS API Documentation
|
5732
|
+
#
|
5733
|
+
class DataAggregation < Struct.new(
|
5734
|
+
:dataset_row_date_granularity,
|
5735
|
+
:default_date_column_name)
|
5736
|
+
SENSITIVE = []
|
5737
|
+
include Aws::Structure
|
5738
|
+
end
|
5739
|
+
|
5371
5740
|
# The options for data bars.
|
5372
5741
|
#
|
5373
5742
|
# @!attribute [rw] field_id
|
@@ -5509,6 +5878,10 @@ module Aws::QuickSight
|
|
5509
5878
|
# labels.
|
5510
5879
|
# @return [String]
|
5511
5880
|
#
|
5881
|
+
# @!attribute [rw] totals_visibility
|
5882
|
+
# Determines the visibility of the total.
|
5883
|
+
# @return [String]
|
5884
|
+
#
|
5512
5885
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataLabelOptions AWS API Documentation
|
5513
5886
|
#
|
5514
5887
|
class DataLabelOptions < Struct.new(
|
@@ -5520,7 +5893,8 @@ module Aws::QuickSight
|
|
5520
5893
|
:label_content,
|
5521
5894
|
:label_font_configuration,
|
5522
5895
|
:label_color,
|
5523
|
-
:overlap
|
5896
|
+
:overlap,
|
5897
|
+
:totals_visibility)
|
5524
5898
|
SENSITIVE = []
|
5525
5899
|
include Aws::Structure
|
5526
5900
|
end
|
@@ -5769,6 +6143,10 @@ module Aws::QuickSight
|
|
5769
6143
|
# this dataset as a source.
|
5770
6144
|
# @return [Types::DataSetUsageConfiguration]
|
5771
6145
|
#
|
6146
|
+
# @!attribute [rw] dataset_parameters
|
6147
|
+
# The parameters that are declared in a dataset.
|
6148
|
+
# @return [Array<Types::DatasetParameter>]
|
6149
|
+
#
|
5772
6150
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSet AWS API Documentation
|
5773
6151
|
#
|
5774
6152
|
class DataSet < Struct.new(
|
@@ -5787,7 +6165,8 @@ module Aws::QuickSight
|
|
5787
6165
|
:row_level_permission_data_set,
|
5788
6166
|
:row_level_permission_tag_configuration,
|
5789
6167
|
:column_level_permission_rules,
|
5790
|
-
:data_set_usage_configuration
|
6168
|
+
:data_set_usage_configuration,
|
6169
|
+
:dataset_parameters)
|
5791
6170
|
SENSITIVE = []
|
5792
6171
|
include Aws::Structure
|
5793
6172
|
end
|
@@ -5854,6 +6233,20 @@ module Aws::QuickSight
|
|
5854
6233
|
include Aws::Structure
|
5855
6234
|
end
|
5856
6235
|
|
6236
|
+
# The refresh properties of a dataset.
|
6237
|
+
#
|
6238
|
+
# @!attribute [rw] refresh_configuration
|
6239
|
+
# The refresh configuration for a dataset.
|
6240
|
+
# @return [Types::RefreshConfiguration]
|
6241
|
+
#
|
6242
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetRefreshProperties AWS API Documentation
|
6243
|
+
#
|
6244
|
+
class DataSetRefreshProperties < Struct.new(
|
6245
|
+
:refresh_configuration)
|
6246
|
+
SENSITIVE = []
|
6247
|
+
include Aws::Structure
|
6248
|
+
end
|
6249
|
+
|
5857
6250
|
# Dataset schema.
|
5858
6251
|
#
|
5859
6252
|
# @!attribute [rw] column_schema_list
|
@@ -5895,33 +6288,33 @@ module Aws::QuickSight
|
|
5895
6288
|
#
|
5896
6289
|
# Valid values are defined as follows:
|
5897
6290
|
#
|
5898
|
-
# * `QUICKSIGHT_VIEWER_OR_OWNER
|
6291
|
+
# * `QUICKSIGHT_VIEWER_OR_OWNER`: Provide an ARN of a user or group,
|
5899
6292
|
# and any datasets with that ARN listed as one of the dataset owners
|
5900
6293
|
# or viewers are returned. Implicit permissions from folders or
|
5901
6294
|
# groups are considered.
|
5902
6295
|
#
|
5903
|
-
# * `QUICKSIGHT_OWNER
|
6296
|
+
# * `QUICKSIGHT_OWNER`: Provide an ARN of a user or group, and any
|
5904
6297
|
# datasets with that ARN listed as one of the owners of the dataset
|
5905
6298
|
# are returned. Implicit permissions from folders or groups are
|
5906
6299
|
# considered.
|
5907
6300
|
#
|
5908
|
-
# * `DIRECT_QUICKSIGHT_SOLE_OWNER
|
5909
|
-
#
|
5910
|
-
#
|
5911
|
-
#
|
6301
|
+
# * `DIRECT_QUICKSIGHT_SOLE_OWNER`: Provide an ARN of a user or group,
|
6302
|
+
# and any datasets with that ARN listed as the only owner of the
|
6303
|
+
# dataset are returned. Implicit permissions from folders or groups
|
6304
|
+
# are not considered.
|
5912
6305
|
#
|
5913
|
-
# * `DIRECT_QUICKSIGHT_OWNER
|
6306
|
+
# * `DIRECT_QUICKSIGHT_OWNER`: Provide an ARN of a user or group, and
|
5914
6307
|
# any datasets with that ARN listed as one of the owners if the
|
5915
6308
|
# dataset are returned. Implicit permissions from folders or groups
|
5916
6309
|
# are not considered.
|
5917
6310
|
#
|
5918
|
-
# * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER
|
6311
|
+
# * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER`: Provide an ARN of a user or
|
5919
6312
|
# group, and any datasets with that ARN listed as one of the owners
|
5920
6313
|
# or viewers of the dataset are returned. Implicit permissions from
|
5921
6314
|
# folders or groups are not considered.
|
5922
6315
|
#
|
5923
|
-
# * `DATASET_NAME
|
5924
|
-
#
|
6316
|
+
# * `DATASET_NAME`: Any datasets whose names have a substring match to
|
6317
|
+
# this value will be returned.
|
5925
6318
|
# @return [String]
|
5926
6319
|
#
|
5927
6320
|
# @!attribute [rw] value
|
@@ -6313,22 +6706,22 @@ module Aws::QuickSight
|
|
6313
6706
|
#
|
6314
6707
|
# Valid values are defined as follows:
|
6315
6708
|
#
|
6316
|
-
# * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER
|
6709
|
+
# * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER`: Provide an ARN of a user or
|
6317
6710
|
# group, and any data sources with that ARN listed as one of the
|
6318
6711
|
# owners or viewers of the data sources are returned. Implicit
|
6319
6712
|
# permissions from folders or groups are not considered.
|
6320
6713
|
#
|
6321
|
-
# * `DIRECT_QUICKSIGHT_OWNER
|
6714
|
+
# * `DIRECT_QUICKSIGHT_OWNER`: Provide an ARN of a user or group, and
|
6322
6715
|
# any data sources with that ARN listed as one of the owners if the
|
6323
6716
|
# data source are returned. Implicit permissions from folders or
|
6324
6717
|
# groups are not considered.
|
6325
6718
|
#
|
6326
|
-
# * `DIRECT_QUICKSIGHT_SOLE_OWNER
|
6327
|
-
#
|
6328
|
-
#
|
6329
|
-
#
|
6719
|
+
# * `DIRECT_QUICKSIGHT_SOLE_OWNER`: Provide an ARN of a user or group,
|
6720
|
+
# and any data sources with that ARN listed as the only owner of the
|
6721
|
+
# data source are returned. Implicit permissions from folders or
|
6722
|
+
# groups are not considered.
|
6330
6723
|
#
|
6331
|
-
# * `DATASOURCE_NAME
|
6724
|
+
# * `DATASOURCE_NAME`: Any data sources whose names have a substring
|
6332
6725
|
# match to the provided value are returned.
|
6333
6726
|
# @return [String]
|
6334
6727
|
#
|
@@ -6414,13 +6807,91 @@ module Aws::QuickSight
|
|
6414
6807
|
include Aws::Structure
|
6415
6808
|
end
|
6416
6809
|
|
6417
|
-
#
|
6810
|
+
# A structure that represents a dataset.
|
6418
6811
|
#
|
6419
|
-
# @!attribute [rw]
|
6420
|
-
#
|
6812
|
+
# @!attribute [rw] dataset_arn
|
6813
|
+
# The Amazon Resource Name (ARN) of the dataset.
|
6421
6814
|
# @return [String]
|
6422
6815
|
#
|
6423
|
-
#
|
6816
|
+
# @!attribute [rw] dataset_name
|
6817
|
+
# The name of the dataset.
|
6818
|
+
# @return [String]
|
6819
|
+
#
|
6820
|
+
# @!attribute [rw] dataset_description
|
6821
|
+
# The description of the dataset.
|
6822
|
+
# @return [String]
|
6823
|
+
#
|
6824
|
+
# @!attribute [rw] data_aggregation
|
6825
|
+
# The definition of a data aggregation.
|
6826
|
+
# @return [Types::DataAggregation]
|
6827
|
+
#
|
6828
|
+
# @!attribute [rw] filters
|
6829
|
+
# The list of filter definitions.
|
6830
|
+
# @return [Array<Types::TopicFilter>]
|
6831
|
+
#
|
6832
|
+
# @!attribute [rw] columns
|
6833
|
+
# The list of column definitions.
|
6834
|
+
# @return [Array<Types::TopicColumn>]
|
6835
|
+
#
|
6836
|
+
# @!attribute [rw] calculated_fields
|
6837
|
+
# The list of calculated field definitions.
|
6838
|
+
# @return [Array<Types::TopicCalculatedField>]
|
6839
|
+
#
|
6840
|
+
# @!attribute [rw] named_entities
|
6841
|
+
# The list of named entities definitions.
|
6842
|
+
# @return [Array<Types::TopicNamedEntity>]
|
6843
|
+
#
|
6844
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DatasetMetadata AWS API Documentation
|
6845
|
+
#
|
6846
|
+
class DatasetMetadata < Struct.new(
|
6847
|
+
:dataset_arn,
|
6848
|
+
:dataset_name,
|
6849
|
+
:dataset_description,
|
6850
|
+
:data_aggregation,
|
6851
|
+
:filters,
|
6852
|
+
:columns,
|
6853
|
+
:calculated_fields,
|
6854
|
+
:named_entities)
|
6855
|
+
SENSITIVE = []
|
6856
|
+
include Aws::Structure
|
6857
|
+
end
|
6858
|
+
|
6859
|
+
# A dataset parameter.
|
6860
|
+
#
|
6861
|
+
# @!attribute [rw] string_dataset_parameter
|
6862
|
+
# A string parameter that is created in the dataset.
|
6863
|
+
# @return [Types::StringDatasetParameter]
|
6864
|
+
#
|
6865
|
+
# @!attribute [rw] decimal_dataset_parameter
|
6866
|
+
# A decimal parameter that is created in the dataset.
|
6867
|
+
# @return [Types::DecimalDatasetParameter]
|
6868
|
+
#
|
6869
|
+
# @!attribute [rw] integer_dataset_parameter
|
6870
|
+
# An integer parameter that is created in the dataset.
|
6871
|
+
# @return [Types::IntegerDatasetParameter]
|
6872
|
+
#
|
6873
|
+
# @!attribute [rw] date_time_dataset_parameter
|
6874
|
+
# A date time parameter that is created in the dataset.
|
6875
|
+
# @return [Types::DateTimeDatasetParameter]
|
6876
|
+
#
|
6877
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DatasetParameter AWS API Documentation
|
6878
|
+
#
|
6879
|
+
class DatasetParameter < Struct.new(
|
6880
|
+
:string_dataset_parameter,
|
6881
|
+
:decimal_dataset_parameter,
|
6882
|
+
:integer_dataset_parameter,
|
6883
|
+
:date_time_dataset_parameter)
|
6884
|
+
SENSITIVE = []
|
6885
|
+
include Aws::Structure
|
6886
|
+
end
|
6887
|
+
|
6888
|
+
# The options that determine how a date axis is displayed.
|
6889
|
+
#
|
6890
|
+
# @!attribute [rw] missing_date_visibility
|
6891
|
+
# Determines whether or not missing dates are displayed.
|
6892
|
+
# @return [String]
|
6893
|
+
#
|
6894
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DateAxisOptions AWS API Documentation
|
6424
6895
|
#
|
6425
6896
|
class DateAxisOptions < Struct.new(
|
6426
6897
|
:missing_date_visibility)
|
@@ -6510,6 +6981,56 @@ module Aws::QuickSight
|
|
6510
6981
|
include Aws::Structure
|
6511
6982
|
end
|
6512
6983
|
|
6984
|
+
# A date time parameter for a dataset.
|
6985
|
+
#
|
6986
|
+
# @!attribute [rw] id
|
6987
|
+
# An identifier for the parameter that is created in the dataset.
|
6988
|
+
# @return [String]
|
6989
|
+
#
|
6990
|
+
# @!attribute [rw] name
|
6991
|
+
# The name of the date time parameter that is created in the dataset.
|
6992
|
+
# @return [String]
|
6993
|
+
#
|
6994
|
+
# @!attribute [rw] value_type
|
6995
|
+
# The value type of the dataset parameter. Valid values are `single
|
6996
|
+
# value` or `multi value`.
|
6997
|
+
# @return [String]
|
6998
|
+
#
|
6999
|
+
# @!attribute [rw] time_granularity
|
7000
|
+
# The time granularity of the date time parameter.
|
7001
|
+
# @return [String]
|
7002
|
+
#
|
7003
|
+
# @!attribute [rw] default_values
|
7004
|
+
# A list of default values for a given date time parameter. This
|
7005
|
+
# structure only accepts static values.
|
7006
|
+
# @return [Types::DateTimeDatasetParameterDefaultValues]
|
7007
|
+
#
|
7008
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DateTimeDatasetParameter AWS API Documentation
|
7009
|
+
#
|
7010
|
+
class DateTimeDatasetParameter < Struct.new(
|
7011
|
+
:id,
|
7012
|
+
:name,
|
7013
|
+
:value_type,
|
7014
|
+
:time_granularity,
|
7015
|
+
:default_values)
|
7016
|
+
SENSITIVE = []
|
7017
|
+
include Aws::Structure
|
7018
|
+
end
|
7019
|
+
|
7020
|
+
# The default values of a date time parameter.
|
7021
|
+
#
|
7022
|
+
# @!attribute [rw] static_values
|
7023
|
+
# A list of static default values for a given date time parameter.
|
7024
|
+
# @return [Array<Time>]
|
7025
|
+
#
|
7026
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DateTimeDatasetParameterDefaultValues AWS API Documentation
|
7027
|
+
#
|
7028
|
+
class DateTimeDatasetParameterDefaultValues < Struct.new(
|
7029
|
+
:static_values)
|
7030
|
+
SENSITIVE = []
|
7031
|
+
include Aws::Structure
|
7032
|
+
end
|
7033
|
+
|
6513
7034
|
# The default values of the `DateTimeParameterDeclaration`.
|
6514
7035
|
#
|
6515
7036
|
# @!attribute [rw] dynamic_value
|
@@ -6621,13 +7142,19 @@ module Aws::QuickSight
|
|
6621
7142
|
# parameter when a value has not been set.
|
6622
7143
|
# @return [Types::DateTimeValueWhenUnsetConfiguration]
|
6623
7144
|
#
|
7145
|
+
# @!attribute [rw] mapped_data_set_parameters
|
7146
|
+
# A list of dataset parameters that are mapped to an analysis
|
7147
|
+
# parameter.
|
7148
|
+
# @return [Array<Types::MappedDataSetParameter>]
|
7149
|
+
#
|
6624
7150
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DateTimeParameterDeclaration AWS API Documentation
|
6625
7151
|
#
|
6626
7152
|
class DateTimeParameterDeclaration < Struct.new(
|
6627
7153
|
:name,
|
6628
7154
|
:default_values,
|
6629
7155
|
:time_granularity,
|
6630
|
-
:value_when_unset
|
7156
|
+
:value_when_unset,
|
7157
|
+
:mapped_data_set_parameters)
|
6631
7158
|
SENSITIVE = []
|
6632
7159
|
include Aws::Structure
|
6633
7160
|
end
|
@@ -6658,9 +7185,9 @@ module Aws::QuickSight
|
|
6658
7185
|
# The built-in options for default values. The value can be one of the
|
6659
7186
|
# following:
|
6660
7187
|
#
|
6661
|
-
# * `RECOMMENDED
|
7188
|
+
# * `RECOMMENDED`: The recommended value.
|
6662
7189
|
#
|
6663
|
-
# * `NULL
|
7190
|
+
# * `NULL`: The `NULL` value.
|
6664
7191
|
# @return [String]
|
6665
7192
|
#
|
6666
7193
|
# @!attribute [rw] custom_value
|
@@ -6677,6 +7204,51 @@ module Aws::QuickSight
|
|
6677
7204
|
include Aws::Structure
|
6678
7205
|
end
|
6679
7206
|
|
7207
|
+
# A decimal parameter for a dataset.
|
7208
|
+
#
|
7209
|
+
# @!attribute [rw] id
|
7210
|
+
# An identifier for the decimal parameter created in the dataset.
|
7211
|
+
# @return [String]
|
7212
|
+
#
|
7213
|
+
# @!attribute [rw] name
|
7214
|
+
# The name of the decimal parameter that is created in the dataset.
|
7215
|
+
# @return [String]
|
7216
|
+
#
|
7217
|
+
# @!attribute [rw] value_type
|
7218
|
+
# The value type of the dataset parameter. Valid values are `single
|
7219
|
+
# value` or `multi value`.
|
7220
|
+
# @return [String]
|
7221
|
+
#
|
7222
|
+
# @!attribute [rw] default_values
|
7223
|
+
# A list of default values for a given decimal parameter. This
|
7224
|
+
# structure only accepts static values.
|
7225
|
+
# @return [Types::DecimalDatasetParameterDefaultValues]
|
7226
|
+
#
|
7227
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DecimalDatasetParameter AWS API Documentation
|
7228
|
+
#
|
7229
|
+
class DecimalDatasetParameter < Struct.new(
|
7230
|
+
:id,
|
7231
|
+
:name,
|
7232
|
+
:value_type,
|
7233
|
+
:default_values)
|
7234
|
+
SENSITIVE = []
|
7235
|
+
include Aws::Structure
|
7236
|
+
end
|
7237
|
+
|
7238
|
+
# The default values of a decimal parameter.
|
7239
|
+
#
|
7240
|
+
# @!attribute [rw] static_values
|
7241
|
+
# A list of static default values for a given decimal parameter.
|
7242
|
+
# @return [Array<Float>]
|
7243
|
+
#
|
7244
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DecimalDatasetParameterDefaultValues AWS API Documentation
|
7245
|
+
#
|
7246
|
+
class DecimalDatasetParameterDefaultValues < Struct.new(
|
7247
|
+
:static_values)
|
7248
|
+
SENSITIVE = []
|
7249
|
+
include Aws::Structure
|
7250
|
+
end
|
7251
|
+
|
6680
7252
|
# The default values of the `DecimalParameterDeclaration`.
|
6681
7253
|
#
|
6682
7254
|
# @!attribute [rw] dynamic_value
|
@@ -6738,13 +7310,19 @@ module Aws::QuickSight
|
|
6738
7310
|
# parameter when a value has not been set.
|
6739
7311
|
# @return [Types::DecimalValueWhenUnsetConfiguration]
|
6740
7312
|
#
|
7313
|
+
# @!attribute [rw] mapped_data_set_parameters
|
7314
|
+
# A list of dataset parameters that are mapped to an analysis
|
7315
|
+
# parameter.
|
7316
|
+
# @return [Array<Types::MappedDataSetParameter>]
|
7317
|
+
#
|
6741
7318
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DecimalParameterDeclaration AWS API Documentation
|
6742
7319
|
#
|
6743
7320
|
class DecimalParameterDeclaration < Struct.new(
|
6744
7321
|
:parameter_value_type,
|
6745
7322
|
:name,
|
6746
7323
|
:default_values,
|
6747
|
-
:value_when_unset
|
7324
|
+
:value_when_unset,
|
7325
|
+
:mapped_data_set_parameters)
|
6748
7326
|
SENSITIVE = []
|
6749
7327
|
include Aws::Structure
|
6750
7328
|
end
|
@@ -6770,9 +7348,9 @@ module Aws::QuickSight
|
|
6770
7348
|
# The built-in options for default values. The value can be one of the
|
6771
7349
|
# following:
|
6772
7350
|
#
|
6773
|
-
# * `RECOMMENDED
|
7351
|
+
# * `RECOMMENDED`: The recommended value.
|
6774
7352
|
#
|
6775
|
-
# * `NULL
|
7353
|
+
# * `NULL`: The `NULL` value.
|
6776
7354
|
# @return [String]
|
6777
7355
|
#
|
6778
7356
|
# @!attribute [rw] custom_value
|
@@ -6789,6 +7367,26 @@ module Aws::QuickSight
|
|
6789
7367
|
include Aws::Structure
|
6790
7368
|
end
|
6791
7369
|
|
7370
|
+
# A structure that represents a default formatting definition.
|
7371
|
+
#
|
7372
|
+
# @!attribute [rw] display_format
|
7373
|
+
# The display format. Valid values for this structure are `AUTO`,
|
7374
|
+
# `PERCENT`, `CURRENCY`, `NUMBER`, `DATE`, and `STRING`.
|
7375
|
+
# @return [String]
|
7376
|
+
#
|
7377
|
+
# @!attribute [rw] display_format_options
|
7378
|
+
# The additional options for display formatting.
|
7379
|
+
# @return [Types::DisplayFormatOptions]
|
7380
|
+
#
|
7381
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DefaultFormatting AWS API Documentation
|
7382
|
+
#
|
7383
|
+
class DefaultFormatting < Struct.new(
|
7384
|
+
:display_format,
|
7385
|
+
:display_format_options)
|
7386
|
+
SENSITIVE = []
|
7387
|
+
include Aws::Structure
|
7388
|
+
end
|
7389
|
+
|
6792
7390
|
# The options that determine the default settings of a free-form layout
|
6793
7391
|
# configuration.
|
6794
7392
|
#
|
@@ -7084,6 +7682,40 @@ module Aws::QuickSight
|
|
7084
7682
|
include Aws::Structure
|
7085
7683
|
end
|
7086
7684
|
|
7685
|
+
# @!attribute [rw] aws_account_id
|
7686
|
+
# The Amazon Web Services account ID.
|
7687
|
+
# @return [String]
|
7688
|
+
#
|
7689
|
+
# @!attribute [rw] data_set_id
|
7690
|
+
# The ID of the dataset.
|
7691
|
+
# @return [String]
|
7692
|
+
#
|
7693
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDataSetRefreshPropertiesRequest AWS API Documentation
|
7694
|
+
#
|
7695
|
+
class DeleteDataSetRefreshPropertiesRequest < Struct.new(
|
7696
|
+
:aws_account_id,
|
7697
|
+
:data_set_id)
|
7698
|
+
SENSITIVE = []
|
7699
|
+
include Aws::Structure
|
7700
|
+
end
|
7701
|
+
|
7702
|
+
# @!attribute [rw] request_id
|
7703
|
+
# The Amazon Web Services request ID for this operation.
|
7704
|
+
# @return [String]
|
7705
|
+
#
|
7706
|
+
# @!attribute [rw] status
|
7707
|
+
# The HTTP status of the request.
|
7708
|
+
# @return [Integer]
|
7709
|
+
#
|
7710
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDataSetRefreshPropertiesResponse AWS API Documentation
|
7711
|
+
#
|
7712
|
+
class DeleteDataSetRefreshPropertiesResponse < Struct.new(
|
7713
|
+
:request_id,
|
7714
|
+
:status)
|
7715
|
+
SENSITIVE = []
|
7716
|
+
include Aws::Structure
|
7717
|
+
end
|
7718
|
+
|
7087
7719
|
# @!attribute [rw] aws_account_id
|
7088
7720
|
# The Amazon Web Services account ID.
|
7089
7721
|
# @return [String]
|
@@ -7434,6 +8066,55 @@ module Aws::QuickSight
|
|
7434
8066
|
include Aws::Structure
|
7435
8067
|
end
|
7436
8068
|
|
8069
|
+
# @!attribute [rw] data_set_id
|
8070
|
+
# The ID of the dataset.
|
8071
|
+
# @return [String]
|
8072
|
+
#
|
8073
|
+
# @!attribute [rw] aws_account_id
|
8074
|
+
# The Amazon Web Services account ID.
|
8075
|
+
# @return [String]
|
8076
|
+
#
|
8077
|
+
# @!attribute [rw] schedule_id
|
8078
|
+
# The ID of the refresh schedule.
|
8079
|
+
# @return [String]
|
8080
|
+
#
|
8081
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteRefreshScheduleRequest AWS API Documentation
|
8082
|
+
#
|
8083
|
+
class DeleteRefreshScheduleRequest < Struct.new(
|
8084
|
+
:data_set_id,
|
8085
|
+
:aws_account_id,
|
8086
|
+
:schedule_id)
|
8087
|
+
SENSITIVE = []
|
8088
|
+
include Aws::Structure
|
8089
|
+
end
|
8090
|
+
|
8091
|
+
# @!attribute [rw] status
|
8092
|
+
# The HTTP status of the request.
|
8093
|
+
# @return [Integer]
|
8094
|
+
#
|
8095
|
+
# @!attribute [rw] request_id
|
8096
|
+
# The Amazon Web Services request ID for this operation.
|
8097
|
+
# @return [String]
|
8098
|
+
#
|
8099
|
+
# @!attribute [rw] schedule_id
|
8100
|
+
# The ID of the refresh schedule.
|
8101
|
+
# @return [String]
|
8102
|
+
#
|
8103
|
+
# @!attribute [rw] arn
|
8104
|
+
# The Amazon Resource Name (ARN) for the refresh schedule.
|
8105
|
+
# @return [String]
|
8106
|
+
#
|
8107
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteRefreshScheduleResponse AWS API Documentation
|
8108
|
+
#
|
8109
|
+
class DeleteRefreshScheduleResponse < Struct.new(
|
8110
|
+
:status,
|
8111
|
+
:request_id,
|
8112
|
+
:schedule_id,
|
8113
|
+
:arn)
|
8114
|
+
SENSITIVE = []
|
8115
|
+
include Aws::Structure
|
8116
|
+
end
|
8117
|
+
|
7437
8118
|
# @!attribute [rw] aws_account_id
|
7438
8119
|
# The ID of the Amazon Web Services account that contains the item to
|
7439
8120
|
# delete.
|
@@ -7653,6 +8334,109 @@ module Aws::QuickSight
|
|
7653
8334
|
include Aws::Structure
|
7654
8335
|
end
|
7655
8336
|
|
8337
|
+
# @!attribute [rw] aws_account_id
|
8338
|
+
# The Amazon Web Services account ID.
|
8339
|
+
# @return [String]
|
8340
|
+
#
|
8341
|
+
# @!attribute [rw] topic_id
|
8342
|
+
# The ID of the topic that you want to modify. This ID is unique per
|
8343
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
8344
|
+
# @return [String]
|
8345
|
+
#
|
8346
|
+
# @!attribute [rw] dataset_id
|
8347
|
+
# The ID of the dataset.
|
8348
|
+
# @return [String]
|
8349
|
+
#
|
8350
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteTopicRefreshScheduleRequest AWS API Documentation
|
8351
|
+
#
|
8352
|
+
class DeleteTopicRefreshScheduleRequest < Struct.new(
|
8353
|
+
:aws_account_id,
|
8354
|
+
:topic_id,
|
8355
|
+
:dataset_id)
|
8356
|
+
SENSITIVE = []
|
8357
|
+
include Aws::Structure
|
8358
|
+
end
|
8359
|
+
|
8360
|
+
# @!attribute [rw] topic_id
|
8361
|
+
# The ID of the topic that you want to modify. This ID is unique per
|
8362
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
8363
|
+
# @return [String]
|
8364
|
+
#
|
8365
|
+
# @!attribute [rw] topic_arn
|
8366
|
+
# The Amazon Resource Name (ARN) of the topic.
|
8367
|
+
# @return [String]
|
8368
|
+
#
|
8369
|
+
# @!attribute [rw] dataset_arn
|
8370
|
+
# The Amazon Resource Name (ARN) of the dataset.
|
8371
|
+
# @return [String]
|
8372
|
+
#
|
8373
|
+
# @!attribute [rw] status
|
8374
|
+
# The HTTP status of the request.
|
8375
|
+
# @return [Integer]
|
8376
|
+
#
|
8377
|
+
# @!attribute [rw] request_id
|
8378
|
+
# The Amazon Web Services request ID for this operation.
|
8379
|
+
# @return [String]
|
8380
|
+
#
|
8381
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteTopicRefreshScheduleResponse AWS API Documentation
|
8382
|
+
#
|
8383
|
+
class DeleteTopicRefreshScheduleResponse < Struct.new(
|
8384
|
+
:topic_id,
|
8385
|
+
:topic_arn,
|
8386
|
+
:dataset_arn,
|
8387
|
+
:status,
|
8388
|
+
:request_id)
|
8389
|
+
SENSITIVE = []
|
8390
|
+
include Aws::Structure
|
8391
|
+
end
|
8392
|
+
|
8393
|
+
# @!attribute [rw] aws_account_id
|
8394
|
+
# The ID of the Amazon Web Services account that contains the topic
|
8395
|
+
# that you want to delete.
|
8396
|
+
# @return [String]
|
8397
|
+
#
|
8398
|
+
# @!attribute [rw] topic_id
|
8399
|
+
# The ID of the topic that you want to delete. This ID is unique per
|
8400
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
8401
|
+
# @return [String]
|
8402
|
+
#
|
8403
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteTopicRequest AWS API Documentation
|
8404
|
+
#
|
8405
|
+
class DeleteTopicRequest < Struct.new(
|
8406
|
+
:aws_account_id,
|
8407
|
+
:topic_id)
|
8408
|
+
SENSITIVE = []
|
8409
|
+
include Aws::Structure
|
8410
|
+
end
|
8411
|
+
|
8412
|
+
# @!attribute [rw] arn
|
8413
|
+
# The Amazon Resource Name (ARN) of the topic.
|
8414
|
+
# @return [String]
|
8415
|
+
#
|
8416
|
+
# @!attribute [rw] topic_id
|
8417
|
+
# The ID of the topic that you want to delete. This ID is unique per
|
8418
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
8419
|
+
# @return [String]
|
8420
|
+
#
|
8421
|
+
# @!attribute [rw] request_id
|
8422
|
+
# The Amazon Web Services request ID for this operation.
|
8423
|
+
# @return [String]
|
8424
|
+
#
|
8425
|
+
# @!attribute [rw] status
|
8426
|
+
# The HTTP status of the request.
|
8427
|
+
# @return [Integer]
|
8428
|
+
#
|
8429
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteTopicResponse AWS API Documentation
|
8430
|
+
#
|
8431
|
+
class DeleteTopicResponse < Struct.new(
|
8432
|
+
:arn,
|
8433
|
+
:topic_id,
|
8434
|
+
:request_id,
|
8435
|
+
:status)
|
8436
|
+
SENSITIVE = []
|
8437
|
+
include Aws::Structure
|
8438
|
+
end
|
8439
|
+
|
7656
8440
|
# @!attribute [rw] principal_id
|
7657
8441
|
# The principal ID of the user.
|
7658
8442
|
# @return [String]
|
@@ -7736,21 +8520,80 @@ module Aws::QuickSight
|
|
7736
8520
|
end
|
7737
8521
|
|
7738
8522
|
# @!attribute [rw] aws_account_id
|
7739
|
-
# The
|
7740
|
-
#
|
8523
|
+
# The Amazon Web Services account ID of the account where you want to
|
8524
|
+
# delete a VPC connection.
|
7741
8525
|
# @return [String]
|
7742
8526
|
#
|
7743
|
-
# @!attribute [rw]
|
7744
|
-
# The
|
7745
|
-
#
|
8527
|
+
# @!attribute [rw] vpc_connection_id
|
8528
|
+
# The ID of the VPC connection that you're creating. This ID is a
|
8529
|
+
# unique identifier for each Amazon Web Services Region in an Amazon
|
8530
|
+
# Web Services account.
|
7746
8531
|
# @return [String]
|
7747
8532
|
#
|
7748
|
-
#
|
7749
|
-
#
|
7750
|
-
|
7751
|
-
|
7752
|
-
|
7753
|
-
|
8533
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteVPCConnectionRequest AWS API Documentation
|
8534
|
+
#
|
8535
|
+
class DeleteVPCConnectionRequest < Struct.new(
|
8536
|
+
:aws_account_id,
|
8537
|
+
:vpc_connection_id)
|
8538
|
+
SENSITIVE = []
|
8539
|
+
include Aws::Structure
|
8540
|
+
end
|
8541
|
+
|
8542
|
+
# @!attribute [rw] arn
|
8543
|
+
# The Amazon Resource Name (ARN) of the deleted VPC connection.
|
8544
|
+
# @return [String]
|
8545
|
+
#
|
8546
|
+
# @!attribute [rw] vpc_connection_id
|
8547
|
+
# The ID of the VPC connection that you're creating. This ID is a
|
8548
|
+
# unique identifier for each Amazon Web Services Region in an Amazon
|
8549
|
+
# Web Services account.
|
8550
|
+
# @return [String]
|
8551
|
+
#
|
8552
|
+
# @!attribute [rw] deletion_status
|
8553
|
+
# The deletion status of the VPC connection.
|
8554
|
+
# @return [String]
|
8555
|
+
#
|
8556
|
+
# @!attribute [rw] availability_status
|
8557
|
+
# The availability status of the VPC connection.
|
8558
|
+
# @return [String]
|
8559
|
+
#
|
8560
|
+
# @!attribute [rw] request_id
|
8561
|
+
# The Amazon Web Services request ID for this operation.
|
8562
|
+
# @return [String]
|
8563
|
+
#
|
8564
|
+
# @!attribute [rw] status
|
8565
|
+
# The HTTP status of the request.
|
8566
|
+
# @return [Integer]
|
8567
|
+
#
|
8568
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteVPCConnectionResponse AWS API Documentation
|
8569
|
+
#
|
8570
|
+
class DeleteVPCConnectionResponse < Struct.new(
|
8571
|
+
:arn,
|
8572
|
+
:vpc_connection_id,
|
8573
|
+
:deletion_status,
|
8574
|
+
:availability_status,
|
8575
|
+
:request_id,
|
8576
|
+
:status)
|
8577
|
+
SENSITIVE = []
|
8578
|
+
include Aws::Structure
|
8579
|
+
end
|
8580
|
+
|
8581
|
+
# @!attribute [rw] aws_account_id
|
8582
|
+
# The ID for the Amazon Web Services account that you want to describe
|
8583
|
+
# Amazon QuickSight customizations for.
|
8584
|
+
# @return [String]
|
8585
|
+
#
|
8586
|
+
# @!attribute [rw] namespace
|
8587
|
+
# The Amazon QuickSight namespace that you want to describe Amazon
|
8588
|
+
# QuickSight customizations for.
|
8589
|
+
# @return [String]
|
8590
|
+
#
|
8591
|
+
# @!attribute [rw] resolved
|
8592
|
+
# The `Resolved` flag works with the other parameters to determine
|
8593
|
+
# which view of Amazon QuickSight customizations is returned. You can
|
8594
|
+
# add this flag to your command to use the same view that Amazon
|
8595
|
+
# QuickSight uses to identify which customizations to apply to the
|
8596
|
+
# console. Omit this flag, or set it to `no-resolved`, to reveal
|
7754
8597
|
# customizations that are configured at different levels.
|
7755
8598
|
# @return [Boolean]
|
7756
8599
|
#
|
@@ -8353,6 +9196,45 @@ module Aws::QuickSight
|
|
8353
9196
|
include Aws::Structure
|
8354
9197
|
end
|
8355
9198
|
|
9199
|
+
# @!attribute [rw] aws_account_id
|
9200
|
+
# The Amazon Web Services account ID.
|
9201
|
+
# @return [String]
|
9202
|
+
#
|
9203
|
+
# @!attribute [rw] data_set_id
|
9204
|
+
# The ID of the dataset.
|
9205
|
+
# @return [String]
|
9206
|
+
#
|
9207
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSetRefreshPropertiesRequest AWS API Documentation
|
9208
|
+
#
|
9209
|
+
class DescribeDataSetRefreshPropertiesRequest < Struct.new(
|
9210
|
+
:aws_account_id,
|
9211
|
+
:data_set_id)
|
9212
|
+
SENSITIVE = []
|
9213
|
+
include Aws::Structure
|
9214
|
+
end
|
9215
|
+
|
9216
|
+
# @!attribute [rw] request_id
|
9217
|
+
# The Amazon Web Services request ID for this operation.
|
9218
|
+
# @return [String]
|
9219
|
+
#
|
9220
|
+
# @!attribute [rw] status
|
9221
|
+
# The HTTP status of the request.
|
9222
|
+
# @return [Integer]
|
9223
|
+
#
|
9224
|
+
# @!attribute [rw] data_set_refresh_properties
|
9225
|
+
# The dataset refresh properties.
|
9226
|
+
# @return [Types::DataSetRefreshProperties]
|
9227
|
+
#
|
9228
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSetRefreshPropertiesResponse AWS API Documentation
|
9229
|
+
#
|
9230
|
+
class DescribeDataSetRefreshPropertiesResponse < Struct.new(
|
9231
|
+
:request_id,
|
9232
|
+
:status,
|
9233
|
+
:data_set_refresh_properties)
|
9234
|
+
SENSITIVE = []
|
9235
|
+
include Aws::Structure
|
9236
|
+
end
|
9237
|
+
|
8356
9238
|
# @!attribute [rw] aws_account_id
|
8357
9239
|
# The Amazon Web Services account ID.
|
8358
9240
|
# @return [String]
|
@@ -8899,6 +9781,55 @@ module Aws::QuickSight
|
|
8899
9781
|
include Aws::Structure
|
8900
9782
|
end
|
8901
9783
|
|
9784
|
+
# @!attribute [rw] aws_account_id
|
9785
|
+
# The Amazon Web Services account ID.
|
9786
|
+
# @return [String]
|
9787
|
+
#
|
9788
|
+
# @!attribute [rw] data_set_id
|
9789
|
+
# The ID of the dataset.
|
9790
|
+
# @return [String]
|
9791
|
+
#
|
9792
|
+
# @!attribute [rw] schedule_id
|
9793
|
+
# The ID of the refresh schedule.
|
9794
|
+
# @return [String]
|
9795
|
+
#
|
9796
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeRefreshScheduleRequest AWS API Documentation
|
9797
|
+
#
|
9798
|
+
class DescribeRefreshScheduleRequest < Struct.new(
|
9799
|
+
:aws_account_id,
|
9800
|
+
:data_set_id,
|
9801
|
+
:schedule_id)
|
9802
|
+
SENSITIVE = []
|
9803
|
+
include Aws::Structure
|
9804
|
+
end
|
9805
|
+
|
9806
|
+
# @!attribute [rw] refresh_schedule
|
9807
|
+
# The refresh schedule.
|
9808
|
+
# @return [Types::RefreshSchedule]
|
9809
|
+
#
|
9810
|
+
# @!attribute [rw] status
|
9811
|
+
# The HTTP status of the request.
|
9812
|
+
# @return [Integer]
|
9813
|
+
#
|
9814
|
+
# @!attribute [rw] request_id
|
9815
|
+
# The Amazon Web Services request ID for this operation.
|
9816
|
+
# @return [String]
|
9817
|
+
#
|
9818
|
+
# @!attribute [rw] arn
|
9819
|
+
# The Amazon Resource Name (ARN) for the refresh schedule.
|
9820
|
+
# @return [String]
|
9821
|
+
#
|
9822
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeRefreshScheduleResponse AWS API Documentation
|
9823
|
+
#
|
9824
|
+
class DescribeRefreshScheduleResponse < Struct.new(
|
9825
|
+
:refresh_schedule,
|
9826
|
+
:status,
|
9827
|
+
:request_id,
|
9828
|
+
:arn)
|
9829
|
+
SENSITIVE = []
|
9830
|
+
include Aws::Structure
|
9831
|
+
end
|
9832
|
+
|
8902
9833
|
# @!attribute [rw] aws_account_id
|
8903
9834
|
# The ID of the Amazon Web Services account that contains the template
|
8904
9835
|
# alias that you're describing.
|
@@ -9302,154 +10233,486 @@ module Aws::QuickSight
|
|
9302
10233
|
include Aws::Structure
|
9303
10234
|
end
|
9304
10235
|
|
9305
|
-
# @!attribute [rw] user_name
|
9306
|
-
# The name of the user that you want to describe.
|
9307
|
-
# @return [String]
|
9308
|
-
#
|
9309
10236
|
# @!attribute [rw] aws_account_id
|
9310
|
-
# The ID
|
9311
|
-
#
|
9312
|
-
# contains your Amazon QuickSight account.
|
10237
|
+
# The ID of the Amazon Web Services account that contains the topic
|
10238
|
+
# that you want described.
|
9313
10239
|
# @return [String]
|
9314
10240
|
#
|
9315
|
-
# @!attribute [rw]
|
9316
|
-
# The
|
10241
|
+
# @!attribute [rw] topic_id
|
10242
|
+
# The ID of the topic that you want to describe. This ID is unique per
|
10243
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
9317
10244
|
# @return [String]
|
9318
10245
|
#
|
9319
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
10246
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTopicPermissionsRequest AWS API Documentation
|
9320
10247
|
#
|
9321
|
-
class
|
9322
|
-
:user_name,
|
10248
|
+
class DescribeTopicPermissionsRequest < Struct.new(
|
9323
10249
|
:aws_account_id,
|
9324
|
-
:
|
10250
|
+
:topic_id)
|
9325
10251
|
SENSITIVE = []
|
9326
10252
|
include Aws::Structure
|
9327
10253
|
end
|
9328
10254
|
|
9329
|
-
# @!attribute [rw]
|
9330
|
-
# The
|
9331
|
-
#
|
10255
|
+
# @!attribute [rw] topic_id
|
10256
|
+
# The ID of the topic that you want to describe. This ID is unique per
|
10257
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
10258
|
+
# @return [String]
|
9332
10259
|
#
|
9333
|
-
# @!attribute [rw]
|
9334
|
-
# The Amazon
|
10260
|
+
# @!attribute [rw] topic_arn
|
10261
|
+
# The Amazon Resource Name (ARN) of the topic.
|
9335
10262
|
# @return [String]
|
9336
10263
|
#
|
10264
|
+
# @!attribute [rw] permissions
|
10265
|
+
# A list of resource permissions that are configured to the topic.
|
10266
|
+
# @return [Array<Types::ResourcePermission>]
|
10267
|
+
#
|
9337
10268
|
# @!attribute [rw] status
|
9338
10269
|
# The HTTP status of the request.
|
9339
10270
|
# @return [Integer]
|
9340
10271
|
#
|
9341
|
-
#
|
10272
|
+
# @!attribute [rw] request_id
|
10273
|
+
# The Amazon Web Services request ID for this operation.
|
10274
|
+
# @return [String]
|
9342
10275
|
#
|
9343
|
-
|
9344
|
-
|
9345
|
-
|
9346
|
-
:
|
10276
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTopicPermissionsResponse AWS API Documentation
|
10277
|
+
#
|
10278
|
+
class DescribeTopicPermissionsResponse < Struct.new(
|
10279
|
+
:topic_id,
|
10280
|
+
:topic_arn,
|
10281
|
+
:permissions,
|
10282
|
+
:status,
|
10283
|
+
:request_id)
|
9347
10284
|
SENSITIVE = []
|
9348
10285
|
include Aws::Structure
|
9349
10286
|
end
|
9350
10287
|
|
9351
|
-
#
|
9352
|
-
#
|
9353
|
-
#
|
9354
|
-
# one of the attributes can be defined.
|
9355
|
-
#
|
9356
|
-
# @!attribute [rw] custom_values_configuration
|
9357
|
-
# The configuration of custom values for destination parameter in
|
9358
|
-
# `DestinationParameterValueConfiguration`.
|
9359
|
-
# @return [Types::CustomValuesConfiguration]
|
9360
|
-
#
|
9361
|
-
# @!attribute [rw] select_all_value_options
|
9362
|
-
# The configuration that selects all options.
|
10288
|
+
# @!attribute [rw] aws_account_id
|
10289
|
+
# The ID of the Amazon Web Services account that contains the topic
|
10290
|
+
# whose refresh you want to describe.
|
9363
10291
|
# @return [String]
|
9364
10292
|
#
|
9365
|
-
# @!attribute [rw]
|
9366
|
-
# The
|
10293
|
+
# @!attribute [rw] topic_id
|
10294
|
+
# The ID of the topic that you want to describe. This ID is unique per
|
10295
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
9367
10296
|
# @return [String]
|
9368
10297
|
#
|
9369
|
-
# @!attribute [rw]
|
9370
|
-
# The
|
10298
|
+
# @!attribute [rw] refresh_id
|
10299
|
+
# The ID of the refresh, which is performed when the topic is created
|
10300
|
+
# or updated.
|
9371
10301
|
# @return [String]
|
9372
10302
|
#
|
9373
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
10303
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTopicRefreshRequest AWS API Documentation
|
9374
10304
|
#
|
9375
|
-
class
|
9376
|
-
:
|
9377
|
-
:
|
9378
|
-
:
|
9379
|
-
:source_field)
|
10305
|
+
class DescribeTopicRefreshRequest < Struct.new(
|
10306
|
+
:aws_account_id,
|
10307
|
+
:topic_id,
|
10308
|
+
:refresh_id)
|
9380
10309
|
SENSITIVE = []
|
9381
10310
|
include Aws::Structure
|
9382
10311
|
end
|
9383
10312
|
|
9384
|
-
#
|
10313
|
+
# @!attribute [rw] refresh_details
|
10314
|
+
# Details of the refresh, which is performed when the topic is created
|
10315
|
+
# or updated.
|
10316
|
+
# @return [Types::TopicRefreshDetails]
|
9385
10317
|
#
|
9386
|
-
# @!attribute [rw]
|
9387
|
-
# The
|
9388
|
-
# @return [
|
10318
|
+
# @!attribute [rw] request_id
|
10319
|
+
# The Amazon Web Services request ID for this operation.
|
10320
|
+
# @return [String]
|
9389
10321
|
#
|
9390
|
-
# @!attribute [rw]
|
9391
|
-
# The
|
9392
|
-
# @return [
|
10322
|
+
# @!attribute [rw] status
|
10323
|
+
# The HTTP status of the request.
|
10324
|
+
# @return [Integer]
|
9393
10325
|
#
|
9394
|
-
#
|
9395
|
-
# The dimension type field with date type columns.
|
9396
|
-
# @return [Types::DateDimensionField]
|
10326
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTopicRefreshResponse AWS API Documentation
|
9397
10327
|
#
|
9398
|
-
|
10328
|
+
class DescribeTopicRefreshResponse < Struct.new(
|
10329
|
+
:refresh_details,
|
10330
|
+
:request_id,
|
10331
|
+
:status)
|
10332
|
+
SENSITIVE = []
|
10333
|
+
include Aws::Structure
|
10334
|
+
end
|
10335
|
+
|
10336
|
+
# @!attribute [rw] aws_account_id
|
10337
|
+
# The Amazon Web Services account ID.
|
10338
|
+
# @return [String]
|
9399
10339
|
#
|
9400
|
-
|
9401
|
-
|
9402
|
-
|
9403
|
-
|
10340
|
+
# @!attribute [rw] topic_id
|
10341
|
+
# The ID of the topic that contains the refresh schedule that you want
|
10342
|
+
# to describe. This ID is unique per Amazon Web Services Region for
|
10343
|
+
# each Amazon Web Services account.
|
10344
|
+
# @return [String]
|
10345
|
+
#
|
10346
|
+
# @!attribute [rw] dataset_id
|
10347
|
+
# The ID of the dataset.
|
10348
|
+
# @return [String]
|
10349
|
+
#
|
10350
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTopicRefreshScheduleRequest AWS API Documentation
|
10351
|
+
#
|
10352
|
+
class DescribeTopicRefreshScheduleRequest < Struct.new(
|
10353
|
+
:aws_account_id,
|
10354
|
+
:topic_id,
|
10355
|
+
:dataset_id)
|
9404
10356
|
SENSITIVE = []
|
9405
10357
|
include Aws::Structure
|
9406
10358
|
end
|
9407
10359
|
|
9408
|
-
#
|
9409
|
-
#
|
9410
|
-
#
|
10360
|
+
# @!attribute [rw] topic_id
|
10361
|
+
# The ID of the topic that contains the refresh schedule that you want
|
10362
|
+
# to describe. This ID is unique per Amazon Web Services Region for
|
10363
|
+
# each Amazon Web Services account.
|
10364
|
+
# @return [String]
|
9411
10365
|
#
|
9412
|
-
# @!attribute [rw]
|
10366
|
+
# @!attribute [rw] topic_arn
|
10367
|
+
# The Amazon Resource Name (ARN) of the topic.
|
10368
|
+
# @return [String]
|
10369
|
+
#
|
10370
|
+
# @!attribute [rw] dataset_arn
|
10371
|
+
# The Amazon Resource Name (ARN) of the dataset.
|
9413
10372
|
# @return [String]
|
9414
10373
|
#
|
10374
|
+
# @!attribute [rw] refresh_schedule
|
10375
|
+
# The definition of a refresh schedule.
|
10376
|
+
# @return [Types::TopicRefreshSchedule]
|
10377
|
+
#
|
10378
|
+
# @!attribute [rw] status
|
10379
|
+
# The HTTP status of the request.
|
10380
|
+
# @return [Integer]
|
10381
|
+
#
|
9415
10382
|
# @!attribute [rw] request_id
|
9416
|
-
# The Amazon Web Services request ID for this
|
10383
|
+
# The Amazon Web Services request ID for this operation.
|
9417
10384
|
# @return [String]
|
9418
10385
|
#
|
9419
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
10386
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTopicRefreshScheduleResponse AWS API Documentation
|
9420
10387
|
#
|
9421
|
-
class
|
9422
|
-
:
|
10388
|
+
class DescribeTopicRefreshScheduleResponse < Struct.new(
|
10389
|
+
:topic_id,
|
10390
|
+
:topic_arn,
|
10391
|
+
:dataset_arn,
|
10392
|
+
:refresh_schedule,
|
10393
|
+
:status,
|
9423
10394
|
:request_id)
|
9424
10395
|
SENSITIVE = []
|
9425
10396
|
include Aws::Structure
|
9426
10397
|
end
|
9427
10398
|
|
9428
|
-
#
|
9429
|
-
#
|
10399
|
+
# @!attribute [rw] aws_account_id
|
10400
|
+
# The Amazon Web Services account ID.
|
10401
|
+
# @return [String]
|
9430
10402
|
#
|
9431
|
-
# @!attribute [rw]
|
9432
|
-
#
|
9433
|
-
# Amazon
|
10403
|
+
# @!attribute [rw] topic_id
|
10404
|
+
# The ID of the topic that you want to describe. This ID is unique per
|
10405
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
9434
10406
|
# @return [String]
|
9435
10407
|
#
|
9436
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/
|
10408
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTopicRequest AWS API Documentation
|
9437
10409
|
#
|
9438
|
-
class
|
9439
|
-
:
|
10410
|
+
class DescribeTopicRequest < Struct.new(
|
10411
|
+
:aws_account_id,
|
10412
|
+
:topic_id)
|
9440
10413
|
SENSITIVE = []
|
9441
10414
|
include Aws::Structure
|
9442
10415
|
end
|
9443
10416
|
|
9444
|
-
#
|
9445
|
-
#
|
9446
|
-
#
|
9447
|
-
# The option for define the arc of the chart shape. Valid values are
|
9448
|
-
# as follows:
|
10417
|
+
# @!attribute [rw] arn
|
10418
|
+
# The Amazon Resource Name (ARN) of the topic.
|
10419
|
+
# @return [String]
|
9449
10420
|
#
|
9450
|
-
#
|
10421
|
+
# @!attribute [rw] topic_id
|
10422
|
+
# The ID of the topic that you want to describe. This ID is unique per
|
10423
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
10424
|
+
# @return [String]
|
9451
10425
|
#
|
9452
|
-
#
|
10426
|
+
# @!attribute [rw] topic
|
10427
|
+
# The definition of a topic.
|
10428
|
+
# @return [Types::TopicDetails]
|
10429
|
+
#
|
10430
|
+
# @!attribute [rw] request_id
|
10431
|
+
# The Amazon Web Services request ID for this operation.
|
10432
|
+
# @return [String]
|
10433
|
+
#
|
10434
|
+
# @!attribute [rw] status
|
10435
|
+
# The HTTP status of the request.
|
10436
|
+
# @return [Integer]
|
10437
|
+
#
|
10438
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTopicResponse AWS API Documentation
|
10439
|
+
#
|
10440
|
+
class DescribeTopicResponse < Struct.new(
|
10441
|
+
:arn,
|
10442
|
+
:topic_id,
|
10443
|
+
:topic,
|
10444
|
+
:request_id,
|
10445
|
+
:status)
|
10446
|
+
SENSITIVE = []
|
10447
|
+
include Aws::Structure
|
10448
|
+
end
|
10449
|
+
|
10450
|
+
# @!attribute [rw] user_name
|
10451
|
+
# The name of the user that you want to describe.
|
10452
|
+
# @return [String]
|
10453
|
+
#
|
10454
|
+
# @!attribute [rw] aws_account_id
|
10455
|
+
# The ID for the Amazon Web Services account that the user is in.
|
10456
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
10457
|
+
# contains your Amazon QuickSight account.
|
10458
|
+
# @return [String]
|
10459
|
+
#
|
10460
|
+
# @!attribute [rw] namespace
|
10461
|
+
# The namespace. Currently, you should set this to `default`.
|
10462
|
+
# @return [String]
|
10463
|
+
#
|
10464
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeUserRequest AWS API Documentation
|
10465
|
+
#
|
10466
|
+
class DescribeUserRequest < Struct.new(
|
10467
|
+
:user_name,
|
10468
|
+
:aws_account_id,
|
10469
|
+
:namespace)
|
10470
|
+
SENSITIVE = []
|
10471
|
+
include Aws::Structure
|
10472
|
+
end
|
10473
|
+
|
10474
|
+
# @!attribute [rw] user
|
10475
|
+
# The user name.
|
10476
|
+
# @return [Types::User]
|
10477
|
+
#
|
10478
|
+
# @!attribute [rw] request_id
|
10479
|
+
# The Amazon Web Services request ID for this operation.
|
10480
|
+
# @return [String]
|
10481
|
+
#
|
10482
|
+
# @!attribute [rw] status
|
10483
|
+
# The HTTP status of the request.
|
10484
|
+
# @return [Integer]
|
10485
|
+
#
|
10486
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeUserResponse AWS API Documentation
|
10487
|
+
#
|
10488
|
+
class DescribeUserResponse < Struct.new(
|
10489
|
+
:user,
|
10490
|
+
:request_id,
|
10491
|
+
:status)
|
10492
|
+
SENSITIVE = []
|
10493
|
+
include Aws::Structure
|
10494
|
+
end
|
10495
|
+
|
10496
|
+
# @!attribute [rw] aws_account_id
|
10497
|
+
# The Amazon Web Services account ID of the account that contains the
|
10498
|
+
# VPC connection that you want described.
|
10499
|
+
# @return [String]
|
10500
|
+
#
|
10501
|
+
# @!attribute [rw] vpc_connection_id
|
10502
|
+
# The ID of the VPC connection that you're creating. This ID is a
|
10503
|
+
# unique identifier for each Amazon Web Services Region in an Amazon
|
10504
|
+
# Web Services account.
|
10505
|
+
# @return [String]
|
10506
|
+
#
|
10507
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeVPCConnectionRequest AWS API Documentation
|
10508
|
+
#
|
10509
|
+
class DescribeVPCConnectionRequest < Struct.new(
|
10510
|
+
:aws_account_id,
|
10511
|
+
:vpc_connection_id)
|
10512
|
+
SENSITIVE = []
|
10513
|
+
include Aws::Structure
|
10514
|
+
end
|
10515
|
+
|
10516
|
+
# @!attribute [rw] vpc_connection
|
10517
|
+
# A response object that provides information for the specified VPC
|
10518
|
+
# connection.
|
10519
|
+
# @return [Types::VPCConnection]
|
10520
|
+
#
|
10521
|
+
# @!attribute [rw] request_id
|
10522
|
+
# The Amazon Web Services request ID for this operation.
|
10523
|
+
# @return [String]
|
10524
|
+
#
|
10525
|
+
# @!attribute [rw] status
|
10526
|
+
# The HTTP status of the request.
|
10527
|
+
# @return [Integer]
|
10528
|
+
#
|
10529
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeVPCConnectionResponse AWS API Documentation
|
10530
|
+
#
|
10531
|
+
class DescribeVPCConnectionResponse < Struct.new(
|
10532
|
+
:vpc_connection,
|
10533
|
+
:request_id,
|
10534
|
+
:status)
|
10535
|
+
SENSITIVE = []
|
10536
|
+
include Aws::Structure
|
10537
|
+
end
|
10538
|
+
|
10539
|
+
# The configuration of destination parameter values.
|
10540
|
+
#
|
10541
|
+
# This is a union type structure. For this structure to be valid, only
|
10542
|
+
# one of the attributes can be defined.
|
10543
|
+
#
|
10544
|
+
# @!attribute [rw] custom_values_configuration
|
10545
|
+
# The configuration of custom values for destination parameter in
|
10546
|
+
# `DestinationParameterValueConfiguration`.
|
10547
|
+
# @return [Types::CustomValuesConfiguration]
|
10548
|
+
#
|
10549
|
+
# @!attribute [rw] select_all_value_options
|
10550
|
+
# The configuration that selects all options.
|
10551
|
+
# @return [String]
|
10552
|
+
#
|
10553
|
+
# @!attribute [rw] source_parameter_name
|
10554
|
+
# The source parameter name of the destination parameter.
|
10555
|
+
# @return [String]
|
10556
|
+
#
|
10557
|
+
# @!attribute [rw] source_field
|
10558
|
+
# The source field ID of the destination parameter.
|
10559
|
+
# @return [String]
|
10560
|
+
#
|
10561
|
+
# @!attribute [rw] source_column
|
10562
|
+
# A column of a data set.
|
10563
|
+
# @return [Types::ColumnIdentifier]
|
10564
|
+
#
|
10565
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DestinationParameterValueConfiguration AWS API Documentation
|
10566
|
+
#
|
10567
|
+
class DestinationParameterValueConfiguration < Struct.new(
|
10568
|
+
:custom_values_configuration,
|
10569
|
+
:select_all_value_options,
|
10570
|
+
:source_parameter_name,
|
10571
|
+
:source_field,
|
10572
|
+
:source_column)
|
10573
|
+
SENSITIVE = []
|
10574
|
+
include Aws::Structure
|
10575
|
+
end
|
10576
|
+
|
10577
|
+
# The dimension type field.
|
10578
|
+
#
|
10579
|
+
# @!attribute [rw] numerical_dimension_field
|
10580
|
+
# The dimension type field with numerical type columns.
|
10581
|
+
# @return [Types::NumericalDimensionField]
|
10582
|
+
#
|
10583
|
+
# @!attribute [rw] categorical_dimension_field
|
10584
|
+
# The dimension type field with categorical type columns.
|
10585
|
+
# @return [Types::CategoricalDimensionField]
|
10586
|
+
#
|
10587
|
+
# @!attribute [rw] date_dimension_field
|
10588
|
+
# The dimension type field with date type columns.
|
10589
|
+
# @return [Types::DateDimensionField]
|
10590
|
+
#
|
10591
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DimensionField AWS API Documentation
|
10592
|
+
#
|
10593
|
+
class DimensionField < Struct.new(
|
10594
|
+
:numerical_dimension_field,
|
10595
|
+
:categorical_dimension_field,
|
10596
|
+
:date_dimension_field)
|
10597
|
+
SENSITIVE = []
|
10598
|
+
include Aws::Structure
|
10599
|
+
end
|
10600
|
+
|
10601
|
+
# A structure that represents additional options for display formatting.
|
10602
|
+
#
|
10603
|
+
# @!attribute [rw] use_blank_cell_format
|
10604
|
+
# A Boolean value that indicates whether to use blank cell format.
|
10605
|
+
# @return [Boolean]
|
10606
|
+
#
|
10607
|
+
# @!attribute [rw] blank_cell_format
|
10608
|
+
# Determines the blank cell format.
|
10609
|
+
# @return [String]
|
10610
|
+
#
|
10611
|
+
# @!attribute [rw] date_format
|
10612
|
+
# Determines the `DateTime` format.
|
10613
|
+
# @return [String]
|
10614
|
+
#
|
10615
|
+
# @!attribute [rw] decimal_separator
|
10616
|
+
# Determines the decimal separator.
|
10617
|
+
# @return [String]
|
10618
|
+
#
|
10619
|
+
# @!attribute [rw] grouping_separator
|
10620
|
+
# Determines the grouping separator.
|
10621
|
+
# @return [String]
|
10622
|
+
#
|
10623
|
+
# @!attribute [rw] use_grouping
|
10624
|
+
# A Boolean value that indicates whether to use grouping.
|
10625
|
+
# @return [Boolean]
|
10626
|
+
#
|
10627
|
+
# @!attribute [rw] fraction_digits
|
10628
|
+
# Determines the number of fraction digits.
|
10629
|
+
# @return [Integer]
|
10630
|
+
#
|
10631
|
+
# @!attribute [rw] prefix
|
10632
|
+
# The prefix value for a display format.
|
10633
|
+
# @return [String]
|
10634
|
+
#
|
10635
|
+
# @!attribute [rw] suffix
|
10636
|
+
# The suffix value for a display format.
|
10637
|
+
# @return [String]
|
10638
|
+
#
|
10639
|
+
# @!attribute [rw] unit_scaler
|
10640
|
+
# The unit scaler. Valid values for this structure are: `NONE`,
|
10641
|
+
# `AUTO`, `THOUSANDS`, `MILLIONS`, `BILLIONS`, and `TRILLIONS`.
|
10642
|
+
# @return [String]
|
10643
|
+
#
|
10644
|
+
# @!attribute [rw] negative_format
|
10645
|
+
# The negative format.
|
10646
|
+
# @return [Types::NegativeFormat]
|
10647
|
+
#
|
10648
|
+
# @!attribute [rw] currency_symbol
|
10649
|
+
# The currency symbol, such as `USD`.
|
10650
|
+
# @return [String]
|
10651
|
+
#
|
10652
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DisplayFormatOptions AWS API Documentation
|
10653
|
+
#
|
10654
|
+
class DisplayFormatOptions < Struct.new(
|
10655
|
+
:use_blank_cell_format,
|
10656
|
+
:blank_cell_format,
|
10657
|
+
:date_format,
|
10658
|
+
:decimal_separator,
|
10659
|
+
:grouping_separator,
|
10660
|
+
:use_grouping,
|
10661
|
+
:fraction_digits,
|
10662
|
+
:prefix,
|
10663
|
+
:suffix,
|
10664
|
+
:unit_scaler,
|
10665
|
+
:negative_format,
|
10666
|
+
:currency_symbol)
|
10667
|
+
SENSITIVE = []
|
10668
|
+
include Aws::Structure
|
10669
|
+
end
|
10670
|
+
|
10671
|
+
# The domain specified isn't on the allow list. All domains for
|
10672
|
+
# embedded dashboards must be added to the approved list by an Amazon
|
10673
|
+
# QuickSight admin.
|
10674
|
+
#
|
10675
|
+
# @!attribute [rw] message
|
10676
|
+
# @return [String]
|
10677
|
+
#
|
10678
|
+
# @!attribute [rw] request_id
|
10679
|
+
# The Amazon Web Services request ID for this request.
|
10680
|
+
# @return [String]
|
10681
|
+
#
|
10682
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DomainNotWhitelistedException AWS API Documentation
|
10683
|
+
#
|
10684
|
+
class DomainNotWhitelistedException < Struct.new(
|
10685
|
+
:message,
|
10686
|
+
:request_id)
|
10687
|
+
SENSITIVE = []
|
10688
|
+
include Aws::Structure
|
10689
|
+
end
|
10690
|
+
|
10691
|
+
# The label options of the label that is displayed in the center of a
|
10692
|
+
# donut chart. This option isn't available for pie charts.
|
10693
|
+
#
|
10694
|
+
# @!attribute [rw] label_visibility
|
10695
|
+
# Determines the visibility of the label in a donut chart. In the
|
10696
|
+
# Amazon QuickSight console, this option is called `'Show total'`.
|
10697
|
+
# @return [String]
|
10698
|
+
#
|
10699
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DonutCenterOptions AWS API Documentation
|
10700
|
+
#
|
10701
|
+
class DonutCenterOptions < Struct.new(
|
10702
|
+
:label_visibility)
|
10703
|
+
SENSITIVE = []
|
10704
|
+
include Aws::Structure
|
10705
|
+
end
|
10706
|
+
|
10707
|
+
# The options for configuring a donut chart or pie chart.
|
10708
|
+
#
|
10709
|
+
# @!attribute [rw] arc_options
|
10710
|
+
# The option for define the arc of the chart shape. Valid values are
|
10711
|
+
# as follows:
|
10712
|
+
#
|
10713
|
+
# * `WHOLE` - A pie chart
|
10714
|
+
#
|
10715
|
+
# * `SMALL`- A small-sized donut chart
|
9453
10716
|
#
|
9454
10717
|
# * `MEDIUM`- A medium-sized donut chart
|
9455
10718
|
#
|
@@ -9737,9 +11000,9 @@ module Aws::QuickSight
|
|
9737
11000
|
# The type for the >tooltip title. Choose one of the following
|
9738
11001
|
# options:
|
9739
11002
|
#
|
9740
|
-
# * `NONE
|
11003
|
+
# * `NONE`: Doesn't use the primary value as the title.
|
9741
11004
|
#
|
9742
|
-
# * `PRIMARY_VALUE
|
11005
|
+
# * `PRIMARY_VALUE`: Uses primary value as the title.
|
9743
11006
|
# @return [String]
|
9744
11007
|
#
|
9745
11008
|
# @!attribute [rw] tooltip_fields
|
@@ -9830,9 +11093,9 @@ module Aws::QuickSight
|
|
9830
11093
|
# @!attribute [rw] direction
|
9831
11094
|
# The sort direction. Choose one of the following options:
|
9832
11095
|
#
|
9833
|
-
# * `ASC
|
11096
|
+
# * `ASC`: Ascending
|
9834
11097
|
#
|
9835
|
-
# * `DESC
|
11098
|
+
# * `DESC`: Descending
|
9836
11099
|
# @return [String]
|
9837
11100
|
#
|
9838
11101
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FieldSort AWS API Documentation
|
@@ -10220,9 +11483,9 @@ module Aws::QuickSight
|
|
10220
11483
|
# The date time picker type of a `FilterDateTimePickerControl`. Choose
|
10221
11484
|
# one of the following options:
|
10222
11485
|
#
|
10223
|
-
# * `SINGLE_VALUED
|
11486
|
+
# * `SINGLE_VALUED`: The filter condition is a fixed date.
|
10224
11487
|
#
|
10225
|
-
# * `DATE_RANGE
|
11488
|
+
# * `DATE_RANGE`: The filter condition is a date time range.
|
10226
11489
|
# @return [String]
|
10227
11490
|
#
|
10228
11491
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FilterDateTimePickerControl AWS API Documentation
|
@@ -10260,10 +11523,10 @@ module Aws::QuickSight
|
|
10260
11523
|
# The type of the `FilterDropDownControl`. Choose one of the following
|
10261
11524
|
# options:
|
10262
11525
|
#
|
10263
|
-
# * `MULTI_SELECT
|
11526
|
+
# * `MULTI_SELECT`: The user can select multiple entries from a
|
10264
11527
|
# dropdown menu.
|
10265
11528
|
#
|
10266
|
-
# * `SINGLE_SELECT
|
11529
|
+
# * `SINGLE_SELECT`: The user can select a single entry from a
|
10267
11530
|
# dropdown menu.
|
10268
11531
|
# @return [String]
|
10269
11532
|
#
|
@@ -10396,11 +11659,10 @@ module Aws::QuickSight
|
|
10396
11659
|
# The type of `FilterListControl`. Choose one of the following
|
10397
11660
|
# options:
|
10398
11661
|
#
|
10399
|
-
# * `MULTI_SELECT
|
11662
|
+
# * `MULTI_SELECT`: The user can select multiple entries from the
|
10400
11663
|
# list.
|
10401
11664
|
#
|
10402
|
-
# * `SINGLE_SELECT
|
10403
|
-
# list.
|
11665
|
+
# * `SINGLE_SELECT`: The user can select a single entry from the list.
|
10404
11666
|
# @return [String]
|
10405
11667
|
#
|
10406
11668
|
# @!attribute [rw] selectable_values
|
@@ -10459,16 +11721,21 @@ module Aws::QuickSight
|
|
10459
11721
|
#
|
10460
11722
|
# Valid values are defined as follows:
|
10461
11723
|
#
|
10462
|
-
# * `ALL_FIELDS
|
11724
|
+
# * `ALL_FIELDS`: Applies the filter operation to all fields.
|
10463
11725
|
#
|
10464
11726
|
# ^
|
10465
11727
|
# @return [String]
|
10466
11728
|
#
|
11729
|
+
# @!attribute [rw] selected_columns
|
11730
|
+
# The selected columns of a dataset.
|
11731
|
+
# @return [Array<Types::ColumnIdentifier>]
|
11732
|
+
#
|
10467
11733
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FilterOperationSelectedFieldsConfiguration AWS API Documentation
|
10468
11734
|
#
|
10469
11735
|
class FilterOperationSelectedFieldsConfiguration < Struct.new(
|
10470
11736
|
:selected_fields,
|
10471
|
-
:selected_field_options
|
11737
|
+
:selected_field_options,
|
11738
|
+
:selected_columns)
|
10472
11739
|
SENSITIVE = []
|
10473
11740
|
include Aws::Structure
|
10474
11741
|
end
|
@@ -10575,9 +11842,9 @@ module Aws::QuickSight
|
|
10575
11842
|
# The type of `FilterSliderControl`. Choose one of the following
|
10576
11843
|
# options:
|
10577
11844
|
#
|
10578
|
-
# * `SINGLE_POINT
|
11845
|
+
# * `SINGLE_POINT`: Filter against(equals) a single data point.
|
10579
11846
|
#
|
10580
|
-
# * `RANGE
|
11847
|
+
# * `RANGE`: Filter data that is in a specified range.
|
10581
11848
|
# @return [String]
|
10582
11849
|
#
|
10583
11850
|
# @!attribute [rw] maximum_value
|
@@ -10762,35 +12029,35 @@ module Aws::QuickSight
|
|
10762
12029
|
#
|
10763
12030
|
# Valid values are defined as follows:
|
10764
12031
|
#
|
10765
|
-
# * `QUICKSIGHT_VIEWER_OR_OWNER
|
12032
|
+
# * `QUICKSIGHT_VIEWER_OR_OWNER`: Provide an ARN of a user or group,
|
10766
12033
|
# and any folders with that ARN listed as one of the folder's
|
10767
12034
|
# owners or viewers are returned. Implicit permissions from folders
|
10768
12035
|
# or groups are considered.
|
10769
12036
|
#
|
10770
|
-
# * `QUICKSIGHT_OWNER
|
12037
|
+
# * `QUICKSIGHT_OWNER`: Provide an ARN of a user or group, and any
|
10771
12038
|
# folders with that ARN listed as one of the owners of the folders
|
10772
12039
|
# are returned. Implicit permissions from folders or groups are
|
10773
12040
|
# considered.
|
10774
12041
|
#
|
10775
|
-
# * `DIRECT_QUICKSIGHT_SOLE_OWNER
|
10776
|
-
#
|
10777
|
-
#
|
10778
|
-
#
|
12042
|
+
# * `DIRECT_QUICKSIGHT_SOLE_OWNER`: Provide an ARN of a user or group,
|
12043
|
+
# and any folders with that ARN listed as the only owner of the
|
12044
|
+
# folder are returned. Implicit permissions from folders or groups
|
12045
|
+
# are not considered.
|
10779
12046
|
#
|
10780
|
-
# * `DIRECT_QUICKSIGHT_OWNER
|
12047
|
+
# * `DIRECT_QUICKSIGHT_OWNER`: Provide an ARN of a user or group, and
|
10781
12048
|
# any folders with that ARN listed as one of the owners of the
|
10782
12049
|
# folders are returned. Implicit permissions from folders or groups
|
10783
12050
|
# are not considered.
|
10784
12051
|
#
|
10785
|
-
# * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER
|
12052
|
+
# * `DIRECT_QUICKSIGHT_VIEWER_OR_OWNER`: Provide an ARN of a user or
|
10786
12053
|
# group, and any folders with that ARN listed as one of the owners
|
10787
12054
|
# or viewers of the folders are returned. Implicit permissions from
|
10788
12055
|
# folders or groups are not considered.
|
10789
12056
|
#
|
10790
|
-
# * `FOLDER_NAME
|
12057
|
+
# * `FOLDER_NAME`: Any folders whose names have a substring match to
|
10791
12058
|
# this value will be returned.
|
10792
12059
|
#
|
10793
|
-
# * `PARENT_FOLDER_ARN
|
12060
|
+
# * `PARENT_FOLDER_ARN`: Provide an ARN of a folder, and any folders
|
10794
12061
|
# that are directly under that parent folder are returned. If you
|
10795
12062
|
# choose to use this option and leave the value blank, all
|
10796
12063
|
# root-level folders in the account are returned.
|
@@ -10973,7 +12240,7 @@ module Aws::QuickSight
|
|
10973
12240
|
#
|
10974
12241
|
# * `AUTOMATIC`
|
10975
12242
|
#
|
10976
|
-
# * `CUSTOM
|
12243
|
+
# * `CUSTOM`: Checks the custom seasonality value.
|
10977
12244
|
# @return [String]
|
10978
12245
|
#
|
10979
12246
|
# @!attribute [rw] custom_seasonality_value
|
@@ -12396,10 +13663,10 @@ module Aws::QuickSight
|
|
12396
13663
|
# This value determines the layout behavior when the viewport is
|
12397
13664
|
# resized.
|
12398
13665
|
#
|
12399
|
-
# * `FIXED
|
12400
|
-
#
|
13666
|
+
# * `FIXED`: A fixed width will be used when optimizing the layout. In
|
13667
|
+
# the Amazon QuickSight console, this option is called `Classic`.
|
12401
13668
|
#
|
12402
|
-
# * `RESPONSIVE
|
13669
|
+
# * `RESPONSIVE`: The width of the canvas will be responsive and
|
12403
13670
|
# optimized to the view port. In the Amazon QuickSight console, this
|
12404
13671
|
# option is called `Tiled`.
|
12405
13672
|
# @return [String]
|
@@ -12968,6 +14235,20 @@ module Aws::QuickSight
|
|
12968
14235
|
include Aws::Structure
|
12969
14236
|
end
|
12970
14237
|
|
14238
|
+
# The incremental refresh configuration for a dataset.
|
14239
|
+
#
|
14240
|
+
# @!attribute [rw] lookback_window
|
14241
|
+
# The lookback window setup for an incremental refresh configuration.
|
14242
|
+
# @return [Types::LookbackWindow]
|
14243
|
+
#
|
14244
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/IncrementalRefresh AWS API Documentation
|
14245
|
+
#
|
14246
|
+
class IncrementalRefresh < Struct.new(
|
14247
|
+
:lookback_window)
|
14248
|
+
SENSITIVE = []
|
14249
|
+
include Aws::Structure
|
14250
|
+
end
|
14251
|
+
|
12971
14252
|
# Information about the SPICE ingestion for a dataset.
|
12972
14253
|
#
|
12973
14254
|
# @!attribute [rw] arn
|
@@ -13120,18 +14401,63 @@ module Aws::QuickSight
|
|
13120
14401
|
include Aws::Structure
|
13121
14402
|
end
|
13122
14403
|
|
13123
|
-
#
|
14404
|
+
# An integer parameter for a dataset.
|
13124
14405
|
#
|
13125
|
-
# @!attribute [rw]
|
13126
|
-
#
|
13127
|
-
#
|
13128
|
-
# @return [Types::DynamicDefaultValue]
|
14406
|
+
# @!attribute [rw] id
|
14407
|
+
# An identifier for the integer parameter created in the dataset.
|
14408
|
+
# @return [String]
|
13129
14409
|
#
|
13130
|
-
# @!attribute [rw]
|
13131
|
-
# The
|
13132
|
-
# @return [
|
14410
|
+
# @!attribute [rw] name
|
14411
|
+
# The name of the integer parameter that is created in the dataset.
|
14412
|
+
# @return [String]
|
13133
14413
|
#
|
13134
|
-
#
|
14414
|
+
# @!attribute [rw] value_type
|
14415
|
+
# The value type of the dataset parameter. Valid values are `single
|
14416
|
+
# value` or `multi value`.
|
14417
|
+
# @return [String]
|
14418
|
+
#
|
14419
|
+
# @!attribute [rw] default_values
|
14420
|
+
# A list of default values for a given integer parameter. This
|
14421
|
+
# structure only accepts static values.
|
14422
|
+
# @return [Types::IntegerDatasetParameterDefaultValues]
|
14423
|
+
#
|
14424
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/IntegerDatasetParameter AWS API Documentation
|
14425
|
+
#
|
14426
|
+
class IntegerDatasetParameter < Struct.new(
|
14427
|
+
:id,
|
14428
|
+
:name,
|
14429
|
+
:value_type,
|
14430
|
+
:default_values)
|
14431
|
+
SENSITIVE = []
|
14432
|
+
include Aws::Structure
|
14433
|
+
end
|
14434
|
+
|
14435
|
+
# The default values of an integer parameter.
|
14436
|
+
#
|
14437
|
+
# @!attribute [rw] static_values
|
14438
|
+
# A list of static default values for a given integer parameter.
|
14439
|
+
# @return [Array<Integer>]
|
14440
|
+
#
|
14441
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/IntegerDatasetParameterDefaultValues AWS API Documentation
|
14442
|
+
#
|
14443
|
+
class IntegerDatasetParameterDefaultValues < Struct.new(
|
14444
|
+
:static_values)
|
14445
|
+
SENSITIVE = []
|
14446
|
+
include Aws::Structure
|
14447
|
+
end
|
14448
|
+
|
14449
|
+
# The default values of the `IntegerParameterDeclaration`.
|
14450
|
+
#
|
14451
|
+
# @!attribute [rw] dynamic_value
|
14452
|
+
# The dynamic value of the `IntegerDefaultValues`. Different defaults
|
14453
|
+
# are displayed according to users, groups, and values mapping.
|
14454
|
+
# @return [Types::DynamicDefaultValue]
|
14455
|
+
#
|
14456
|
+
# @!attribute [rw] static_values
|
14457
|
+
# The static values of the `IntegerDefaultValues`.
|
14458
|
+
# @return [Array<Integer>]
|
14459
|
+
#
|
14460
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/IntegerDefaultValues AWS API Documentation
|
13135
14461
|
#
|
13136
14462
|
class IntegerDefaultValues < Struct.new(
|
13137
14463
|
:dynamic_value,
|
@@ -13180,13 +14506,19 @@ module Aws::QuickSight
|
|
13180
14506
|
# A parameter declaration for the `Integer` data type.
|
13181
14507
|
# @return [Types::IntegerValueWhenUnsetConfiguration]
|
13182
14508
|
#
|
14509
|
+
# @!attribute [rw] mapped_data_set_parameters
|
14510
|
+
# A list of dataset parameters that are mapped to an analysis
|
14511
|
+
# parameter.
|
14512
|
+
# @return [Array<Types::MappedDataSetParameter>]
|
14513
|
+
#
|
13183
14514
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/IntegerParameterDeclaration AWS API Documentation
|
13184
14515
|
#
|
13185
14516
|
class IntegerParameterDeclaration < Struct.new(
|
13186
14517
|
:parameter_value_type,
|
13187
14518
|
:name,
|
13188
14519
|
:default_values,
|
13189
|
-
:value_when_unset
|
14520
|
+
:value_when_unset,
|
14521
|
+
:mapped_data_set_parameters)
|
13190
14522
|
SENSITIVE = []
|
13191
14523
|
include Aws::Structure
|
13192
14524
|
end
|
@@ -13200,9 +14532,9 @@ module Aws::QuickSight
|
|
13200
14532
|
# The built-in options for default values. The value can be one of the
|
13201
14533
|
# following:
|
13202
14534
|
#
|
13203
|
-
# * `RECOMMENDED
|
14535
|
+
# * `RECOMMENDED`: The recommended value.
|
13204
14536
|
#
|
13205
|
-
# * `NULL
|
14537
|
+
# * `NULL`: The `NULL` value.
|
13206
14538
|
# @return [String]
|
13207
14539
|
#
|
13208
14540
|
# @!attribute [rw] custom_value
|
@@ -13953,21 +15285,21 @@ module Aws::QuickSight
|
|
13953
15285
|
# @!attribute [rw] line_interpolation
|
13954
15286
|
# Interpolation style for line series.
|
13955
15287
|
#
|
13956
|
-
# * `LINEAR
|
15288
|
+
# * `LINEAR`: Show as default, linear style.
|
13957
15289
|
#
|
13958
|
-
# * `SMOOTH
|
15290
|
+
# * `SMOOTH`: Show as a smooth curve.
|
13959
15291
|
#
|
13960
|
-
# * `STEPPED
|
15292
|
+
# * `STEPPED`: Show steps in line.
|
13961
15293
|
# @return [String]
|
13962
15294
|
#
|
13963
15295
|
# @!attribute [rw] line_style
|
13964
15296
|
# Line style for line series.
|
13965
15297
|
#
|
13966
|
-
# * `SOLID
|
15298
|
+
# * `SOLID`: Show as a solid line.
|
13967
15299
|
#
|
13968
|
-
# * `DOTTED
|
15300
|
+
# * `DOTTED`: Show as a dotted line.
|
13969
15301
|
#
|
13970
|
-
# * `DASHED
|
15302
|
+
# * `DASHED`: Show as a dashed line.
|
13971
15303
|
# @return [String]
|
13972
15304
|
#
|
13973
15305
|
# @!attribute [rw] line_width
|
@@ -13995,15 +15327,15 @@ module Aws::QuickSight
|
|
13995
15327
|
# @!attribute [rw] marker_shape
|
13996
15328
|
# Shape option for markers in the series.
|
13997
15329
|
#
|
13998
|
-
# * `CIRCLE
|
15330
|
+
# * `CIRCLE`: Show marker as a circle.
|
13999
15331
|
#
|
14000
|
-
# * `TRIANGLE
|
15332
|
+
# * `TRIANGLE`: Show marker as a triangle.
|
14001
15333
|
#
|
14002
|
-
# * `SQUARE
|
15334
|
+
# * `SQUARE`: Show marker as a square.
|
14003
15335
|
#
|
14004
|
-
# * `DIAMOND
|
15336
|
+
# * `DIAMOND`: Show marker as a diamond.
|
14005
15337
|
#
|
14006
|
-
# * `ROUNDED_SQUARE
|
15338
|
+
# * `ROUNDED_SQUARE`: Show marker as a rounded square.
|
14007
15339
|
# @return [String]
|
14008
15340
|
#
|
14009
15341
|
# @!attribute [rw] marker_size
|
@@ -14956,6 +16288,45 @@ module Aws::QuickSight
|
|
14956
16288
|
include Aws::Structure
|
14957
16289
|
end
|
14958
16290
|
|
16291
|
+
# @!attribute [rw] aws_account_id
|
16292
|
+
# The Amazon Web Services account ID.
|
16293
|
+
# @return [String]
|
16294
|
+
#
|
16295
|
+
# @!attribute [rw] data_set_id
|
16296
|
+
# The ID of the dataset.
|
16297
|
+
# @return [String]
|
16298
|
+
#
|
16299
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListRefreshSchedulesRequest AWS API Documentation
|
16300
|
+
#
|
16301
|
+
class ListRefreshSchedulesRequest < Struct.new(
|
16302
|
+
:aws_account_id,
|
16303
|
+
:data_set_id)
|
16304
|
+
SENSITIVE = []
|
16305
|
+
include Aws::Structure
|
16306
|
+
end
|
16307
|
+
|
16308
|
+
# @!attribute [rw] refresh_schedules
|
16309
|
+
# The list of refresh schedules for the dataset.
|
16310
|
+
# @return [Array<Types::RefreshSchedule>]
|
16311
|
+
#
|
16312
|
+
# @!attribute [rw] status
|
16313
|
+
# The HTTP status of the request.
|
16314
|
+
# @return [Integer]
|
16315
|
+
#
|
16316
|
+
# @!attribute [rw] request_id
|
16317
|
+
# The Amazon Web Services request ID for this operation.
|
16318
|
+
# @return [String]
|
16319
|
+
#
|
16320
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListRefreshSchedulesResponse AWS API Documentation
|
16321
|
+
#
|
16322
|
+
class ListRefreshSchedulesResponse < Struct.new(
|
16323
|
+
:refresh_schedules,
|
16324
|
+
:status,
|
16325
|
+
:request_id)
|
16326
|
+
SENSITIVE = []
|
16327
|
+
include Aws::Structure
|
16328
|
+
end
|
16329
|
+
|
14959
16330
|
# @!attribute [rw] resource_arn
|
14960
16331
|
# The Amazon Resource Name (ARN) of the resource that you want a list
|
14961
16332
|
# of tags for.
|
@@ -15340,6 +16711,110 @@ module Aws::QuickSight
|
|
15340
16711
|
include Aws::Structure
|
15341
16712
|
end
|
15342
16713
|
|
16714
|
+
# @!attribute [rw] aws_account_id
|
16715
|
+
# The ID of the Amazon Web Services account that contains the topic
|
16716
|
+
# whose refresh schedule you want described.
|
16717
|
+
# @return [String]
|
16718
|
+
#
|
16719
|
+
# @!attribute [rw] topic_id
|
16720
|
+
# The ID for the topic that you want to describe. This ID is unique
|
16721
|
+
# per Amazon Web Services Region for each Amazon Web Services account.
|
16722
|
+
# @return [String]
|
16723
|
+
#
|
16724
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTopicRefreshSchedulesRequest AWS API Documentation
|
16725
|
+
#
|
16726
|
+
class ListTopicRefreshSchedulesRequest < Struct.new(
|
16727
|
+
:aws_account_id,
|
16728
|
+
:topic_id)
|
16729
|
+
SENSITIVE = []
|
16730
|
+
include Aws::Structure
|
16731
|
+
end
|
16732
|
+
|
16733
|
+
# @!attribute [rw] topic_id
|
16734
|
+
# The ID for the topic that you want to describe. This ID is unique
|
16735
|
+
# per Amazon Web Services Region for each Amazon Web Services account.
|
16736
|
+
# @return [String]
|
16737
|
+
#
|
16738
|
+
# @!attribute [rw] topic_arn
|
16739
|
+
# The Amazon Resource Name (ARN) of the topic.
|
16740
|
+
# @return [String]
|
16741
|
+
#
|
16742
|
+
# @!attribute [rw] refresh_schedules
|
16743
|
+
# The list of topic refresh schedules.
|
16744
|
+
# @return [Array<Types::TopicRefreshScheduleSummary>]
|
16745
|
+
#
|
16746
|
+
# @!attribute [rw] status
|
16747
|
+
# The HTTP status of the request.
|
16748
|
+
# @return [Integer]
|
16749
|
+
#
|
16750
|
+
# @!attribute [rw] request_id
|
16751
|
+
# The Amazon Web Services request ID for this operation.
|
16752
|
+
# @return [String]
|
16753
|
+
#
|
16754
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTopicRefreshSchedulesResponse AWS API Documentation
|
16755
|
+
#
|
16756
|
+
class ListTopicRefreshSchedulesResponse < Struct.new(
|
16757
|
+
:topic_id,
|
16758
|
+
:topic_arn,
|
16759
|
+
:refresh_schedules,
|
16760
|
+
:status,
|
16761
|
+
:request_id)
|
16762
|
+
SENSITIVE = []
|
16763
|
+
include Aws::Structure
|
16764
|
+
end
|
16765
|
+
|
16766
|
+
# @!attribute [rw] aws_account_id
|
16767
|
+
# The ID of the Amazon Web Services account that contains the topics
|
16768
|
+
# that you want to list.
|
16769
|
+
# @return [String]
|
16770
|
+
#
|
16771
|
+
# @!attribute [rw] next_token
|
16772
|
+
# The token for the next set of results, or null if there are no more
|
16773
|
+
# results.
|
16774
|
+
# @return [String]
|
16775
|
+
#
|
16776
|
+
# @!attribute [rw] max_results
|
16777
|
+
# The maximum number of results to be returned per request.
|
16778
|
+
# @return [Integer]
|
16779
|
+
#
|
16780
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTopicsRequest AWS API Documentation
|
16781
|
+
#
|
16782
|
+
class ListTopicsRequest < Struct.new(
|
16783
|
+
:aws_account_id,
|
16784
|
+
:next_token,
|
16785
|
+
:max_results)
|
16786
|
+
SENSITIVE = []
|
16787
|
+
include Aws::Structure
|
16788
|
+
end
|
16789
|
+
|
16790
|
+
# @!attribute [rw] topics_summaries
|
16791
|
+
# A list of topic summaries.
|
16792
|
+
# @return [Array<Types::TopicSummary>]
|
16793
|
+
#
|
16794
|
+
# @!attribute [rw] next_token
|
16795
|
+
# The token for the next set of results, or null if there are no more
|
16796
|
+
# results.
|
16797
|
+
# @return [String]
|
16798
|
+
#
|
16799
|
+
# @!attribute [rw] request_id
|
16800
|
+
# The Amazon Web Services request ID for this operation.
|
16801
|
+
# @return [String]
|
16802
|
+
#
|
16803
|
+
# @!attribute [rw] status
|
16804
|
+
# The HTTP status of the request.
|
16805
|
+
# @return [Integer]
|
16806
|
+
#
|
16807
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTopicsResponse AWS API Documentation
|
16808
|
+
#
|
16809
|
+
class ListTopicsResponse < Struct.new(
|
16810
|
+
:topics_summaries,
|
16811
|
+
:next_token,
|
16812
|
+
:request_id,
|
16813
|
+
:status)
|
16814
|
+
SENSITIVE = []
|
16815
|
+
include Aws::Structure
|
16816
|
+
end
|
16817
|
+
|
15343
16818
|
# @!attribute [rw] user_name
|
15344
16819
|
# The Amazon QuickSight user name that you want to list group
|
15345
16820
|
# memberships for.
|
@@ -15458,6 +16933,59 @@ module Aws::QuickSight
|
|
15458
16933
|
include Aws::Structure
|
15459
16934
|
end
|
15460
16935
|
|
16936
|
+
# @!attribute [rw] aws_account_id
|
16937
|
+
# The Amazon Web Services account ID of the account that contains the
|
16938
|
+
# VPC connections that you want to list.
|
16939
|
+
# @return [String]
|
16940
|
+
#
|
16941
|
+
# @!attribute [rw] next_token
|
16942
|
+
# The token for the next set of results, or null if there are no more
|
16943
|
+
# results.
|
16944
|
+
# @return [String]
|
16945
|
+
#
|
16946
|
+
# @!attribute [rw] max_results
|
16947
|
+
# The maximum number of results to be returned per request.
|
16948
|
+
# @return [Integer]
|
16949
|
+
#
|
16950
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListVPCConnectionsRequest AWS API Documentation
|
16951
|
+
#
|
16952
|
+
class ListVPCConnectionsRequest < Struct.new(
|
16953
|
+
:aws_account_id,
|
16954
|
+
:next_token,
|
16955
|
+
:max_results)
|
16956
|
+
SENSITIVE = []
|
16957
|
+
include Aws::Structure
|
16958
|
+
end
|
16959
|
+
|
16960
|
+
# @!attribute [rw] vpc_connection_summaries
|
16961
|
+
# A `VPCConnectionSummaries` object that returns a summary of VPC
|
16962
|
+
# connection objects.
|
16963
|
+
# @return [Array<Types::VPCConnectionSummary>]
|
16964
|
+
#
|
16965
|
+
# @!attribute [rw] next_token
|
16966
|
+
# The token for the next set of results, or null if there are no more
|
16967
|
+
# results.
|
16968
|
+
# @return [String]
|
16969
|
+
#
|
16970
|
+
# @!attribute [rw] request_id
|
16971
|
+
# The Amazon Web Services request ID for this operation.
|
16972
|
+
# @return [String]
|
16973
|
+
#
|
16974
|
+
# @!attribute [rw] status
|
16975
|
+
# The HTTP status of the request.
|
16976
|
+
# @return [Integer]
|
16977
|
+
#
|
16978
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListVPCConnectionsResponse AWS API Documentation
|
16979
|
+
#
|
16980
|
+
class ListVPCConnectionsResponse < Struct.new(
|
16981
|
+
:vpc_connection_summaries,
|
16982
|
+
:next_token,
|
16983
|
+
:request_id,
|
16984
|
+
:status)
|
16985
|
+
SENSITIVE = []
|
16986
|
+
include Aws::Structure
|
16987
|
+
end
|
16988
|
+
|
15461
16989
|
# The configuration of loading animation in free-form layout.
|
15462
16990
|
#
|
15463
16991
|
# @!attribute [rw] visibility
|
@@ -15564,6 +17092,31 @@ module Aws::QuickSight
|
|
15564
17092
|
include Aws::Structure
|
15565
17093
|
end
|
15566
17094
|
|
17095
|
+
# The lookback window setup of an incremental refresh configuration.
|
17096
|
+
#
|
17097
|
+
# @!attribute [rw] column_name
|
17098
|
+
# The name of the lookback window column.
|
17099
|
+
# @return [String]
|
17100
|
+
#
|
17101
|
+
# @!attribute [rw] size
|
17102
|
+
# The lookback window column size.
|
17103
|
+
# @return [Integer]
|
17104
|
+
#
|
17105
|
+
# @!attribute [rw] size_unit
|
17106
|
+
# The size unit that is used for the lookback window column. Valid
|
17107
|
+
# values for this structure are `HOUR`, `DAY`, and `WEEK`.
|
17108
|
+
# @return [String]
|
17109
|
+
#
|
17110
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/LookbackWindow AWS API Documentation
|
17111
|
+
#
|
17112
|
+
class LookbackWindow < Struct.new(
|
17113
|
+
:column_name,
|
17114
|
+
:size,
|
17115
|
+
:size_unit)
|
17116
|
+
SENSITIVE = []
|
17117
|
+
include Aws::Structure
|
17118
|
+
end
|
17119
|
+
|
15567
17120
|
# Amazon S3 manifest file location.
|
15568
17121
|
#
|
15569
17122
|
# @!attribute [rw] bucket
|
@@ -15583,6 +17136,26 @@ module Aws::QuickSight
|
|
15583
17136
|
include Aws::Structure
|
15584
17137
|
end
|
15585
17138
|
|
17139
|
+
# A dataset parameter that is mapped to an analysis parameter.
|
17140
|
+
#
|
17141
|
+
# @!attribute [rw] data_set_identifier
|
17142
|
+
# A unique name that identifies a dataset within the analysis or
|
17143
|
+
# dashboard.
|
17144
|
+
# @return [String]
|
17145
|
+
#
|
17146
|
+
# @!attribute [rw] data_set_parameter_name
|
17147
|
+
# The name of the dataset parameter.
|
17148
|
+
# @return [String]
|
17149
|
+
#
|
17150
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/MappedDataSetParameter AWS API Documentation
|
17151
|
+
#
|
17152
|
+
class MappedDataSetParameter < Struct.new(
|
17153
|
+
:data_set_identifier,
|
17154
|
+
:data_set_parameter_name)
|
17155
|
+
SENSITIVE = []
|
17156
|
+
include Aws::Structure
|
17157
|
+
end
|
17158
|
+
|
15586
17159
|
# The display options for margins around the outside edge of sheets.
|
15587
17160
|
#
|
15588
17161
|
# @!attribute [rw] show
|
@@ -15777,12 +17350,12 @@ module Aws::QuickSight
|
|
15777
17350
|
# The treatment option that determines how missing data should be
|
15778
17351
|
# rendered. Choose from the following options:
|
15779
17352
|
#
|
15780
|
-
# * `INTERPOLATE
|
17353
|
+
# * `INTERPOLATE`: Interpolate missing values between the prior and
|
15781
17354
|
# the next known value.
|
15782
17355
|
#
|
15783
|
-
# * `SHOW_AS_ZERO
|
17356
|
+
# * `SHOW_AS_ZERO`: Show missing values as the value `0`.
|
15784
17357
|
#
|
15785
|
-
# * `SHOW_AS_BLANK
|
17358
|
+
# * `SHOW_AS_BLANK`: Display a blank space when rendering missing
|
15786
17359
|
# data.
|
15787
17360
|
# @return [String]
|
15788
17361
|
#
|
@@ -15818,6 +17391,64 @@ module Aws::QuickSight
|
|
15818
17391
|
include Aws::Structure
|
15819
17392
|
end
|
15820
17393
|
|
17394
|
+
# A structure that represents a named entity.
|
17395
|
+
#
|
17396
|
+
# @!attribute [rw] field_name
|
17397
|
+
# The name of the entity.
|
17398
|
+
# @return [String]
|
17399
|
+
#
|
17400
|
+
# @!attribute [rw] property_name
|
17401
|
+
# The property name to be used for the named entity.
|
17402
|
+
# @return [String]
|
17403
|
+
#
|
17404
|
+
# @!attribute [rw] property_role
|
17405
|
+
# The property role. Valid values for this structure are `PRIMARY` and
|
17406
|
+
# `ID`.
|
17407
|
+
# @return [String]
|
17408
|
+
#
|
17409
|
+
# @!attribute [rw] property_usage
|
17410
|
+
# The property usage. Valid values for this structure are `INHERIT`,
|
17411
|
+
# `DIMENSION`, and `MEASURE`.
|
17412
|
+
# @return [String]
|
17413
|
+
#
|
17414
|
+
# @!attribute [rw] metric
|
17415
|
+
# The definition of a metric.
|
17416
|
+
# @return [Types::NamedEntityDefinitionMetric]
|
17417
|
+
#
|
17418
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/NamedEntityDefinition AWS API Documentation
|
17419
|
+
#
|
17420
|
+
class NamedEntityDefinition < Struct.new(
|
17421
|
+
:field_name,
|
17422
|
+
:property_name,
|
17423
|
+
:property_role,
|
17424
|
+
:property_usage,
|
17425
|
+
:metric)
|
17426
|
+
SENSITIVE = []
|
17427
|
+
include Aws::Structure
|
17428
|
+
end
|
17429
|
+
|
17430
|
+
# A structure that represents a metric.
|
17431
|
+
#
|
17432
|
+
# @!attribute [rw] aggregation
|
17433
|
+
# The aggregation of a named entity. Valid values for this structure
|
17434
|
+
# are `SUM`, `MIN`, `MAX`, `COUNT`, `AVERAGE`, `DISTINCT_COUNT`,
|
17435
|
+
# `STDEV`, `STDEVP`, `VAR`, `VARP`, `PERCENTILE`, `MEDIAN`, and
|
17436
|
+
# `CUSTOM`.
|
17437
|
+
# @return [String]
|
17438
|
+
#
|
17439
|
+
# @!attribute [rw] aggregation_function_parameters
|
17440
|
+
# The additional parameters for an aggregation function.
|
17441
|
+
# @return [Hash<String,String>]
|
17442
|
+
#
|
17443
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/NamedEntityDefinitionMetric AWS API Documentation
|
17444
|
+
#
|
17445
|
+
class NamedEntityDefinitionMetric < Struct.new(
|
17446
|
+
:aggregation,
|
17447
|
+
:aggregation_function_parameters)
|
17448
|
+
SENSITIVE = []
|
17449
|
+
include Aws::Structure
|
17450
|
+
end
|
17451
|
+
|
15821
17452
|
# Errors that occur during namespace creation.
|
15822
17453
|
#
|
15823
17454
|
# @!attribute [rw] type
|
@@ -15877,6 +17508,25 @@ module Aws::QuickSight
|
|
15877
17508
|
include Aws::Structure
|
15878
17509
|
end
|
15879
17510
|
|
17511
|
+
# A structure that represents a negative format.
|
17512
|
+
#
|
17513
|
+
# @!attribute [rw] prefix
|
17514
|
+
# The prefix for a negative format.
|
17515
|
+
# @return [String]
|
17516
|
+
#
|
17517
|
+
# @!attribute [rw] suffix
|
17518
|
+
# The suffix for a negative format.
|
17519
|
+
# @return [String]
|
17520
|
+
#
|
17521
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/NegativeFormat AWS API Documentation
|
17522
|
+
#
|
17523
|
+
class NegativeFormat < Struct.new(
|
17524
|
+
:prefix,
|
17525
|
+
:suffix)
|
17526
|
+
SENSITIVE = []
|
17527
|
+
include Aws::Structure
|
17528
|
+
end
|
17529
|
+
|
15880
17530
|
# The options that determine the negative value configuration.
|
15881
17531
|
#
|
15882
17532
|
# @!attribute [rw] display_mode
|
@@ -15891,17 +17541,81 @@ module Aws::QuickSight
|
|
15891
17541
|
include Aws::Structure
|
15892
17542
|
end
|
15893
17543
|
|
15894
|
-
# The
|
17544
|
+
# The structure that contains information about a network interface.
|
15895
17545
|
#
|
15896
|
-
# @!attribute [rw]
|
15897
|
-
#
|
17546
|
+
# @!attribute [rw] subnet_id
|
17547
|
+
# The subnet ID associated with the network interface.
|
15898
17548
|
# @return [String]
|
15899
17549
|
#
|
15900
|
-
#
|
17550
|
+
# @!attribute [rw] availability_zone
|
17551
|
+
# The availability zone that the network interface resides in.
|
17552
|
+
# @return [String]
|
15901
17553
|
#
|
15902
|
-
|
15903
|
-
|
15904
|
-
|
17554
|
+
# @!attribute [rw] error_message
|
17555
|
+
# An error message.
|
17556
|
+
# @return [String]
|
17557
|
+
#
|
17558
|
+
# @!attribute [rw] status
|
17559
|
+
# The status of the network interface.
|
17560
|
+
# @return [String]
|
17561
|
+
#
|
17562
|
+
# @!attribute [rw] network_interface_id
|
17563
|
+
# The network interface ID.
|
17564
|
+
# @return [String]
|
17565
|
+
#
|
17566
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/NetworkInterface AWS API Documentation
|
17567
|
+
#
|
17568
|
+
class NetworkInterface < Struct.new(
|
17569
|
+
:subnet_id,
|
17570
|
+
:availability_zone,
|
17571
|
+
:error_message,
|
17572
|
+
:status,
|
17573
|
+
:network_interface_id)
|
17574
|
+
SENSITIVE = []
|
17575
|
+
include Aws::Structure
|
17576
|
+
end
|
17577
|
+
|
17578
|
+
# The configuration that overrides the existing default values for a
|
17579
|
+
# dataset parameter that is inherited from another dataset.
|
17580
|
+
#
|
17581
|
+
# @!attribute [rw] string_static_values
|
17582
|
+
# A list of static default values for a given string parameter.
|
17583
|
+
# @return [Array<String>]
|
17584
|
+
#
|
17585
|
+
# @!attribute [rw] decimal_static_values
|
17586
|
+
# A list of static default values for a given decimal parameter.
|
17587
|
+
# @return [Array<Float>]
|
17588
|
+
#
|
17589
|
+
# @!attribute [rw] date_time_static_values
|
17590
|
+
# A list of static default values for a given date time parameter.
|
17591
|
+
# @return [Array<Time>]
|
17592
|
+
#
|
17593
|
+
# @!attribute [rw] integer_static_values
|
17594
|
+
# A list of static default values for a given integer parameter.
|
17595
|
+
# @return [Array<Integer>]
|
17596
|
+
#
|
17597
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/NewDefaultValues AWS API Documentation
|
17598
|
+
#
|
17599
|
+
class NewDefaultValues < Struct.new(
|
17600
|
+
:string_static_values,
|
17601
|
+
:decimal_static_values,
|
17602
|
+
:date_time_static_values,
|
17603
|
+
:integer_static_values)
|
17604
|
+
SENSITIVE = []
|
17605
|
+
include Aws::Structure
|
17606
|
+
end
|
17607
|
+
|
17608
|
+
# The options that determine the null value format configuration.
|
17609
|
+
#
|
17610
|
+
# @!attribute [rw] null_string
|
17611
|
+
# Determines the null string of null values.
|
17612
|
+
# @return [String]
|
17613
|
+
#
|
17614
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/NullValueFormatConfiguration AWS API Documentation
|
17615
|
+
#
|
17616
|
+
class NullValueFormatConfiguration < Struct.new(
|
17617
|
+
:null_string)
|
17618
|
+
SENSITIVE = [:null_string]
|
15905
17619
|
include Aws::Structure
|
15906
17620
|
end
|
15907
17621
|
|
@@ -16043,11 +17757,11 @@ module Aws::QuickSight
|
|
16043
17757
|
# This option determines how null values should be treated when
|
16044
17758
|
# filtering data.
|
16045
17759
|
#
|
16046
|
-
# * `ALL_VALUES
|
17760
|
+
# * `ALL_VALUES`: Include null values in filtered results.
|
16047
17761
|
#
|
16048
|
-
# * `NULLS_ONLY
|
17762
|
+
# * `NULLS_ONLY`: Only include null values in filtered results.
|
16049
17763
|
#
|
16050
|
-
# * `NON_NULLS_ONLY
|
17764
|
+
# * `NON_NULLS_ONLY`: Exclude null values from filtered results.
|
16051
17765
|
# @return [String]
|
16052
17766
|
#
|
16053
17767
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/NumericEqualityFilter AWS API Documentation
|
@@ -16140,11 +17854,11 @@ module Aws::QuickSight
|
|
16140
17854
|
# This option determines how null values should be treated when
|
16141
17855
|
# filtering data.
|
16142
17856
|
#
|
16143
|
-
# * `ALL_VALUES
|
17857
|
+
# * `ALL_VALUES`: Include null values in filtered results.
|
16144
17858
|
#
|
16145
|
-
# * `NULLS_ONLY
|
17859
|
+
# * `NULLS_ONLY`: Only include null values in filtered results.
|
16146
17860
|
#
|
16147
|
-
# * `NON_NULLS_ONLY
|
17861
|
+
# * `NON_NULLS_ONLY`: Exclude null values from filtered results.
|
16148
17862
|
# @return [String]
|
16149
17863
|
#
|
16150
17864
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/NumericRangeFilter AWS API Documentation
|
@@ -16206,29 +17920,29 @@ module Aws::QuickSight
|
|
16206
17920
|
# @!attribute [rw] simple_numerical_aggregation
|
16207
17921
|
# Built-in aggregation functions for numerical values.
|
16208
17922
|
#
|
16209
|
-
# * `SUM
|
17923
|
+
# * `SUM`: The sum of a dimension or measure.
|
16210
17924
|
#
|
16211
|
-
# * `AVERAGE
|
17925
|
+
# * `AVERAGE`: The average of a dimension or measure.
|
16212
17926
|
#
|
16213
|
-
# * `MIN
|
17927
|
+
# * `MIN`: The minimum value of a dimension or measure.
|
16214
17928
|
#
|
16215
|
-
# * `MAX
|
17929
|
+
# * `MAX`: The maximum value of a dimension or measure.
|
16216
17930
|
#
|
16217
|
-
# * `COUNT
|
17931
|
+
# * `COUNT`: The count of a dimension or measure.
|
16218
17932
|
#
|
16219
|
-
# * `DISTINCT_COUNT
|
17933
|
+
# * `DISTINCT_COUNT`: The count of distinct values in a dimension or
|
16220
17934
|
# measure.
|
16221
17935
|
#
|
16222
|
-
# * `VAR
|
17936
|
+
# * `VAR`: The variance of a dimension or measure.
|
16223
17937
|
#
|
16224
|
-
# * `VARP
|
17938
|
+
# * `VARP`: The partitioned variance of a dimension or measure.
|
16225
17939
|
#
|
16226
|
-
# * `STDEV
|
17940
|
+
# * `STDEV`: The standard deviation of a dimension or measure.
|
16227
17941
|
#
|
16228
|
-
# * `STDEVP
|
17942
|
+
# * `STDEVP`: The partitioned standard deviation of a dimension or
|
16229
17943
|
# measure.
|
16230
17944
|
#
|
16231
|
-
# * `MEDIAN
|
17945
|
+
# * `MEDIAN`: The median value of a dimension or measure.
|
16232
17946
|
# @return [String]
|
16233
17947
|
#
|
16234
17948
|
# @!attribute [rw] percentile_aggregation
|
@@ -16310,11 +18024,11 @@ module Aws::QuickSight
|
|
16310
18024
|
# @return [String]
|
16311
18025
|
#
|
16312
18026
|
# @!attribute [rw] port
|
16313
|
-
#
|
18027
|
+
# The port.
|
16314
18028
|
# @return [Integer]
|
16315
18029
|
#
|
16316
18030
|
# @!attribute [rw] database
|
16317
|
-
#
|
18031
|
+
# The database.
|
16318
18032
|
# @return [String]
|
16319
18033
|
#
|
16320
18034
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/OracleParameters AWS API Documentation
|
@@ -16338,7 +18052,7 @@ module Aws::QuickSight
|
|
16338
18052
|
# @return [String]
|
16339
18053
|
#
|
16340
18054
|
# @!attribute [rw] type
|
16341
|
-
#
|
18055
|
+
# The type.
|
16342
18056
|
# @return [String]
|
16343
18057
|
#
|
16344
18058
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/OutputColumn AWS API Documentation
|
@@ -16351,6 +18065,31 @@ module Aws::QuickSight
|
|
16351
18065
|
include Aws::Structure
|
16352
18066
|
end
|
16353
18067
|
|
18068
|
+
# A transform operation that overrides the dataset parameter values that
|
18069
|
+
# are defined in another dataset.
|
18070
|
+
#
|
18071
|
+
# @!attribute [rw] parameter_name
|
18072
|
+
# The name of the parameter to be overridden with different values.
|
18073
|
+
# @return [String]
|
18074
|
+
#
|
18075
|
+
# @!attribute [rw] new_parameter_name
|
18076
|
+
# The new name for the parameter.
|
18077
|
+
# @return [String]
|
18078
|
+
#
|
18079
|
+
# @!attribute [rw] new_default_values
|
18080
|
+
# The new default values for the parameter.
|
18081
|
+
# @return [Types::NewDefaultValues]
|
18082
|
+
#
|
18083
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/OverrideDatasetParameterOperation AWS API Documentation
|
18084
|
+
#
|
18085
|
+
class OverrideDatasetParameterOperation < Struct.new(
|
18086
|
+
:parameter_name,
|
18087
|
+
:new_parameter_name,
|
18088
|
+
:new_default_values)
|
18089
|
+
SENSITIVE = []
|
18090
|
+
include Aws::Structure
|
18091
|
+
end
|
18092
|
+
|
16354
18093
|
# The pagination configuration for a table visual or boxplot.
|
16355
18094
|
#
|
16356
18095
|
# @!attribute [rw] page_size
|
@@ -17807,6 +19546,45 @@ module Aws::QuickSight
|
|
17807
19546
|
include Aws::Structure
|
17808
19547
|
end
|
17809
19548
|
|
19549
|
+
# @!attribute [rw] aws_account_id
|
19550
|
+
# The Amazon Web Services account ID.
|
19551
|
+
# @return [String]
|
19552
|
+
#
|
19553
|
+
# @!attribute [rw] data_set_id
|
19554
|
+
# The ID of the dataset.
|
19555
|
+
# @return [String]
|
19556
|
+
#
|
19557
|
+
# @!attribute [rw] data_set_refresh_properties
|
19558
|
+
# The dataset refresh properties.
|
19559
|
+
# @return [Types::DataSetRefreshProperties]
|
19560
|
+
#
|
19561
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/PutDataSetRefreshPropertiesRequest AWS API Documentation
|
19562
|
+
#
|
19563
|
+
class PutDataSetRefreshPropertiesRequest < Struct.new(
|
19564
|
+
:aws_account_id,
|
19565
|
+
:data_set_id,
|
19566
|
+
:data_set_refresh_properties)
|
19567
|
+
SENSITIVE = []
|
19568
|
+
include Aws::Structure
|
19569
|
+
end
|
19570
|
+
|
19571
|
+
# @!attribute [rw] request_id
|
19572
|
+
# The Amazon Web Services request ID for this operation.
|
19573
|
+
# @return [String]
|
19574
|
+
#
|
19575
|
+
# @!attribute [rw] status
|
19576
|
+
# The HTTP status of the request.
|
19577
|
+
# @return [Integer]
|
19578
|
+
#
|
19579
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/PutDataSetRefreshPropertiesResponse AWS API Documentation
|
19580
|
+
#
|
19581
|
+
class PutDataSetRefreshPropertiesResponse < Struct.new(
|
19582
|
+
:request_id,
|
19583
|
+
:status)
|
19584
|
+
SENSITIVE = []
|
19585
|
+
include Aws::Structure
|
19586
|
+
end
|
19587
|
+
|
17810
19588
|
# Information about a queued dataset SPICE ingestion.
|
17811
19589
|
#
|
17812
19590
|
# @!attribute [rw] waiting_on_ingestion
|
@@ -18066,6 +19844,25 @@ module Aws::QuickSight
|
|
18066
19844
|
include Aws::Structure
|
18067
19845
|
end
|
18068
19846
|
|
19847
|
+
# A structure that represents a range constant.
|
19848
|
+
#
|
19849
|
+
# @!attribute [rw] minimum
|
19850
|
+
# The minimum value for a range constant.
|
19851
|
+
# @return [String]
|
19852
|
+
#
|
19853
|
+
# @!attribute [rw] maximum
|
19854
|
+
# The maximum value for a range constant.
|
19855
|
+
# @return [String]
|
19856
|
+
#
|
19857
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RangeConstant AWS API Documentation
|
19858
|
+
#
|
19859
|
+
class RangeConstant < Struct.new(
|
19860
|
+
:minimum,
|
19861
|
+
:maximum)
|
19862
|
+
SENSITIVE = []
|
19863
|
+
include Aws::Structure
|
19864
|
+
end
|
19865
|
+
|
18069
19866
|
# The range ends label type of a data path label.
|
18070
19867
|
#
|
18071
19868
|
# @!attribute [rw] visibility
|
@@ -18349,14 +20146,127 @@ module Aws::QuickSight
|
|
18349
20146
|
include Aws::Structure
|
18350
20147
|
end
|
18351
20148
|
|
20149
|
+
# The refresh configuration of a dataset.
|
20150
|
+
#
|
20151
|
+
# @!attribute [rw] incremental_refresh
|
20152
|
+
# The incremental refresh for the dataset.
|
20153
|
+
# @return [Types::IncrementalRefresh]
|
20154
|
+
#
|
20155
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RefreshConfiguration AWS API Documentation
|
20156
|
+
#
|
20157
|
+
class RefreshConfiguration < Struct.new(
|
20158
|
+
:incremental_refresh)
|
20159
|
+
SENSITIVE = []
|
20160
|
+
include Aws::Structure
|
20161
|
+
end
|
20162
|
+
|
20163
|
+
# Specifies the interval between each scheduled refresh of a dataset.
|
20164
|
+
#
|
20165
|
+
# @!attribute [rw] interval
|
20166
|
+
# The interval between scheduled refreshes. Valid values are as
|
20167
|
+
# follows:
|
20168
|
+
#
|
20169
|
+
# * `MINUTE15`: The dataset refreshes every 15 minutes. This value is
|
20170
|
+
# only supported for incremental refreshes. This interval can only
|
20171
|
+
# be used for one schedule per dataset.
|
20172
|
+
#
|
20173
|
+
# * `MINUTE30`:The dataset refreshes every 30 minutes. This value is
|
20174
|
+
# only supported for incremental refreshes. This interval can only
|
20175
|
+
# be used for one schedule per dataset.
|
20176
|
+
#
|
20177
|
+
# * `HOURLY`: The dataset refreshes every hour. This interval can only
|
20178
|
+
# be used for one schedule per dataset.
|
20179
|
+
#
|
20180
|
+
# * `DAILY`: The dataset refreshes every day.
|
20181
|
+
#
|
20182
|
+
# * `WEEKLY`: The dataset refreshes every week.
|
20183
|
+
#
|
20184
|
+
# * `MONTHLY`: The dataset refreshes every month.
|
20185
|
+
# @return [String]
|
20186
|
+
#
|
20187
|
+
# @!attribute [rw] refresh_on_day
|
20188
|
+
# The day of the week that you want to schedule the refresh on. This
|
20189
|
+
# value is required for weekly and monthly refresh intervals.
|
20190
|
+
# @return [Types::ScheduleRefreshOnEntity]
|
20191
|
+
#
|
20192
|
+
# @!attribute [rw] timezone
|
20193
|
+
# The timezone that you want the refresh schedule to use. The timezone
|
20194
|
+
# ID must match a corresponding ID found on
|
20195
|
+
# `java.util.time.getAvailableIDs()`.
|
20196
|
+
# @return [String]
|
20197
|
+
#
|
20198
|
+
# @!attribute [rw] time_of_the_day
|
20199
|
+
# The time of day that you want the datset to refresh. This value is
|
20200
|
+
# expressed in HH:MM format. This field is not required for schedules
|
20201
|
+
# that refresh hourly.
|
20202
|
+
# @return [String]
|
20203
|
+
#
|
20204
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RefreshFrequency AWS API Documentation
|
20205
|
+
#
|
20206
|
+
class RefreshFrequency < Struct.new(
|
20207
|
+
:interval,
|
20208
|
+
:refresh_on_day,
|
20209
|
+
:timezone,
|
20210
|
+
:time_of_the_day)
|
20211
|
+
SENSITIVE = []
|
20212
|
+
include Aws::Structure
|
20213
|
+
end
|
20214
|
+
|
20215
|
+
# The refresh schedule of a dataset.
|
20216
|
+
#
|
20217
|
+
# @!attribute [rw] schedule_id
|
20218
|
+
# An identifier for the refresh schedule.
|
20219
|
+
# @return [String]
|
20220
|
+
#
|
20221
|
+
# @!attribute [rw] schedule_frequency
|
20222
|
+
# The frequency for the refresh schedule.
|
20223
|
+
# @return [Types::RefreshFrequency]
|
20224
|
+
#
|
20225
|
+
# @!attribute [rw] start_after_date_time
|
20226
|
+
# Time after which the refresh schedule can be started, expressed in
|
20227
|
+
# `YYYY-MM-DDTHH:MM:SS` format.
|
20228
|
+
# @return [Time]
|
20229
|
+
#
|
20230
|
+
# @!attribute [rw] refresh_type
|
20231
|
+
# The type of refresh that a datset undergoes. Valid values are as
|
20232
|
+
# follows:
|
20233
|
+
#
|
20234
|
+
# * `FULL_REFRESH`: A complete refresh of a dataset.
|
20235
|
+
#
|
20236
|
+
# * `INCREMENTAL_REFRESH`: A partial refresh of some rows of a
|
20237
|
+
# dataset, based on the time window specified.
|
20238
|
+
#
|
20239
|
+
# For more information on full and incremental refreshes, see
|
20240
|
+
# [Refreshing SPICE data][1] in the *Amazon QuickSight User Guide*.
|
20241
|
+
#
|
20242
|
+
#
|
20243
|
+
#
|
20244
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/refreshing-imported-data.html
|
20245
|
+
# @return [String]
|
20246
|
+
#
|
20247
|
+
# @!attribute [rw] arn
|
20248
|
+
# The Amazon Resource Name (ARN) for the refresh schedule.
|
20249
|
+
# @return [String]
|
20250
|
+
#
|
20251
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RefreshSchedule AWS API Documentation
|
20252
|
+
#
|
20253
|
+
class RefreshSchedule < Struct.new(
|
20254
|
+
:schedule_id,
|
20255
|
+
:schedule_frequency,
|
20256
|
+
:start_after_date_time,
|
20257
|
+
:refresh_type,
|
20258
|
+
:arn)
|
20259
|
+
SENSITIVE = []
|
20260
|
+
include Aws::Structure
|
20261
|
+
end
|
20262
|
+
|
18352
20263
|
# @!attribute [rw] identity_type
|
18353
20264
|
# Amazon QuickSight supports several ways of managing the identity of
|
18354
20265
|
# users. This parameter accepts two values:
|
18355
20266
|
#
|
18356
|
-
# * `IAM
|
18357
|
-
# role.
|
20267
|
+
# * `IAM`: A user whose identity maps to an existing IAM user or role.
|
18358
20268
|
#
|
18359
|
-
# * `QUICKSIGHT
|
20269
|
+
# * `QUICKSIGHT`: A user whose identity is owned and managed
|
18360
20270
|
# internally by Amazon QuickSight.
|
18361
20271
|
# @return [String]
|
18362
20272
|
#
|
@@ -18368,19 +20278,17 @@ module Aws::QuickSight
|
|
18368
20278
|
# The Amazon QuickSight role for the user. The user role can be one of
|
18369
20279
|
# the following:
|
18370
20280
|
#
|
18371
|
-
# * `READER
|
20281
|
+
# * `READER`: A user who has read-only access to dashboards.
|
18372
20282
|
#
|
18373
|
-
# * `AUTHOR
|
20283
|
+
# * `AUTHOR`: A user who can create data sources, datasets, analyses,
|
18374
20284
|
# and dashboards.
|
18375
20285
|
#
|
18376
|
-
# * `ADMIN
|
20286
|
+
# * `ADMIN`: A user who is an author, who can also manage Amazon
|
18377
20287
|
# QuickSight settings.
|
18378
20288
|
#
|
18379
|
-
# * `RESTRICTED_READER
|
18380
|
-
# use.
|
20289
|
+
# * `RESTRICTED_READER`: This role isn't currently available for use.
|
18381
20290
|
#
|
18382
|
-
# * `RESTRICTED_AUTHOR
|
18383
|
-
# use.
|
20291
|
+
# * `RESTRICTED_AUTHOR`: This role isn't currently available for use.
|
18384
20292
|
# @return [String]
|
18385
20293
|
#
|
18386
20294
|
# @!attribute [rw] iam_arn
|
@@ -18455,13 +20363,13 @@ module Aws::QuickSight
|
|
18455
20363
|
# Identity and Access Management(IAM) role. The type of supported
|
18456
20364
|
# external login provider can be one of the following.
|
18457
20365
|
#
|
18458
|
-
# * `COGNITO
|
20366
|
+
# * `COGNITO`: Amazon Cognito. The provider URL is
|
18459
20367
|
# cognito-identity.amazonaws.com. When choosing the `COGNITO`
|
18460
20368
|
# provider type, don’t use the "CustomFederationProviderUrl"
|
18461
20369
|
# parameter which is only needed when the external provider is
|
18462
20370
|
# custom.
|
18463
20371
|
#
|
18464
|
-
# * `CUSTOM_OIDC
|
20372
|
+
# * `CUSTOM_OIDC`: Custom OpenID Connect (OIDC) provider. When
|
18465
20373
|
# choosing `CUSTOM_OIDC` type, use the `CustomFederationProviderUrl`
|
18466
20374
|
# parameter to provide the custom OIDC provider URL.
|
18467
20375
|
# @return [String]
|
@@ -18573,10 +20481,16 @@ module Aws::QuickSight
|
|
18573
20481
|
# The state persistence settings of an embedded dashboard.
|
18574
20482
|
# @return [Types::StatePersistenceConfigurations]
|
18575
20483
|
#
|
20484
|
+
# @!attribute [rw] bookmarks
|
20485
|
+
# The bookmarks configuration for an embedded dashboard in Amazon
|
20486
|
+
# QuickSight.
|
20487
|
+
# @return [Types::BookmarksConfigurations]
|
20488
|
+
#
|
18576
20489
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisteredUserDashboardFeatureConfigurations AWS API Documentation
|
18577
20490
|
#
|
18578
20491
|
class RegisteredUserDashboardFeatureConfigurations < Struct.new(
|
18579
|
-
:state_persistence
|
20492
|
+
:state_persistence,
|
20493
|
+
:bookmarks)
|
18580
20494
|
SENSITIVE = []
|
18581
20495
|
include Aws::Structure
|
18582
20496
|
end
|
@@ -18634,7 +20548,7 @@ module Aws::QuickSight
|
|
18634
20548
|
# the ` UpdateUser ` API operation. Use the ` RegisterUser ` API
|
18635
20549
|
# operation to add a new user with a custom permission profile
|
18636
20550
|
# attached. For more information, see the following sections in the
|
18637
|
-
# *Amazon QuickSight User Guide
|
20551
|
+
# *Amazon QuickSight User Guide*:
|
18638
20552
|
#
|
18639
20553
|
# * [Embedding the Full Functionality of the Amazon QuickSight Console
|
18640
20554
|
# for Authenticated Users][2]
|
@@ -18844,11 +20758,11 @@ module Aws::QuickSight
|
|
18844
20758
|
# This option determines how null values should be treated when
|
18845
20759
|
# filtering data.
|
18846
20760
|
#
|
18847
|
-
# * `ALL_VALUES
|
20761
|
+
# * `ALL_VALUES`: Include null values in filtered results.
|
18848
20762
|
#
|
18849
|
-
# * `NULLS_ONLY
|
20763
|
+
# * `NULLS_ONLY`: Only include null values in filtered results.
|
18850
20764
|
#
|
18851
|
-
# * `NON_NULLS_ONLY
|
20765
|
+
# * `NON_NULLS_ONLY`: Exclude null values from filtered results.
|
18852
20766
|
# @return [String]
|
18853
20767
|
#
|
18854
20768
|
# @!attribute [rw] exclude_period_configuration
|
@@ -19167,11 +21081,20 @@ module Aws::QuickSight
|
|
19167
21081
|
# names and columns that they are assigned to.
|
19168
21082
|
# @return [Array<Types::RowLevelPermissionTagRule>]
|
19169
21083
|
#
|
21084
|
+
# @!attribute [rw] tag_rule_configurations
|
21085
|
+
# A list of tag configuration rules to apply to a dataset. All tag
|
21086
|
+
# configurations have the OR condition. Tags within each tile will be
|
21087
|
+
# joined (AND). At least one rule in this structure must have all tag
|
21088
|
+
# values assigned to it to apply Row-level security (RLS) to the
|
21089
|
+
# dataset.
|
21090
|
+
# @return [Array<Array<String>>]
|
21091
|
+
#
|
19170
21092
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RowLevelPermissionTagConfiguration AWS API Documentation
|
19171
21093
|
#
|
19172
21094
|
class RowLevelPermissionTagConfiguration < Struct.new(
|
19173
21095
|
:status,
|
19174
|
-
:tag_rules
|
21096
|
+
:tag_rules,
|
21097
|
+
:tag_rule_configurations)
|
19175
21098
|
SENSITIVE = []
|
19176
21099
|
include Aws::Structure
|
19177
21100
|
end
|
@@ -19280,7 +21203,7 @@ module Aws::QuickSight
|
|
19280
21203
|
#
|
19281
21204
|
# Valid values are defined as follows:
|
19282
21205
|
#
|
19283
|
-
# * `ALL_VISUALS
|
21206
|
+
# * `ALL_VISUALS`: Applies the filter operation to all visuals in the
|
19284
21207
|
# same sheet.
|
19285
21208
|
#
|
19286
21209
|
# ^
|
@@ -19449,13 +21372,18 @@ module Aws::QuickSight
|
|
19449
21372
|
# The size field well of a scatter plot.
|
19450
21373
|
# @return [Array<Types::MeasureField>]
|
19451
21374
|
#
|
21375
|
+
# @!attribute [rw] label
|
21376
|
+
# The label field well of a scatter plot.
|
21377
|
+
# @return [Array<Types::DimensionField>]
|
21378
|
+
#
|
19452
21379
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ScatterPlotCategoricallyAggregatedFieldWells AWS API Documentation
|
19453
21380
|
#
|
19454
21381
|
class ScatterPlotCategoricallyAggregatedFieldWells < Struct.new(
|
19455
21382
|
:x_axis,
|
19456
21383
|
:y_axis,
|
19457
21384
|
:category,
|
19458
|
-
:size
|
21385
|
+
:size,
|
21386
|
+
:label)
|
19459
21387
|
SENSITIVE = []
|
19460
21388
|
include Aws::Structure
|
19461
21389
|
end
|
@@ -19524,16 +21452,14 @@ module Aws::QuickSight
|
|
19524
21452
|
# one of the attributes can be defined.
|
19525
21453
|
#
|
19526
21454
|
# @!attribute [rw] scatter_plot_categorically_aggregated_field_wells
|
19527
|
-
# The aggregated field wells of a scatter plot.
|
19528
|
-
#
|
19529
|
-
#
|
19530
|
-
# aggregated by category.
|
21455
|
+
# The aggregated field wells of a scatter plot. The x and y-axes of
|
21456
|
+
# scatter plots with aggregated field wells are aggregated by
|
21457
|
+
# category, label, or both.
|
19531
21458
|
# @return [Types::ScatterPlotCategoricallyAggregatedFieldWells]
|
19532
21459
|
#
|
19533
21460
|
# @!attribute [rw] scatter_plot_unaggregated_field_wells
|
19534
|
-
# The unaggregated field wells of a scatter plot.
|
19535
|
-
#
|
19536
|
-
# and y-axes of these scatter plots are unaggregated.
|
21461
|
+
# The unaggregated field wells of a scatter plot. The x and y-axes of
|
21462
|
+
# these scatter plots are unaggregated.
|
19537
21463
|
# @return [Types::ScatterPlotUnaggregatedFieldWells]
|
19538
21464
|
#
|
19539
21465
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ScatterPlotFieldWells AWS API Documentation
|
@@ -19563,12 +21489,22 @@ module Aws::QuickSight
|
|
19563
21489
|
# The size field well of a scatter plot.
|
19564
21490
|
# @return [Array<Types::MeasureField>]
|
19565
21491
|
#
|
21492
|
+
# @!attribute [rw] category
|
21493
|
+
# The category field well of a scatter plot.
|
21494
|
+
# @return [Array<Types::DimensionField>]
|
21495
|
+
#
|
21496
|
+
# @!attribute [rw] label
|
21497
|
+
# The label field well of a scatter plot.
|
21498
|
+
# @return [Array<Types::DimensionField>]
|
21499
|
+
#
|
19566
21500
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ScatterPlotUnaggregatedFieldWells AWS API Documentation
|
19567
21501
|
#
|
19568
21502
|
class ScatterPlotUnaggregatedFieldWells < Struct.new(
|
19569
21503
|
:x_axis,
|
19570
21504
|
:y_axis,
|
19571
|
-
:size
|
21505
|
+
:size,
|
21506
|
+
:category,
|
21507
|
+
:label)
|
19572
21508
|
SENSITIVE = []
|
19573
21509
|
include Aws::Structure
|
19574
21510
|
end
|
@@ -19622,6 +21558,25 @@ module Aws::QuickSight
|
|
19622
21558
|
include Aws::Structure
|
19623
21559
|
end
|
19624
21560
|
|
21561
|
+
# The refresh on entity for weekly or monthly schedules.
|
21562
|
+
#
|
21563
|
+
# @!attribute [rw] day_of_week
|
21564
|
+
# The day of the week that you want to schedule a refresh on.
|
21565
|
+
# @return [String]
|
21566
|
+
#
|
21567
|
+
# @!attribute [rw] day_of_month
|
21568
|
+
# The day of the month that you want to schedule refresh on.
|
21569
|
+
# @return [String]
|
21570
|
+
#
|
21571
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ScheduleRefreshOnEntity AWS API Documentation
|
21572
|
+
#
|
21573
|
+
class ScheduleRefreshOnEntity < Struct.new(
|
21574
|
+
:day_of_week,
|
21575
|
+
:day_of_month)
|
21576
|
+
SENSITIVE = []
|
21577
|
+
include Aws::Structure
|
21578
|
+
end
|
21579
|
+
|
19625
21580
|
# The visual display options for a data zoom scroll bar.
|
19626
21581
|
#
|
19627
21582
|
# @!attribute [rw] visibility
|
@@ -20167,6 +22122,74 @@ module Aws::QuickSight
|
|
20167
22122
|
include Aws::Structure
|
20168
22123
|
end
|
20169
22124
|
|
22125
|
+
# A structure that represents a semantic entity type.
|
22126
|
+
#
|
22127
|
+
# @!attribute [rw] type_name
|
22128
|
+
# The semantic entity type name.
|
22129
|
+
# @return [String]
|
22130
|
+
#
|
22131
|
+
# @!attribute [rw] sub_type_name
|
22132
|
+
# The semantic entity sub type name.
|
22133
|
+
# @return [String]
|
22134
|
+
#
|
22135
|
+
# @!attribute [rw] type_parameters
|
22136
|
+
# The semantic entity type parameters.
|
22137
|
+
# @return [Hash<String,String>]
|
22138
|
+
#
|
22139
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SemanticEntityType AWS API Documentation
|
22140
|
+
#
|
22141
|
+
class SemanticEntityType < Struct.new(
|
22142
|
+
:type_name,
|
22143
|
+
:sub_type_name,
|
22144
|
+
:type_parameters)
|
22145
|
+
SENSITIVE = []
|
22146
|
+
include Aws::Structure
|
22147
|
+
end
|
22148
|
+
|
22149
|
+
# A structure that represents a semantic type.
|
22150
|
+
#
|
22151
|
+
# @!attribute [rw] type_name
|
22152
|
+
# The semantic type name.
|
22153
|
+
# @return [String]
|
22154
|
+
#
|
22155
|
+
# @!attribute [rw] sub_type_name
|
22156
|
+
# The semantic type sub type name.
|
22157
|
+
# @return [String]
|
22158
|
+
#
|
22159
|
+
# @!attribute [rw] type_parameters
|
22160
|
+
# The semantic type parameters.
|
22161
|
+
# @return [Hash<String,String>]
|
22162
|
+
#
|
22163
|
+
# @!attribute [rw] truthy_cell_value
|
22164
|
+
# The semantic type truthy cell value.
|
22165
|
+
# @return [String]
|
22166
|
+
#
|
22167
|
+
# @!attribute [rw] truthy_cell_value_synonyms
|
22168
|
+
# The other names or aliases for the true cell value.
|
22169
|
+
# @return [Array<String>]
|
22170
|
+
#
|
22171
|
+
# @!attribute [rw] falsey_cell_value
|
22172
|
+
# The semantic type falsey cell value.
|
22173
|
+
# @return [String]
|
22174
|
+
#
|
22175
|
+
# @!attribute [rw] falsey_cell_value_synonyms
|
22176
|
+
# The other names or aliases for the false cell value.
|
22177
|
+
# @return [Array<String>]
|
22178
|
+
#
|
22179
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SemanticType AWS API Documentation
|
22180
|
+
#
|
22181
|
+
class SemanticType < Struct.new(
|
22182
|
+
:type_name,
|
22183
|
+
:sub_type_name,
|
22184
|
+
:type_parameters,
|
22185
|
+
:truthy_cell_value,
|
22186
|
+
:truthy_cell_value_synonyms,
|
22187
|
+
:falsey_cell_value,
|
22188
|
+
:falsey_cell_value_synonyms)
|
22189
|
+
SENSITIVE = [:truthy_cell_value, :falsey_cell_value]
|
22190
|
+
include Aws::Structure
|
22191
|
+
end
|
22192
|
+
|
20170
22193
|
# The series item configuration of a line chart.
|
20171
22194
|
#
|
20172
22195
|
# This is a union type structure. For this structure to be valid, only
|
@@ -20420,9 +22443,9 @@ module Aws::QuickSight
|
|
20420
22443
|
# The layout content type of the sheet. Choose one of the following
|
20421
22444
|
# options:
|
20422
22445
|
#
|
20423
|
-
# * `PAGINATED
|
22446
|
+
# * `PAGINATED`: Creates a sheet for a paginated report.
|
20424
22447
|
#
|
20425
|
-
# * `INTERACTIVE
|
22448
|
+
# * `INTERACTIVE`: Creates a sheet for an interactive dashboard.
|
20426
22449
|
# @return [String]
|
20427
22450
|
#
|
20428
22451
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SheetDefinition AWS API Documentation
|
@@ -20808,6 +22831,52 @@ module Aws::QuickSight
|
|
20808
22831
|
include Aws::Structure
|
20809
22832
|
end
|
20810
22833
|
|
22834
|
+
# A string parameter for a dataset.
|
22835
|
+
#
|
22836
|
+
# @!attribute [rw] id
|
22837
|
+
# An identifier for the string parameter that is created in the
|
22838
|
+
# dataset.
|
22839
|
+
# @return [String]
|
22840
|
+
#
|
22841
|
+
# @!attribute [rw] name
|
22842
|
+
# The name of the string parameter that is created in the dataset.
|
22843
|
+
# @return [String]
|
22844
|
+
#
|
22845
|
+
# @!attribute [rw] value_type
|
22846
|
+
# The value type of the dataset parameter. Valid values are `single
|
22847
|
+
# value` or `multi value`.
|
22848
|
+
# @return [String]
|
22849
|
+
#
|
22850
|
+
# @!attribute [rw] default_values
|
22851
|
+
# A list of default values for a given string dataset parameter type.
|
22852
|
+
# This structure only accepts static values.
|
22853
|
+
# @return [Types::StringDatasetParameterDefaultValues]
|
22854
|
+
#
|
22855
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/StringDatasetParameter AWS API Documentation
|
22856
|
+
#
|
22857
|
+
class StringDatasetParameter < Struct.new(
|
22858
|
+
:id,
|
22859
|
+
:name,
|
22860
|
+
:value_type,
|
22861
|
+
:default_values)
|
22862
|
+
SENSITIVE = []
|
22863
|
+
include Aws::Structure
|
22864
|
+
end
|
22865
|
+
|
22866
|
+
# The default values of a string parameter.
|
22867
|
+
#
|
22868
|
+
# @!attribute [rw] static_values
|
22869
|
+
# A list of static default values for a given string parameter.
|
22870
|
+
# @return [Array<String>]
|
22871
|
+
#
|
22872
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/StringDatasetParameterDefaultValues AWS API Documentation
|
22873
|
+
#
|
22874
|
+
class StringDatasetParameterDefaultValues < Struct.new(
|
22875
|
+
:static_values)
|
22876
|
+
SENSITIVE = []
|
22877
|
+
include Aws::Structure
|
22878
|
+
end
|
22879
|
+
|
20811
22880
|
# The default values of the `StringParameterDeclaration`.
|
20812
22881
|
#
|
20813
22882
|
# @!attribute [rw] dynamic_value
|
@@ -20888,13 +22957,19 @@ module Aws::QuickSight
|
|
20888
22957
|
# parameter when a value has not been set.
|
20889
22958
|
# @return [Types::StringValueWhenUnsetConfiguration]
|
20890
22959
|
#
|
22960
|
+
# @!attribute [rw] mapped_data_set_parameters
|
22961
|
+
# A list of dataset parameters that are mapped to an analysis
|
22962
|
+
# parameter.
|
22963
|
+
# @return [Array<Types::MappedDataSetParameter>]
|
22964
|
+
#
|
20891
22965
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/StringParameterDeclaration AWS API Documentation
|
20892
22966
|
#
|
20893
22967
|
class StringParameterDeclaration < Struct.new(
|
20894
22968
|
:parameter_value_type,
|
20895
22969
|
:name,
|
20896
22970
|
:default_values,
|
20897
|
-
:value_when_unset
|
22971
|
+
:value_when_unset,
|
22972
|
+
:mapped_data_set_parameters)
|
20898
22973
|
SENSITIVE = []
|
20899
22974
|
include Aws::Structure
|
20900
22975
|
end
|
@@ -20906,9 +22981,9 @@ module Aws::QuickSight
|
|
20906
22981
|
# The built-in options for default values. The value can be one of the
|
20907
22982
|
# following:
|
20908
22983
|
#
|
20909
|
-
# * `RECOMMENDED
|
22984
|
+
# * `RECOMMENDED`: The recommended value.
|
20910
22985
|
#
|
20911
|
-
# * `NULL
|
22986
|
+
# * `NULL`: The `NULL` value.
|
20912
22987
|
# @return [String]
|
20913
22988
|
#
|
20914
22989
|
# @!attribute [rw] custom_value
|
@@ -22453,9 +24528,9 @@ module Aws::QuickSight
|
|
22453
24528
|
# The seasonality setup of a forecast computation. Choose one of the
|
22454
24529
|
# following options:
|
22455
24530
|
#
|
22456
|
-
# * `NULL
|
24531
|
+
# * `NULL`: The input is set to `NULL`.
|
22457
24532
|
#
|
22458
|
-
# * `NON_NULL
|
24533
|
+
# * `NON_NULL`: The input is set to a custom value.
|
22459
24534
|
# @return [Integer]
|
22460
24535
|
#
|
22461
24536
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TimeBasedForecastProperties AWS API Documentation
|
@@ -22575,11 +24650,11 @@ module Aws::QuickSight
|
|
22575
24650
|
# This option determines how null values should be treated when
|
22576
24651
|
# filtering data.
|
22577
24652
|
#
|
22578
|
-
# * `ALL_VALUES
|
24653
|
+
# * `ALL_VALUES`: Include null values in filtered results.
|
22579
24654
|
#
|
22580
|
-
# * `NULLS_ONLY
|
24655
|
+
# * `NULLS_ONLY`: Only include null values in filtered results.
|
22581
24656
|
#
|
22582
|
-
# * `NON_NULLS_ONLY
|
24657
|
+
# * `NON_NULLS_ONLY`: Exclude null values from filtered results.
|
22583
24658
|
# @return [String]
|
22584
24659
|
#
|
22585
24660
|
# @!attribute [rw] exclude_period_configuration
|
@@ -22666,9 +24741,9 @@ module Aws::QuickSight
|
|
22666
24741
|
# The selected type for the tooltip. Choose one of the following
|
22667
24742
|
# options:
|
22668
24743
|
#
|
22669
|
-
# * `BASIC
|
24744
|
+
# * `BASIC`: A basic tooltip.
|
22670
24745
|
#
|
22671
|
-
# * `DETAILED
|
24746
|
+
# * `DETAILED`: A detailed tooltip.
|
22672
24747
|
# @return [String]
|
22673
24748
|
#
|
22674
24749
|
# @!attribute [rw] field_based_tooltip
|
@@ -22823,31 +24898,693 @@ module Aws::QuickSight
|
|
22823
24898
|
include Aws::Structure
|
22824
24899
|
end
|
22825
24900
|
|
22826
|
-
#
|
24901
|
+
# A structure that represents a calculated field.
|
22827
24902
|
#
|
22828
|
-
# @!attribute [rw]
|
22829
|
-
# The
|
24903
|
+
# @!attribute [rw] calculated_field_name
|
24904
|
+
# The calculated field name.
|
22830
24905
|
# @return [String]
|
22831
24906
|
#
|
22832
|
-
# @!attribute [rw]
|
22833
|
-
# The
|
24907
|
+
# @!attribute [rw] calculated_field_description
|
24908
|
+
# The calculated field description.
|
22834
24909
|
# @return [String]
|
22835
24910
|
#
|
22836
|
-
# @!attribute [rw]
|
22837
|
-
# The
|
22838
|
-
# @return [
|
24911
|
+
# @!attribute [rw] expression
|
24912
|
+
# The calculated field expression.
|
24913
|
+
# @return [String]
|
22839
24914
|
#
|
22840
|
-
#
|
24915
|
+
# @!attribute [rw] calculated_field_synonyms
|
24916
|
+
# The other names or aliases for the calculated field.
|
24917
|
+
# @return [Array<String>]
|
22841
24918
|
#
|
22842
|
-
|
22843
|
-
|
22844
|
-
|
22845
|
-
|
22846
|
-
|
22847
|
-
|
22848
|
-
|
22849
|
-
|
22850
|
-
#
|
24919
|
+
# @!attribute [rw] is_included_in_topic
|
24920
|
+
# A boolean value that indicates if a calculated field is included in
|
24921
|
+
# the topic.
|
24922
|
+
# @return [Boolean]
|
24923
|
+
#
|
24924
|
+
# @!attribute [rw] disable_indexing
|
24925
|
+
# A Boolean value that indicates if a calculated field is visible in
|
24926
|
+
# the autocomplete.
|
24927
|
+
# @return [Boolean]
|
24928
|
+
#
|
24929
|
+
# @!attribute [rw] column_data_role
|
24930
|
+
# The column data role for a calculated field. Valid values for this
|
24931
|
+
# structure are `DIMENSION` and `MEASURE`.
|
24932
|
+
# @return [String]
|
24933
|
+
#
|
24934
|
+
# @!attribute [rw] time_granularity
|
24935
|
+
# The level of time precision that is used to aggregate `DateTime`
|
24936
|
+
# values.
|
24937
|
+
# @return [String]
|
24938
|
+
#
|
24939
|
+
# @!attribute [rw] default_formatting
|
24940
|
+
# The default formatting definition.
|
24941
|
+
# @return [Types::DefaultFormatting]
|
24942
|
+
#
|
24943
|
+
# @!attribute [rw] aggregation
|
24944
|
+
# The default aggregation. Valid values for this structure are `SUM`,
|
24945
|
+
# `MAX`, `MIN`, `COUNT`, `DISTINCT_COUNT`, and `AVERAGE`.
|
24946
|
+
# @return [String]
|
24947
|
+
#
|
24948
|
+
# @!attribute [rw] comparative_order
|
24949
|
+
# The order in which data is displayed for the calculated field when
|
24950
|
+
# it's used in a comparative context.
|
24951
|
+
# @return [Types::ComparativeOrder]
|
24952
|
+
#
|
24953
|
+
# @!attribute [rw] semantic_type
|
24954
|
+
# The semantic type.
|
24955
|
+
# @return [Types::SemanticType]
|
24956
|
+
#
|
24957
|
+
# @!attribute [rw] allowed_aggregations
|
24958
|
+
# The list of aggregation types that are allowed for the calculated
|
24959
|
+
# field. Valid values for this structure are `COUNT`,
|
24960
|
+
# `DISTINCT_COUNT`, `MIN`, `MAX`, `MEDIAN`, `SUM`, `AVERAGE`, `STDEV`,
|
24961
|
+
# `STDEVP`, `VAR`, `VARP`, and `PERCENTILE`.
|
24962
|
+
# @return [Array<String>]
|
24963
|
+
#
|
24964
|
+
# @!attribute [rw] not_allowed_aggregations
|
24965
|
+
# The list of aggregation types that are not allowed for the
|
24966
|
+
# calculated field. Valid values for this structure are `COUNT`,
|
24967
|
+
# `DISTINCT_COUNT`, `MIN`, `MAX`, `MEDIAN`, `SUM`, `AVERAGE`, `STDEV`,
|
24968
|
+
# `STDEVP`, `VAR`, `VARP`, and `PERCENTILE`.
|
24969
|
+
# @return [Array<String>]
|
24970
|
+
#
|
24971
|
+
# @!attribute [rw] never_aggregate_in_filter
|
24972
|
+
# A Boolean value that indicates whether to never aggregate calculated
|
24973
|
+
# field in filters.
|
24974
|
+
# @return [Boolean]
|
24975
|
+
#
|
24976
|
+
# @!attribute [rw] cell_value_synonyms
|
24977
|
+
# The other names or aliases for the calculated field cell value.
|
24978
|
+
# @return [Array<Types::CellValueSynonym>]
|
24979
|
+
#
|
24980
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TopicCalculatedField AWS API Documentation
|
24981
|
+
#
|
24982
|
+
class TopicCalculatedField < Struct.new(
|
24983
|
+
:calculated_field_name,
|
24984
|
+
:calculated_field_description,
|
24985
|
+
:expression,
|
24986
|
+
:calculated_field_synonyms,
|
24987
|
+
:is_included_in_topic,
|
24988
|
+
:disable_indexing,
|
24989
|
+
:column_data_role,
|
24990
|
+
:time_granularity,
|
24991
|
+
:default_formatting,
|
24992
|
+
:aggregation,
|
24993
|
+
:comparative_order,
|
24994
|
+
:semantic_type,
|
24995
|
+
:allowed_aggregations,
|
24996
|
+
:not_allowed_aggregations,
|
24997
|
+
:never_aggregate_in_filter,
|
24998
|
+
:cell_value_synonyms)
|
24999
|
+
SENSITIVE = [:expression]
|
25000
|
+
include Aws::Structure
|
25001
|
+
end
|
25002
|
+
|
25003
|
+
# A structure that represents a category filter.
|
25004
|
+
#
|
25005
|
+
# @!attribute [rw] category_filter_function
|
25006
|
+
# The category filter function. Valid values for this structure are
|
25007
|
+
# `EXACT` and `CONTAINS`.
|
25008
|
+
# @return [String]
|
25009
|
+
#
|
25010
|
+
# @!attribute [rw] category_filter_type
|
25011
|
+
# The category filter type. This element is used to specify whether a
|
25012
|
+
# filter is a simple category filter or an inverse category filter.
|
25013
|
+
# @return [String]
|
25014
|
+
#
|
25015
|
+
# @!attribute [rw] constant
|
25016
|
+
# The constant used in a category filter.
|
25017
|
+
# @return [Types::TopicCategoryFilterConstant]
|
25018
|
+
#
|
25019
|
+
# @!attribute [rw] inverse
|
25020
|
+
# A Boolean value that indicates if the filter is inverse.
|
25021
|
+
# @return [Boolean]
|
25022
|
+
#
|
25023
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TopicCategoryFilter AWS API Documentation
|
25024
|
+
#
|
25025
|
+
class TopicCategoryFilter < Struct.new(
|
25026
|
+
:category_filter_function,
|
25027
|
+
:category_filter_type,
|
25028
|
+
:constant,
|
25029
|
+
:inverse)
|
25030
|
+
SENSITIVE = [:constant]
|
25031
|
+
include Aws::Structure
|
25032
|
+
end
|
25033
|
+
|
25034
|
+
# A constant used in a category filter.
|
25035
|
+
#
|
25036
|
+
# @!attribute [rw] constant_type
|
25037
|
+
# The type of category filter constant. This element is used to
|
25038
|
+
# specify whether a constant is a singular or collective. Valid values
|
25039
|
+
# are `SINGULAR` and `COLLECTIVE`.
|
25040
|
+
# @return [String]
|
25041
|
+
#
|
25042
|
+
# @!attribute [rw] singular_constant
|
25043
|
+
# A singular constant used in a category filter. This element is used
|
25044
|
+
# to specify a single value for the constant.
|
25045
|
+
# @return [String]
|
25046
|
+
#
|
25047
|
+
# @!attribute [rw] collective_constant
|
25048
|
+
# A collective constant used in a category filter. This element is
|
25049
|
+
# used to specify a list of values for the constant.
|
25050
|
+
# @return [Types::CollectiveConstant]
|
25051
|
+
#
|
25052
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TopicCategoryFilterConstant AWS API Documentation
|
25053
|
+
#
|
25054
|
+
class TopicCategoryFilterConstant < Struct.new(
|
25055
|
+
:constant_type,
|
25056
|
+
:singular_constant,
|
25057
|
+
:collective_constant)
|
25058
|
+
SENSITIVE = []
|
25059
|
+
include Aws::Structure
|
25060
|
+
end
|
25061
|
+
|
25062
|
+
# Represents a column in a dataset.
|
25063
|
+
#
|
25064
|
+
# @!attribute [rw] column_name
|
25065
|
+
# The name of the column.
|
25066
|
+
# @return [String]
|
25067
|
+
#
|
25068
|
+
# @!attribute [rw] column_friendly_name
|
25069
|
+
# A user-friendly name for the column.
|
25070
|
+
# @return [String]
|
25071
|
+
#
|
25072
|
+
# @!attribute [rw] column_description
|
25073
|
+
# A description of the column and its contents.
|
25074
|
+
# @return [String]
|
25075
|
+
#
|
25076
|
+
# @!attribute [rw] column_synonyms
|
25077
|
+
# The other names or aliases for the column.
|
25078
|
+
# @return [Array<String>]
|
25079
|
+
#
|
25080
|
+
# @!attribute [rw] column_data_role
|
25081
|
+
# The role of the column in the data. Valid values are `DIMENSION` and
|
25082
|
+
# `MEASURE`.
|
25083
|
+
# @return [String]
|
25084
|
+
#
|
25085
|
+
# @!attribute [rw] aggregation
|
25086
|
+
# The type of aggregation that is performed on the column data when
|
25087
|
+
# it's queried. Valid values for this structure are `SUM`, `MAX`,
|
25088
|
+
# `MIN`, `COUNT`, `DISTINCT_COUNT`, and `AVERAGE`.
|
25089
|
+
# @return [String]
|
25090
|
+
#
|
25091
|
+
# @!attribute [rw] is_included_in_topic
|
25092
|
+
# A Boolean value that indicates whether the column is included in the
|
25093
|
+
# query results.
|
25094
|
+
# @return [Boolean]
|
25095
|
+
#
|
25096
|
+
# @!attribute [rw] disable_indexing
|
25097
|
+
# A Boolean value that indicates whether the column shows in the
|
25098
|
+
# autocomplete functionality.
|
25099
|
+
# @return [Boolean]
|
25100
|
+
#
|
25101
|
+
# @!attribute [rw] comparative_order
|
25102
|
+
# The order in which data is displayed for the column when it's used
|
25103
|
+
# in a comparative context.
|
25104
|
+
# @return [Types::ComparativeOrder]
|
25105
|
+
#
|
25106
|
+
# @!attribute [rw] semantic_type
|
25107
|
+
# The semantic type of data contained in the column.
|
25108
|
+
# @return [Types::SemanticType]
|
25109
|
+
#
|
25110
|
+
# @!attribute [rw] time_granularity
|
25111
|
+
# The level of time precision that is used to aggregate `DateTime`
|
25112
|
+
# values.
|
25113
|
+
# @return [String]
|
25114
|
+
#
|
25115
|
+
# @!attribute [rw] allowed_aggregations
|
25116
|
+
# The list of aggregation types that are allowed for the column. Valid
|
25117
|
+
# values for this structure are `COUNT`, `DISTINCT_COUNT`, `MIN`,
|
25118
|
+
# `MAX`, `MEDIAN`, `SUM`, `AVERAGE`, `STDEV`, `STDEVP`, `VAR`, `VARP`,
|
25119
|
+
# and `PERCENTILE`.
|
25120
|
+
# @return [Array<String>]
|
25121
|
+
#
|
25122
|
+
# @!attribute [rw] not_allowed_aggregations
|
25123
|
+
# The list of aggregation types that are not allowed for the column.
|
25124
|
+
# Valid values for this structure are `COUNT`, `DISTINCT_COUNT`,
|
25125
|
+
# `MIN`, `MAX`, `MEDIAN`, `SUM`, `AVERAGE`, `STDEV`, `STDEVP`, `VAR`,
|
25126
|
+
# `VARP`, and `PERCENTILE`.
|
25127
|
+
# @return [Array<String>]
|
25128
|
+
#
|
25129
|
+
# @!attribute [rw] default_formatting
|
25130
|
+
# The default formatting used for values in the column.
|
25131
|
+
# @return [Types::DefaultFormatting]
|
25132
|
+
#
|
25133
|
+
# @!attribute [rw] never_aggregate_in_filter
|
25134
|
+
# A Boolean value that indicates whether to aggregate the column data
|
25135
|
+
# when it's used in a filter context.
|
25136
|
+
# @return [Boolean]
|
25137
|
+
#
|
25138
|
+
# @!attribute [rw] cell_value_synonyms
|
25139
|
+
# The other names or aliases for the column cell value.
|
25140
|
+
# @return [Array<Types::CellValueSynonym>]
|
25141
|
+
#
|
25142
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TopicColumn AWS API Documentation
|
25143
|
+
#
|
25144
|
+
class TopicColumn < Struct.new(
|
25145
|
+
:column_name,
|
25146
|
+
:column_friendly_name,
|
25147
|
+
:column_description,
|
25148
|
+
:column_synonyms,
|
25149
|
+
:column_data_role,
|
25150
|
+
:aggregation,
|
25151
|
+
:is_included_in_topic,
|
25152
|
+
:disable_indexing,
|
25153
|
+
:comparative_order,
|
25154
|
+
:semantic_type,
|
25155
|
+
:time_granularity,
|
25156
|
+
:allowed_aggregations,
|
25157
|
+
:not_allowed_aggregations,
|
25158
|
+
:default_formatting,
|
25159
|
+
:never_aggregate_in_filter,
|
25160
|
+
:cell_value_synonyms)
|
25161
|
+
SENSITIVE = []
|
25162
|
+
include Aws::Structure
|
25163
|
+
end
|
25164
|
+
|
25165
|
+
# A filter used to restrict data based on a range of dates or times.
|
25166
|
+
#
|
25167
|
+
# @!attribute [rw] inclusive
|
25168
|
+
# A Boolean value that indicates whether the date range filter should
|
25169
|
+
# include the boundary values. If set to true, the filter includes the
|
25170
|
+
# start and end dates. If set to false, the filter excludes them.
|
25171
|
+
# @return [Boolean]
|
25172
|
+
#
|
25173
|
+
# @!attribute [rw] constant
|
25174
|
+
# The constant used in a date range filter.
|
25175
|
+
# @return [Types::TopicRangeFilterConstant]
|
25176
|
+
#
|
25177
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TopicDateRangeFilter AWS API Documentation
|
25178
|
+
#
|
25179
|
+
class TopicDateRangeFilter < Struct.new(
|
25180
|
+
:inclusive,
|
25181
|
+
:constant)
|
25182
|
+
SENSITIVE = [:constant]
|
25183
|
+
include Aws::Structure
|
25184
|
+
end
|
25185
|
+
|
25186
|
+
# A structure that describes the details of a topic, such as its name,
|
25187
|
+
# description, and associated data sets.
|
25188
|
+
#
|
25189
|
+
# @!attribute [rw] name
|
25190
|
+
# The name of the topic.
|
25191
|
+
# @return [String]
|
25192
|
+
#
|
25193
|
+
# @!attribute [rw] description
|
25194
|
+
# The description of the topic.
|
25195
|
+
# @return [String]
|
25196
|
+
#
|
25197
|
+
# @!attribute [rw] data_sets
|
25198
|
+
# The data sets that the topic is associated with.
|
25199
|
+
# @return [Array<Types::DatasetMetadata>]
|
25200
|
+
#
|
25201
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TopicDetails AWS API Documentation
|
25202
|
+
#
|
25203
|
+
class TopicDetails < Struct.new(
|
25204
|
+
:name,
|
25205
|
+
:description,
|
25206
|
+
:data_sets)
|
25207
|
+
SENSITIVE = []
|
25208
|
+
include Aws::Structure
|
25209
|
+
end
|
25210
|
+
|
25211
|
+
# A structure that represents a filter used to select items for a topic.
|
25212
|
+
#
|
25213
|
+
# @!attribute [rw] filter_description
|
25214
|
+
# A description of the filter used to select items for a topic.
|
25215
|
+
# @return [String]
|
25216
|
+
#
|
25217
|
+
# @!attribute [rw] filter_class
|
25218
|
+
# The class of the filter. Valid values for this structure are
|
25219
|
+
# `ENFORCED_VALUE_FILTER`, `CONDITIONAL_VALUE_FILTER`, and
|
25220
|
+
# `NAMED_VALUE_FILTER`.
|
25221
|
+
# @return [String]
|
25222
|
+
#
|
25223
|
+
# @!attribute [rw] filter_name
|
25224
|
+
# The name of the filter.
|
25225
|
+
# @return [String]
|
25226
|
+
#
|
25227
|
+
# @!attribute [rw] filter_synonyms
|
25228
|
+
# The other names or aliases for the filter.
|
25229
|
+
# @return [Array<String>]
|
25230
|
+
#
|
25231
|
+
# @!attribute [rw] operand_field_name
|
25232
|
+
# The name of the field that the filter operates on.
|
25233
|
+
# @return [String]
|
25234
|
+
#
|
25235
|
+
# @!attribute [rw] filter_type
|
25236
|
+
# The type of the filter. Valid values for this structure are
|
25237
|
+
# `CATEGORY_FILTER`, `NUMERIC_EQUALITY_FILTER`,
|
25238
|
+
# `NUMERIC_RANGE_FILTER`, `DATE_RANGE_FILTER`, and
|
25239
|
+
# `RELATIVE_DATE_FILTER`.
|
25240
|
+
# @return [String]
|
25241
|
+
#
|
25242
|
+
# @!attribute [rw] category_filter
|
25243
|
+
# The category filter that is associated with this filter.
|
25244
|
+
# @return [Types::TopicCategoryFilter]
|
25245
|
+
#
|
25246
|
+
# @!attribute [rw] numeric_equality_filter
|
25247
|
+
# The numeric equality filter.
|
25248
|
+
# @return [Types::TopicNumericEqualityFilter]
|
25249
|
+
#
|
25250
|
+
# @!attribute [rw] numeric_range_filter
|
25251
|
+
# The numeric range filter.
|
25252
|
+
# @return [Types::TopicNumericRangeFilter]
|
25253
|
+
#
|
25254
|
+
# @!attribute [rw] date_range_filter
|
25255
|
+
# The date range filter.
|
25256
|
+
# @return [Types::TopicDateRangeFilter]
|
25257
|
+
#
|
25258
|
+
# @!attribute [rw] relative_date_filter
|
25259
|
+
# The relative date filter.
|
25260
|
+
# @return [Types::TopicRelativeDateFilter]
|
25261
|
+
#
|
25262
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TopicFilter AWS API Documentation
|
25263
|
+
#
|
25264
|
+
class TopicFilter < Struct.new(
|
25265
|
+
:filter_description,
|
25266
|
+
:filter_class,
|
25267
|
+
:filter_name,
|
25268
|
+
:filter_synonyms,
|
25269
|
+
:operand_field_name,
|
25270
|
+
:filter_type,
|
25271
|
+
:category_filter,
|
25272
|
+
:numeric_equality_filter,
|
25273
|
+
:numeric_range_filter,
|
25274
|
+
:date_range_filter,
|
25275
|
+
:relative_date_filter)
|
25276
|
+
SENSITIVE = []
|
25277
|
+
include Aws::Structure
|
25278
|
+
end
|
25279
|
+
|
25280
|
+
# A structure that represents a named entity.
|
25281
|
+
#
|
25282
|
+
# @!attribute [rw] entity_name
|
25283
|
+
# The name of the named entity.
|
25284
|
+
# @return [String]
|
25285
|
+
#
|
25286
|
+
# @!attribute [rw] entity_description
|
25287
|
+
# The description of the named entity.
|
25288
|
+
# @return [String]
|
25289
|
+
#
|
25290
|
+
# @!attribute [rw] entity_synonyms
|
25291
|
+
# The other names or aliases for the named entity.
|
25292
|
+
# @return [Array<String>]
|
25293
|
+
#
|
25294
|
+
# @!attribute [rw] semantic_entity_type
|
25295
|
+
# The type of named entity that a topic represents.
|
25296
|
+
# @return [Types::SemanticEntityType]
|
25297
|
+
#
|
25298
|
+
# @!attribute [rw] definition
|
25299
|
+
# The definition of a named entity.
|
25300
|
+
# @return [Array<Types::NamedEntityDefinition>]
|
25301
|
+
#
|
25302
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TopicNamedEntity AWS API Documentation
|
25303
|
+
#
|
25304
|
+
class TopicNamedEntity < Struct.new(
|
25305
|
+
:entity_name,
|
25306
|
+
:entity_description,
|
25307
|
+
:entity_synonyms,
|
25308
|
+
:semantic_entity_type,
|
25309
|
+
:definition)
|
25310
|
+
SENSITIVE = []
|
25311
|
+
include Aws::Structure
|
25312
|
+
end
|
25313
|
+
|
25314
|
+
# A filter that filters topics based on the value of a numeric field.
|
25315
|
+
# The filter includes only topics whose numeric field value matches the
|
25316
|
+
# specified value.
|
25317
|
+
#
|
25318
|
+
# @!attribute [rw] constant
|
25319
|
+
# The constant used in a numeric equality filter.
|
25320
|
+
# @return [Types::TopicSingularFilterConstant]
|
25321
|
+
#
|
25322
|
+
# @!attribute [rw] aggregation
|
25323
|
+
# An aggregation function that specifies how to calculate the value of
|
25324
|
+
# a numeric field for a topic. Valid values for this structure are
|
25325
|
+
# `NO_AGGREGATION`, `SUM`, `AVERAGE`, `COUNT`, `DISTINCT_COUNT`,
|
25326
|
+
# `MAX`, `MEDIAN`, `MIN`, `STDEV`, `STDEVP`, `VAR`, and `VARP`.
|
25327
|
+
# @return [String]
|
25328
|
+
#
|
25329
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TopicNumericEqualityFilter AWS API Documentation
|
25330
|
+
#
|
25331
|
+
class TopicNumericEqualityFilter < Struct.new(
|
25332
|
+
:constant,
|
25333
|
+
:aggregation)
|
25334
|
+
SENSITIVE = [:constant]
|
25335
|
+
include Aws::Structure
|
25336
|
+
end
|
25337
|
+
|
25338
|
+
# A filter that filters topics based on the value of a numeric field.
|
25339
|
+
# The filter includes only topics whose numeric field value falls within
|
25340
|
+
# the specified range.
|
25341
|
+
#
|
25342
|
+
# @!attribute [rw] inclusive
|
25343
|
+
# A Boolean value that indicates whether the endpoints of the numeric
|
25344
|
+
# range are included in the filter. If set to true, topics whose
|
25345
|
+
# numeric field value is equal to the endpoint values will be included
|
25346
|
+
# in the filter. If set to false, topics whose numeric field value is
|
25347
|
+
# equal to the endpoint values will be excluded from the filter.
|
25348
|
+
# @return [Boolean]
|
25349
|
+
#
|
25350
|
+
# @!attribute [rw] constant
|
25351
|
+
# The constant used in a numeric range filter.
|
25352
|
+
# @return [Types::TopicRangeFilterConstant]
|
25353
|
+
#
|
25354
|
+
# @!attribute [rw] aggregation
|
25355
|
+
# An aggregation function that specifies how to calculate the value of
|
25356
|
+
# a numeric field for a topic, Valid values for this structure are
|
25357
|
+
# `NO_AGGREGATION`, `SUM`, `AVERAGE`, `COUNT`, `DISTINCT_COUNT`,
|
25358
|
+
# `MAX`, `MEDIAN`, `MIN`, `STDEV`, `STDEVP`, `VAR`, and `VARP`.
|
25359
|
+
# @return [String]
|
25360
|
+
#
|
25361
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TopicNumericRangeFilter AWS API Documentation
|
25362
|
+
#
|
25363
|
+
class TopicNumericRangeFilter < Struct.new(
|
25364
|
+
:inclusive,
|
25365
|
+
:constant,
|
25366
|
+
:aggregation)
|
25367
|
+
SENSITIVE = [:constant]
|
25368
|
+
include Aws::Structure
|
25369
|
+
end
|
25370
|
+
|
25371
|
+
# A constant value that is used in a range filter to specify the
|
25372
|
+
# endpoints of the range.
|
25373
|
+
#
|
25374
|
+
# @!attribute [rw] constant_type
|
25375
|
+
# The data type of the constant value that is used in a range filter.
|
25376
|
+
# Valid values for this structure are `RANGE`.
|
25377
|
+
# @return [String]
|
25378
|
+
#
|
25379
|
+
# @!attribute [rw] range_constant
|
25380
|
+
# The value of the constant that is used to specify the endpoints of a
|
25381
|
+
# range filter.
|
25382
|
+
# @return [Types::RangeConstant]
|
25383
|
+
#
|
25384
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TopicRangeFilterConstant AWS API Documentation
|
25385
|
+
#
|
25386
|
+
class TopicRangeFilterConstant < Struct.new(
|
25387
|
+
:constant_type,
|
25388
|
+
:range_constant)
|
25389
|
+
SENSITIVE = []
|
25390
|
+
include Aws::Structure
|
25391
|
+
end
|
25392
|
+
|
25393
|
+
# The details about the refresh of a topic.
|
25394
|
+
#
|
25395
|
+
# @!attribute [rw] refresh_arn
|
25396
|
+
# The Amazon Resource Name (ARN) of the topic refresh.
|
25397
|
+
# @return [String]
|
25398
|
+
#
|
25399
|
+
# @!attribute [rw] refresh_id
|
25400
|
+
# The ID of the refresh, which occurs as a result of topic creation or
|
25401
|
+
# topic update.
|
25402
|
+
# @return [String]
|
25403
|
+
#
|
25404
|
+
# @!attribute [rw] refresh_status
|
25405
|
+
# The status of the refresh job that indicates whether the job is
|
25406
|
+
# still running, completed successfully, or failed.
|
25407
|
+
# @return [String]
|
25408
|
+
#
|
25409
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TopicRefreshDetails AWS API Documentation
|
25410
|
+
#
|
25411
|
+
class TopicRefreshDetails < Struct.new(
|
25412
|
+
:refresh_arn,
|
25413
|
+
:refresh_id,
|
25414
|
+
:refresh_status)
|
25415
|
+
SENSITIVE = []
|
25416
|
+
include Aws::Structure
|
25417
|
+
end
|
25418
|
+
|
25419
|
+
# A structure that represents a topic refresh schedule.
|
25420
|
+
#
|
25421
|
+
# @!attribute [rw] is_enabled
|
25422
|
+
# A Boolean value that controls whether to schedule is enabled.
|
25423
|
+
# @return [Boolean]
|
25424
|
+
#
|
25425
|
+
# @!attribute [rw] based_on_spice_schedule
|
25426
|
+
# A Boolean value that controls whether to schedule runs at the same
|
25427
|
+
# schedule that is specified in SPICE dataset.
|
25428
|
+
# @return [Boolean]
|
25429
|
+
#
|
25430
|
+
# @!attribute [rw] starting_at
|
25431
|
+
# The starting date and time for the refresh schedule.
|
25432
|
+
# @return [Time]
|
25433
|
+
#
|
25434
|
+
# @!attribute [rw] timezone
|
25435
|
+
# The timezone that you want the refresh schedule to use.
|
25436
|
+
# @return [String]
|
25437
|
+
#
|
25438
|
+
# @!attribute [rw] repeat_at
|
25439
|
+
# The time of day when the refresh should run, for example,
|
25440
|
+
# Monday-Sunday.
|
25441
|
+
# @return [String]
|
25442
|
+
#
|
25443
|
+
# @!attribute [rw] topic_schedule_type
|
25444
|
+
# The type of refresh schedule. Valid values for this structure are
|
25445
|
+
# `HOURLY`, `DAILY`, `WEEKLY`, and `MONTHLY`.
|
25446
|
+
# @return [String]
|
25447
|
+
#
|
25448
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TopicRefreshSchedule AWS API Documentation
|
25449
|
+
#
|
25450
|
+
class TopicRefreshSchedule < Struct.new(
|
25451
|
+
:is_enabled,
|
25452
|
+
:based_on_spice_schedule,
|
25453
|
+
:starting_at,
|
25454
|
+
:timezone,
|
25455
|
+
:repeat_at,
|
25456
|
+
:topic_schedule_type)
|
25457
|
+
SENSITIVE = []
|
25458
|
+
include Aws::Structure
|
25459
|
+
end
|
25460
|
+
|
25461
|
+
# A summary of the refresh schedule details for a dataset.
|
25462
|
+
#
|
25463
|
+
# @!attribute [rw] dataset_id
|
25464
|
+
# The ID of the dataset.
|
25465
|
+
# @return [String]
|
25466
|
+
#
|
25467
|
+
# @!attribute [rw] dataset_arn
|
25468
|
+
# The Amazon Resource Name (ARN) of the dataset.
|
25469
|
+
# @return [String]
|
25470
|
+
#
|
25471
|
+
# @!attribute [rw] dataset_name
|
25472
|
+
# The name of the dataset.
|
25473
|
+
# @return [String]
|
25474
|
+
#
|
25475
|
+
# @!attribute [rw] refresh_schedule
|
25476
|
+
# The definition of a refresh schedule.
|
25477
|
+
# @return [Types::TopicRefreshSchedule]
|
25478
|
+
#
|
25479
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TopicRefreshScheduleSummary AWS API Documentation
|
25480
|
+
#
|
25481
|
+
class TopicRefreshScheduleSummary < Struct.new(
|
25482
|
+
:dataset_id,
|
25483
|
+
:dataset_arn,
|
25484
|
+
:dataset_name,
|
25485
|
+
:refresh_schedule)
|
25486
|
+
SENSITIVE = []
|
25487
|
+
include Aws::Structure
|
25488
|
+
end
|
25489
|
+
|
25490
|
+
# A structure that represents a relative date filter.
|
25491
|
+
#
|
25492
|
+
# @!attribute [rw] time_granularity
|
25493
|
+
# The level of time precision that is used to aggregate `DateTime`
|
25494
|
+
# values.
|
25495
|
+
# @return [String]
|
25496
|
+
#
|
25497
|
+
# @!attribute [rw] relative_date_filter_function
|
25498
|
+
# The function to be used in a relative date filter to determine the
|
25499
|
+
# range of dates to include in the results. Valid values for this
|
25500
|
+
# structure are `BEFORE`, `AFTER`, and `BETWEEN`.
|
25501
|
+
# @return [String]
|
25502
|
+
#
|
25503
|
+
# @!attribute [rw] constant
|
25504
|
+
# The constant used in a relative date filter.
|
25505
|
+
# @return [Types::TopicSingularFilterConstant]
|
25506
|
+
#
|
25507
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TopicRelativeDateFilter AWS API Documentation
|
25508
|
+
#
|
25509
|
+
class TopicRelativeDateFilter < Struct.new(
|
25510
|
+
:time_granularity,
|
25511
|
+
:relative_date_filter_function,
|
25512
|
+
:constant)
|
25513
|
+
SENSITIVE = [:constant]
|
25514
|
+
include Aws::Structure
|
25515
|
+
end
|
25516
|
+
|
25517
|
+
# A structure that represents a singular filter constant, used in
|
25518
|
+
# filters to specify a single value to match against.
|
25519
|
+
#
|
25520
|
+
# @!attribute [rw] constant_type
|
25521
|
+
# The type of the singular filter constant. Valid values for this
|
25522
|
+
# structure are `SINGULAR`.
|
25523
|
+
# @return [String]
|
25524
|
+
#
|
25525
|
+
# @!attribute [rw] singular_constant
|
25526
|
+
# The value of the singular filter constant.
|
25527
|
+
# @return [String]
|
25528
|
+
#
|
25529
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TopicSingularFilterConstant AWS API Documentation
|
25530
|
+
#
|
25531
|
+
class TopicSingularFilterConstant < Struct.new(
|
25532
|
+
:constant_type,
|
25533
|
+
:singular_constant)
|
25534
|
+
SENSITIVE = []
|
25535
|
+
include Aws::Structure
|
25536
|
+
end
|
25537
|
+
|
25538
|
+
# A topic summary.
|
25539
|
+
#
|
25540
|
+
# @!attribute [rw] arn
|
25541
|
+
# The Amazon Resource Name (ARN) of the topic.
|
25542
|
+
# @return [String]
|
25543
|
+
#
|
25544
|
+
# @!attribute [rw] topic_id
|
25545
|
+
# The ID for the topic. This ID is unique per Amazon Web Services
|
25546
|
+
# Region for each Amazon Web Services account.
|
25547
|
+
# @return [String]
|
25548
|
+
#
|
25549
|
+
# @!attribute [rw] name
|
25550
|
+
# The name of the topic.
|
25551
|
+
# @return [String]
|
25552
|
+
#
|
25553
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TopicSummary AWS API Documentation
|
25554
|
+
#
|
25555
|
+
class TopicSummary < Struct.new(
|
25556
|
+
:arn,
|
25557
|
+
:topic_id,
|
25558
|
+
:name)
|
25559
|
+
SENSITIVE = []
|
25560
|
+
include Aws::Structure
|
25561
|
+
end
|
25562
|
+
|
25563
|
+
# The total aggregation computation configuration.
|
25564
|
+
#
|
25565
|
+
# @!attribute [rw] computation_id
|
25566
|
+
# The ID for a computation.
|
25567
|
+
# @return [String]
|
25568
|
+
#
|
25569
|
+
# @!attribute [rw] name
|
25570
|
+
# The name of a computation.
|
25571
|
+
# @return [String]
|
25572
|
+
#
|
25573
|
+
# @!attribute [rw] value
|
25574
|
+
# The value field that is used in a computation.
|
25575
|
+
# @return [Types::MeasureField]
|
25576
|
+
#
|
25577
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TotalAggregationComputation AWS API Documentation
|
25578
|
+
#
|
25579
|
+
class TotalAggregationComputation < Struct.new(
|
25580
|
+
:computation_id,
|
25581
|
+
:name,
|
25582
|
+
:value)
|
25583
|
+
SENSITIVE = []
|
25584
|
+
include Aws::Structure
|
25585
|
+
end
|
25586
|
+
|
25587
|
+
# The total options for a table visual.
|
22851
25588
|
#
|
22852
25589
|
# @!attribute [rw] totals_visibility
|
22853
25590
|
# The visibility configuration for the total cells.
|
@@ -22915,6 +25652,11 @@ module Aws::QuickSight
|
|
22915
25652
|
# A transform operation that removes tags associated with a column.
|
22916
25653
|
# @return [Types::UntagColumnOperation]
|
22917
25654
|
#
|
25655
|
+
# @!attribute [rw] override_dataset_parameter_operation
|
25656
|
+
# A transform operation that overrides the dataset parameter values
|
25657
|
+
# that are defined in another dataset.
|
25658
|
+
# @return [Types::OverrideDatasetParameterOperation]
|
25659
|
+
#
|
22918
25660
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TransformOperation AWS API Documentation
|
22919
25661
|
#
|
22920
25662
|
class TransformOperation < Struct.new(
|
@@ -22924,7 +25666,8 @@ module Aws::QuickSight
|
|
22924
25666
|
:rename_column_operation,
|
22925
25667
|
:cast_column_type_operation,
|
22926
25668
|
:tag_column_operation,
|
22927
|
-
:untag_column_operation
|
25669
|
+
:untag_column_operation,
|
25670
|
+
:override_dataset_parameter_operation)
|
22928
25671
|
SENSITIVE = []
|
22929
25672
|
include Aws::Structure
|
22930
25673
|
end
|
@@ -24047,6 +26790,10 @@ module Aws::QuickSight
|
|
24047
26790
|
# this dataset as a source.
|
24048
26791
|
# @return [Types::DataSetUsageConfiguration]
|
24049
26792
|
#
|
26793
|
+
# @!attribute [rw] dataset_parameters
|
26794
|
+
# The parameter declarations of the dataset.
|
26795
|
+
# @return [Array<Types::DatasetParameter>]
|
26796
|
+
#
|
24050
26797
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDataSetRequest AWS API Documentation
|
24051
26798
|
#
|
24052
26799
|
class UpdateDataSetRequest < Struct.new(
|
@@ -24061,7 +26808,8 @@ module Aws::QuickSight
|
|
24061
26808
|
:row_level_permission_data_set,
|
24062
26809
|
:row_level_permission_tag_configuration,
|
24063
26810
|
:column_level_permission_rules,
|
24064
|
-
:data_set_usage_configuration
|
26811
|
+
:data_set_usage_configuration,
|
26812
|
+
:dataset_parameters)
|
24065
26813
|
SENSITIVE = []
|
24066
26814
|
include Aws::Structure
|
24067
26815
|
end
|
@@ -24412,8 +27160,8 @@ module Aws::QuickSight
|
|
24412
27160
|
# @return [String]
|
24413
27161
|
#
|
24414
27162
|
# @!attribute [rw] assignment_name
|
24415
|
-
# The name of the assignment, also called a rule.
|
24416
|
-
# unique within
|
27163
|
+
# The name of the assignment, also called a rule. The name must be
|
27164
|
+
# unique within the Amazon Web Services account.
|
24417
27165
|
# @return [String]
|
24418
27166
|
#
|
24419
27167
|
# @!attribute [rw] namespace
|
@@ -24592,6 +27340,55 @@ module Aws::QuickSight
|
|
24592
27340
|
include Aws::Structure
|
24593
27341
|
end
|
24594
27342
|
|
27343
|
+
# @!attribute [rw] data_set_id
|
27344
|
+
# The ID of the dataset.
|
27345
|
+
# @return [String]
|
27346
|
+
#
|
27347
|
+
# @!attribute [rw] aws_account_id
|
27348
|
+
# The Amazon Web Services account ID.
|
27349
|
+
# @return [String]
|
27350
|
+
#
|
27351
|
+
# @!attribute [rw] schedule
|
27352
|
+
# The refresh schedule.
|
27353
|
+
# @return [Types::RefreshSchedule]
|
27354
|
+
#
|
27355
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateRefreshScheduleRequest AWS API Documentation
|
27356
|
+
#
|
27357
|
+
class UpdateRefreshScheduleRequest < Struct.new(
|
27358
|
+
:data_set_id,
|
27359
|
+
:aws_account_id,
|
27360
|
+
:schedule)
|
27361
|
+
SENSITIVE = []
|
27362
|
+
include Aws::Structure
|
27363
|
+
end
|
27364
|
+
|
27365
|
+
# @!attribute [rw] status
|
27366
|
+
# The HTTP status of the request.
|
27367
|
+
# @return [Integer]
|
27368
|
+
#
|
27369
|
+
# @!attribute [rw] request_id
|
27370
|
+
# The Amazon Web Services request ID for this operation.
|
27371
|
+
# @return [String]
|
27372
|
+
#
|
27373
|
+
# @!attribute [rw] schedule_id
|
27374
|
+
# The ID of the refresh schedule.
|
27375
|
+
# @return [String]
|
27376
|
+
#
|
27377
|
+
# @!attribute [rw] arn
|
27378
|
+
# The Amazon Resource Name (ARN) for the refresh schedule.
|
27379
|
+
# @return [String]
|
27380
|
+
#
|
27381
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateRefreshScheduleResponse AWS API Documentation
|
27382
|
+
#
|
27383
|
+
class UpdateRefreshScheduleResponse < Struct.new(
|
27384
|
+
:status,
|
27385
|
+
:request_id,
|
27386
|
+
:schedule_id,
|
27387
|
+
:arn)
|
27388
|
+
SENSITIVE = []
|
27389
|
+
include Aws::Structure
|
27390
|
+
end
|
27391
|
+
|
24595
27392
|
# @!attribute [rw] aws_account_id
|
24596
27393
|
# The ID of the Amazon Web Services account that contains the template
|
24597
27394
|
# alias that you're updating.
|
@@ -24990,6 +27787,187 @@ module Aws::QuickSight
|
|
24990
27787
|
include Aws::Structure
|
24991
27788
|
end
|
24992
27789
|
|
27790
|
+
# @!attribute [rw] aws_account_id
|
27791
|
+
# The ID of the Amazon Web Services account that contains the topic
|
27792
|
+
# that you want to update the permissions for.
|
27793
|
+
# @return [String]
|
27794
|
+
#
|
27795
|
+
# @!attribute [rw] topic_id
|
27796
|
+
# The ID of the topic that you want to modify. This ID is unique per
|
27797
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
27798
|
+
# @return [String]
|
27799
|
+
#
|
27800
|
+
# @!attribute [rw] grant_permissions
|
27801
|
+
# The resource permissions that you want to grant to the topic.
|
27802
|
+
# @return [Array<Types::ResourcePermission>]
|
27803
|
+
#
|
27804
|
+
# @!attribute [rw] revoke_permissions
|
27805
|
+
# The resource permissions that you want to revoke from the topic.
|
27806
|
+
# @return [Array<Types::ResourcePermission>]
|
27807
|
+
#
|
27808
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateTopicPermissionsRequest AWS API Documentation
|
27809
|
+
#
|
27810
|
+
class UpdateTopicPermissionsRequest < Struct.new(
|
27811
|
+
:aws_account_id,
|
27812
|
+
:topic_id,
|
27813
|
+
:grant_permissions,
|
27814
|
+
:revoke_permissions)
|
27815
|
+
SENSITIVE = []
|
27816
|
+
include Aws::Structure
|
27817
|
+
end
|
27818
|
+
|
27819
|
+
# @!attribute [rw] topic_id
|
27820
|
+
# The ID of the topic that you want to modify. This ID is unique per
|
27821
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
27822
|
+
# @return [String]
|
27823
|
+
#
|
27824
|
+
# @!attribute [rw] topic_arn
|
27825
|
+
# The Amazon Resource Name (ARN) of the topic.
|
27826
|
+
# @return [String]
|
27827
|
+
#
|
27828
|
+
# @!attribute [rw] permissions
|
27829
|
+
# A list of resource permissions on the topic.
|
27830
|
+
# @return [Array<Types::ResourcePermission>]
|
27831
|
+
#
|
27832
|
+
# @!attribute [rw] status
|
27833
|
+
# The HTTP status of the request.
|
27834
|
+
# @return [Integer]
|
27835
|
+
#
|
27836
|
+
# @!attribute [rw] request_id
|
27837
|
+
# The Amazon Web Services request ID for this operation.
|
27838
|
+
# @return [String]
|
27839
|
+
#
|
27840
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateTopicPermissionsResponse AWS API Documentation
|
27841
|
+
#
|
27842
|
+
class UpdateTopicPermissionsResponse < Struct.new(
|
27843
|
+
:topic_id,
|
27844
|
+
:topic_arn,
|
27845
|
+
:permissions,
|
27846
|
+
:status,
|
27847
|
+
:request_id)
|
27848
|
+
SENSITIVE = []
|
27849
|
+
include Aws::Structure
|
27850
|
+
end
|
27851
|
+
|
27852
|
+
# @!attribute [rw] aws_account_id
|
27853
|
+
# The ID of the Amazon Web Services account that contains the topic
|
27854
|
+
# whose refresh schedule you want to update.
|
27855
|
+
# @return [String]
|
27856
|
+
#
|
27857
|
+
# @!attribute [rw] topic_id
|
27858
|
+
# The ID of the topic that you want to modify. This ID is unique per
|
27859
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
27860
|
+
# @return [String]
|
27861
|
+
#
|
27862
|
+
# @!attribute [rw] dataset_id
|
27863
|
+
# The ID of the dataset.
|
27864
|
+
# @return [String]
|
27865
|
+
#
|
27866
|
+
# @!attribute [rw] refresh_schedule
|
27867
|
+
# The definition of a refresh schedule.
|
27868
|
+
# @return [Types::TopicRefreshSchedule]
|
27869
|
+
#
|
27870
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateTopicRefreshScheduleRequest AWS API Documentation
|
27871
|
+
#
|
27872
|
+
class UpdateTopicRefreshScheduleRequest < Struct.new(
|
27873
|
+
:aws_account_id,
|
27874
|
+
:topic_id,
|
27875
|
+
:dataset_id,
|
27876
|
+
:refresh_schedule)
|
27877
|
+
SENSITIVE = []
|
27878
|
+
include Aws::Structure
|
27879
|
+
end
|
27880
|
+
|
27881
|
+
# @!attribute [rw] topic_id
|
27882
|
+
# The ID of the topic that you want to modify. This ID is unique per
|
27883
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
27884
|
+
# @return [String]
|
27885
|
+
#
|
27886
|
+
# @!attribute [rw] topic_arn
|
27887
|
+
# The Amazon Resource Name (ARN) of the topic.
|
27888
|
+
# @return [String]
|
27889
|
+
#
|
27890
|
+
# @!attribute [rw] dataset_arn
|
27891
|
+
# The Amazon Resource Name (ARN) of the dataset.
|
27892
|
+
# @return [String]
|
27893
|
+
#
|
27894
|
+
# @!attribute [rw] status
|
27895
|
+
# The HTTP status of the request.
|
27896
|
+
# @return [Integer]
|
27897
|
+
#
|
27898
|
+
# @!attribute [rw] request_id
|
27899
|
+
# The Amazon Web Services request ID for this operation.
|
27900
|
+
# @return [String]
|
27901
|
+
#
|
27902
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateTopicRefreshScheduleResponse AWS API Documentation
|
27903
|
+
#
|
27904
|
+
class UpdateTopicRefreshScheduleResponse < Struct.new(
|
27905
|
+
:topic_id,
|
27906
|
+
:topic_arn,
|
27907
|
+
:dataset_arn,
|
27908
|
+
:status,
|
27909
|
+
:request_id)
|
27910
|
+
SENSITIVE = []
|
27911
|
+
include Aws::Structure
|
27912
|
+
end
|
27913
|
+
|
27914
|
+
# @!attribute [rw] aws_account_id
|
27915
|
+
# The ID of the Amazon Web Services account that contains the topic
|
27916
|
+
# that you want to update.
|
27917
|
+
# @return [String]
|
27918
|
+
#
|
27919
|
+
# @!attribute [rw] topic_id
|
27920
|
+
# The ID of the topic that you want to modify. This ID is unique per
|
27921
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
27922
|
+
# @return [String]
|
27923
|
+
#
|
27924
|
+
# @!attribute [rw] topic
|
27925
|
+
# The definition of the topic that you want to update.
|
27926
|
+
# @return [Types::TopicDetails]
|
27927
|
+
#
|
27928
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateTopicRequest AWS API Documentation
|
27929
|
+
#
|
27930
|
+
class UpdateTopicRequest < Struct.new(
|
27931
|
+
:aws_account_id,
|
27932
|
+
:topic_id,
|
27933
|
+
:topic)
|
27934
|
+
SENSITIVE = []
|
27935
|
+
include Aws::Structure
|
27936
|
+
end
|
27937
|
+
|
27938
|
+
# @!attribute [rw] topic_id
|
27939
|
+
# The ID of the topic that you want to modify. This ID is unique per
|
27940
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
27941
|
+
# @return [String]
|
27942
|
+
#
|
27943
|
+
# @!attribute [rw] arn
|
27944
|
+
# The Amazon Resource Name (ARN) of the topic.
|
27945
|
+
# @return [String]
|
27946
|
+
#
|
27947
|
+
# @!attribute [rw] refresh_arn
|
27948
|
+
# The Amazon Resource Name (ARN) of the topic refresh.
|
27949
|
+
# @return [String]
|
27950
|
+
#
|
27951
|
+
# @!attribute [rw] request_id
|
27952
|
+
# The Amazon Web Services request ID for this operation.
|
27953
|
+
# @return [String]
|
27954
|
+
#
|
27955
|
+
# @!attribute [rw] status
|
27956
|
+
# The HTTP status of the request.
|
27957
|
+
# @return [Integer]
|
27958
|
+
#
|
27959
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateTopicResponse AWS API Documentation
|
27960
|
+
#
|
27961
|
+
class UpdateTopicResponse < Struct.new(
|
27962
|
+
:topic_id,
|
27963
|
+
:arn,
|
27964
|
+
:refresh_arn,
|
27965
|
+
:request_id,
|
27966
|
+
:status)
|
27967
|
+
SENSITIVE = []
|
27968
|
+
include Aws::Structure
|
27969
|
+
end
|
27970
|
+
|
24993
27971
|
# @!attribute [rw] user_name
|
24994
27972
|
# The Amazon QuickSight user name that you want to update.
|
24995
27973
|
# @return [String]
|
@@ -25012,12 +27990,12 @@ module Aws::QuickSight
|
|
25012
27990
|
# The Amazon QuickSight role of the user. The role can be one of the
|
25013
27991
|
# following default security cohorts:
|
25014
27992
|
#
|
25015
|
-
# * `READER
|
27993
|
+
# * `READER`: A user who has read-only access to dashboards.
|
25016
27994
|
#
|
25017
|
-
# * `AUTHOR
|
27995
|
+
# * `AUTHOR`: A user who can create data sources, datasets, analyses,
|
25018
27996
|
# and dashboards.
|
25019
27997
|
#
|
25020
|
-
# * `ADMIN
|
27998
|
+
# * `ADMIN`: A user who is an author, who can also manage Amazon
|
25021
27999
|
# QuickSight settings.
|
25022
28000
|
#
|
25023
28001
|
# The name of the Amazon QuickSight role is invisible to the user
|
@@ -25067,17 +28045,17 @@ module Aws::QuickSight
|
|
25067
28045
|
# Identity and Access Management(IAM) role. The type of supported
|
25068
28046
|
# external login provider can be one of the following.
|
25069
28047
|
#
|
25070
|
-
# * `COGNITO
|
28048
|
+
# * `COGNITO`: Amazon Cognito. The provider URL is
|
25071
28049
|
# cognito-identity.amazonaws.com. When choosing the `COGNITO`
|
25072
28050
|
# provider type, don’t use the "CustomFederationProviderUrl"
|
25073
28051
|
# parameter which is only needed when the external provider is
|
25074
28052
|
# custom.
|
25075
28053
|
#
|
25076
|
-
# * `CUSTOM_OIDC
|
28054
|
+
# * `CUSTOM_OIDC`: Custom OpenID Connect (OIDC) provider. When
|
25077
28055
|
# choosing `CUSTOM_OIDC` type, use the `CustomFederationProviderUrl`
|
25078
28056
|
# parameter to provide the custom OIDC provider URL.
|
25079
28057
|
#
|
25080
|
-
# * `NONE
|
28058
|
+
# * `NONE`: This clears all the previously saved external login
|
25081
28059
|
# information for a user. Use the ` DescribeUser ` API operation to
|
25082
28060
|
# check the external login information.
|
25083
28061
|
# @return [String]
|
@@ -25133,6 +28111,91 @@ module Aws::QuickSight
|
|
25133
28111
|
include Aws::Structure
|
25134
28112
|
end
|
25135
28113
|
|
28114
|
+
# @!attribute [rw] aws_account_id
|
28115
|
+
# The Amazon Web Services account ID of the account that contains the
|
28116
|
+
# VPC connection that you want to update.
|
28117
|
+
# @return [String]
|
28118
|
+
#
|
28119
|
+
# @!attribute [rw] vpc_connection_id
|
28120
|
+
# The ID of the VPC connection that you're updating. This ID is a
|
28121
|
+
# unique identifier for each Amazon Web Services Region in an Amazon
|
28122
|
+
# Web Services account.
|
28123
|
+
# @return [String]
|
28124
|
+
#
|
28125
|
+
# @!attribute [rw] name
|
28126
|
+
# The display name for the VPC connection.
|
28127
|
+
# @return [String]
|
28128
|
+
#
|
28129
|
+
# @!attribute [rw] subnet_ids
|
28130
|
+
# A list of subnet IDs for the VPC connection.
|
28131
|
+
# @return [Array<String>]
|
28132
|
+
#
|
28133
|
+
# @!attribute [rw] security_group_ids
|
28134
|
+
# A list of security group IDs for the VPC connection.
|
28135
|
+
# @return [Array<String>]
|
28136
|
+
#
|
28137
|
+
# @!attribute [rw] dns_resolvers
|
28138
|
+
# A list of IP addresses of DNS resolver endpoints for the VPC
|
28139
|
+
# connection.
|
28140
|
+
# @return [Array<String>]
|
28141
|
+
#
|
28142
|
+
# @!attribute [rw] role_arn
|
28143
|
+
# An IAM role associated with the VPC connection.
|
28144
|
+
# @return [String]
|
28145
|
+
#
|
28146
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateVPCConnectionRequest AWS API Documentation
|
28147
|
+
#
|
28148
|
+
class UpdateVPCConnectionRequest < Struct.new(
|
28149
|
+
:aws_account_id,
|
28150
|
+
:vpc_connection_id,
|
28151
|
+
:name,
|
28152
|
+
:subnet_ids,
|
28153
|
+
:security_group_ids,
|
28154
|
+
:dns_resolvers,
|
28155
|
+
:role_arn)
|
28156
|
+
SENSITIVE = []
|
28157
|
+
include Aws::Structure
|
28158
|
+
end
|
28159
|
+
|
28160
|
+
# @!attribute [rw] arn
|
28161
|
+
# The Amazon Resource Name (ARN) of the VPC connection.
|
28162
|
+
# @return [String]
|
28163
|
+
#
|
28164
|
+
# @!attribute [rw] vpc_connection_id
|
28165
|
+
# The ID of the VPC connection that you are updating. This ID is a
|
28166
|
+
# unique identifier for each Amazon Web Services Region in anAmazon
|
28167
|
+
# Web Services account.
|
28168
|
+
# @return [String]
|
28169
|
+
#
|
28170
|
+
# @!attribute [rw] update_status
|
28171
|
+
# The update status of the VPC connection's last update.
|
28172
|
+
# @return [String]
|
28173
|
+
#
|
28174
|
+
# @!attribute [rw] availability_status
|
28175
|
+
# The availability status of the VPC connection.
|
28176
|
+
# @return [String]
|
28177
|
+
#
|
28178
|
+
# @!attribute [rw] request_id
|
28179
|
+
# The Amazon Web Services request ID for this operation.
|
28180
|
+
# @return [String]
|
28181
|
+
#
|
28182
|
+
# @!attribute [rw] status
|
28183
|
+
# The HTTP status of the request.
|
28184
|
+
# @return [Integer]
|
28185
|
+
#
|
28186
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateVPCConnectionResponse AWS API Documentation
|
28187
|
+
#
|
28188
|
+
class UpdateVPCConnectionResponse < Struct.new(
|
28189
|
+
:arn,
|
28190
|
+
:vpc_connection_id,
|
28191
|
+
:update_status,
|
28192
|
+
:availability_status,
|
28193
|
+
:request_id,
|
28194
|
+
:status)
|
28195
|
+
SENSITIVE = []
|
28196
|
+
include Aws::Structure
|
28197
|
+
end
|
28198
|
+
|
25136
28199
|
# Information about the format for a source file or files.
|
25137
28200
|
#
|
25138
28201
|
# @!attribute [rw] format
|
@@ -25189,19 +28252,17 @@ module Aws::QuickSight
|
|
25189
28252
|
# The Amazon QuickSight role for the user. The user role can be one of
|
25190
28253
|
# the following:.
|
25191
28254
|
#
|
25192
|
-
# * `READER
|
28255
|
+
# * `READER`: A user who has read-only access to dashboards.
|
25193
28256
|
#
|
25194
|
-
# * `AUTHOR
|
28257
|
+
# * `AUTHOR`: A user who can create data sources, datasets, analyses,
|
25195
28258
|
# and dashboards.
|
25196
28259
|
#
|
25197
|
-
# * `ADMIN
|
28260
|
+
# * `ADMIN`: A user who is an author, who can also manage Amazon
|
25198
28261
|
# Amazon QuickSight settings.
|
25199
28262
|
#
|
25200
|
-
# * `RESTRICTED_READER
|
25201
|
-
# use.
|
28263
|
+
# * `RESTRICTED_READER`: This role isn't currently available for use.
|
25202
28264
|
#
|
25203
|
-
# * `RESTRICTED_AUTHOR
|
25204
|
-
# use.
|
28265
|
+
# * `RESTRICTED_AUTHOR`: This role isn't currently available for use.
|
25205
28266
|
# @return [String]
|
25206
28267
|
#
|
25207
28268
|
# @!attribute [rw] identity_type
|
@@ -25227,10 +28288,10 @@ module Aws::QuickSight
|
|
25227
28288
|
# to let the user federate into Amazon QuickSight with an associated
|
25228
28289
|
# IAM role. The type can be one of the following.
|
25229
28290
|
#
|
25230
|
-
# * `COGNITO
|
28291
|
+
# * `COGNITO`: Amazon Cognito. The provider URL is
|
25231
28292
|
# cognito-identity.amazonaws.com.
|
25232
28293
|
#
|
25233
|
-
# * `CUSTOM_OIDC
|
28294
|
+
# * `CUSTOM_OIDC`: Custom OpenID Connect (OIDC) provider.
|
25234
28295
|
# @return [String]
|
25235
28296
|
#
|
25236
28297
|
# @!attribute [rw] external_login_federation_provider_url
|
@@ -25259,6 +28320,152 @@ module Aws::QuickSight
|
|
25259
28320
|
include Aws::Structure
|
25260
28321
|
end
|
25261
28322
|
|
28323
|
+
# The structure of a VPC connection.
|
28324
|
+
#
|
28325
|
+
# @!attribute [rw] vpc_connection_id
|
28326
|
+
# The ID of the VPC connection that you're creating. This ID is a
|
28327
|
+
# unique identifier for each Amazon Web Services Region in an Amazon
|
28328
|
+
# Web Services account.
|
28329
|
+
# @return [String]
|
28330
|
+
#
|
28331
|
+
# @!attribute [rw] arn
|
28332
|
+
# The Amazon Resource Name (ARN) of the VPC connection.
|
28333
|
+
# @return [String]
|
28334
|
+
#
|
28335
|
+
# @!attribute [rw] name
|
28336
|
+
# The display name for the VPC connection.
|
28337
|
+
# @return [String]
|
28338
|
+
#
|
28339
|
+
# @!attribute [rw] vpc_id
|
28340
|
+
# The Amazon EC2 VPC ID associated with the VPC connection.
|
28341
|
+
# @return [String]
|
28342
|
+
#
|
28343
|
+
# @!attribute [rw] security_group_ids
|
28344
|
+
# The Amazon EC2 security group IDs associated with the VPC
|
28345
|
+
# connection.
|
28346
|
+
# @return [Array<String>]
|
28347
|
+
#
|
28348
|
+
# @!attribute [rw] dns_resolvers
|
28349
|
+
# A list of IP addresses of DNS resolver endpoints for the VPC
|
28350
|
+
# connection.
|
28351
|
+
# @return [Array<String>]
|
28352
|
+
#
|
28353
|
+
# @!attribute [rw] status
|
28354
|
+
# The status of the VPC connection.
|
28355
|
+
# @return [String]
|
28356
|
+
#
|
28357
|
+
# @!attribute [rw] availability_status
|
28358
|
+
# The availability status of the VPC connection.
|
28359
|
+
# @return [String]
|
28360
|
+
#
|
28361
|
+
# @!attribute [rw] network_interfaces
|
28362
|
+
# A list of network interfaces.
|
28363
|
+
# @return [Array<Types::NetworkInterface>]
|
28364
|
+
#
|
28365
|
+
# @!attribute [rw] role_arn
|
28366
|
+
# The ARN of the IAM role associated with the VPC connection.
|
28367
|
+
# @return [String]
|
28368
|
+
#
|
28369
|
+
# @!attribute [rw] created_time
|
28370
|
+
# The time that the VPC connection was created.
|
28371
|
+
# @return [Time]
|
28372
|
+
#
|
28373
|
+
# @!attribute [rw] last_updated_time
|
28374
|
+
# The time that the VPC connection was last updated.
|
28375
|
+
# @return [Time]
|
28376
|
+
#
|
28377
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/VPCConnection AWS API Documentation
|
28378
|
+
#
|
28379
|
+
class VPCConnection < Struct.new(
|
28380
|
+
:vpc_connection_id,
|
28381
|
+
:arn,
|
28382
|
+
:name,
|
28383
|
+
:vpc_id,
|
28384
|
+
:security_group_ids,
|
28385
|
+
:dns_resolvers,
|
28386
|
+
:status,
|
28387
|
+
:availability_status,
|
28388
|
+
:network_interfaces,
|
28389
|
+
:role_arn,
|
28390
|
+
:created_time,
|
28391
|
+
:last_updated_time)
|
28392
|
+
SENSITIVE = []
|
28393
|
+
include Aws::Structure
|
28394
|
+
end
|
28395
|
+
|
28396
|
+
# The summary metadata that describes a VPC connection.
|
28397
|
+
#
|
28398
|
+
# @!attribute [rw] vpc_connection_id
|
28399
|
+
# The ID of the VPC connection that you're creating. This ID is a
|
28400
|
+
# unique identifier for each Amazon Web Services Region in an Amazon
|
28401
|
+
# Web Services account.
|
28402
|
+
# @return [String]
|
28403
|
+
#
|
28404
|
+
# @!attribute [rw] arn
|
28405
|
+
# The Amazon Resource Name (ARN) of the VPC connection.
|
28406
|
+
# @return [String]
|
28407
|
+
#
|
28408
|
+
# @!attribute [rw] name
|
28409
|
+
# The display name for the VPC connection.
|
28410
|
+
# @return [String]
|
28411
|
+
#
|
28412
|
+
# @!attribute [rw] vpc_id
|
28413
|
+
# The Amazon EC2 VPC ID associated with the VPC connection.
|
28414
|
+
# @return [String]
|
28415
|
+
#
|
28416
|
+
# @!attribute [rw] security_group_ids
|
28417
|
+
# The Amazon EC2 security group IDs associated with the VPC
|
28418
|
+
# connection.
|
28419
|
+
# @return [Array<String>]
|
28420
|
+
#
|
28421
|
+
# @!attribute [rw] dns_resolvers
|
28422
|
+
# A list of IP addresses of DNS resolver endpoints for the VPC
|
28423
|
+
# connection.
|
28424
|
+
# @return [Array<String>]
|
28425
|
+
#
|
28426
|
+
# @!attribute [rw] status
|
28427
|
+
# The status of the VPC connection.
|
28428
|
+
# @return [String]
|
28429
|
+
#
|
28430
|
+
# @!attribute [rw] availability_status
|
28431
|
+
# The availability status of the VPC connection.
|
28432
|
+
# @return [String]
|
28433
|
+
#
|
28434
|
+
# @!attribute [rw] network_interfaces
|
28435
|
+
# A list of network interfaces.
|
28436
|
+
# @return [Array<Types::NetworkInterface>]
|
28437
|
+
#
|
28438
|
+
# @!attribute [rw] role_arn
|
28439
|
+
# The ARN of the IAM role associated with the VPC connection.
|
28440
|
+
# @return [String]
|
28441
|
+
#
|
28442
|
+
# @!attribute [rw] created_time
|
28443
|
+
# The time that the VPC connection was created.
|
28444
|
+
# @return [Time]
|
28445
|
+
#
|
28446
|
+
# @!attribute [rw] last_updated_time
|
28447
|
+
# The time that the VPC connection was last updated.
|
28448
|
+
# @return [Time]
|
28449
|
+
#
|
28450
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/VPCConnectionSummary AWS API Documentation
|
28451
|
+
#
|
28452
|
+
class VPCConnectionSummary < Struct.new(
|
28453
|
+
:vpc_connection_id,
|
28454
|
+
:arn,
|
28455
|
+
:name,
|
28456
|
+
:vpc_id,
|
28457
|
+
:security_group_ids,
|
28458
|
+
:dns_resolvers,
|
28459
|
+
:status,
|
28460
|
+
:availability_status,
|
28461
|
+
:network_interfaces,
|
28462
|
+
:role_arn,
|
28463
|
+
:created_time,
|
28464
|
+
:last_updated_time)
|
28465
|
+
SENSITIVE = []
|
28466
|
+
include Aws::Structure
|
28467
|
+
end
|
28468
|
+
|
25262
28469
|
# The range options for the data zoom scroll bar.
|
25263
28470
|
#
|
25264
28471
|
# @!attribute [rw] percent_range
|
@@ -25587,10 +28794,10 @@ module Aws::QuickSight
|
|
25587
28794
|
#
|
25588
28795
|
# Valid values are defined as follows:
|
25589
28796
|
#
|
25590
|
-
# * `DATA_POINT_CLICK
|
28797
|
+
# * `DATA_POINT_CLICK`: Initiates a custom action by a left pointer
|
25591
28798
|
# click on a data point.
|
25592
28799
|
#
|
25593
|
-
# * `DATA_POINT_MENU
|
28800
|
+
# * `DATA_POINT_MENU`: Initiates a custom action by right pointer
|
25594
28801
|
# click from the menu.
|
25595
28802
|
# @return [String]
|
25596
28803
|
#
|