aws-sdk-quicksight 1.78.0 → 1.79.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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,6 +2005,25 @@ 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
@@ -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
@@ -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. It must be unique
3885
- # within an Amazon Web Services account.
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. This name must be unique within the
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
  #
@@ -4479,6 +4558,227 @@ module Aws::QuickSight
4479
4558
  include Aws::Structure
4480
4559
  end
4481
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
+
4482
4782
  # The combination of user name and password that are used as
4483
4783
  # credentials.
4484
4784
  #
@@ -5417,6 +5717,26 @@ module Aws::QuickSight
5417
5717
  include Aws::Structure
5418
5718
  end
5419
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
+
5420
5740
  # The options for data bars.
5421
5741
  #
5422
5742
  # @!attribute [rw] field_id
@@ -5558,6 +5878,10 @@ module Aws::QuickSight
5558
5878
  # labels.
5559
5879
  # @return [String]
5560
5880
  #
5881
+ # @!attribute [rw] totals_visibility
5882
+ # Determines the visibility of the total.
5883
+ # @return [String]
5884
+ #
5561
5885
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataLabelOptions AWS API Documentation
5562
5886
  #
5563
5887
  class DataLabelOptions < Struct.new(
@@ -5569,7 +5893,8 @@ module Aws::QuickSight
5569
5893
  :label_content,
5570
5894
  :label_font_configuration,
5571
5895
  :label_color,
5572
- :overlap)
5896
+ :overlap,
5897
+ :totals_visibility)
5573
5898
  SENSITIVE = []
5574
5899
  include Aws::Structure
5575
5900
  end
@@ -5818,6 +6143,10 @@ module Aws::QuickSight
5818
6143
  # this dataset as a source.
5819
6144
  # @return [Types::DataSetUsageConfiguration]
5820
6145
  #
6146
+ # @!attribute [rw] dataset_parameters
6147
+ # The parameters that are declared in a dataset.
6148
+ # @return [Array<Types::DatasetParameter>]
6149
+ #
5821
6150
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSet AWS API Documentation
5822
6151
  #
5823
6152
  class DataSet < Struct.new(
@@ -5836,7 +6165,8 @@ module Aws::QuickSight
5836
6165
  :row_level_permission_data_set,
5837
6166
  :row_level_permission_tag_configuration,
5838
6167
  :column_level_permission_rules,
5839
- :data_set_usage_configuration)
6168
+ :data_set_usage_configuration,
6169
+ :dataset_parameters)
5840
6170
  SENSITIVE = []
5841
6171
  include Aws::Structure
5842
6172
  end
@@ -6477,6 +6807,84 @@ module Aws::QuickSight
6477
6807
  include Aws::Structure
6478
6808
  end
6479
6809
 
6810
+ # A structure that represents a dataset.
6811
+ #
6812
+ # @!attribute [rw] dataset_arn
6813
+ # The Amazon Resource Name (ARN) of the dataset.
6814
+ # @return [String]
6815
+ #
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
+
6480
6888
  # The options that determine how a date axis is displayed.
6481
6889
  #
6482
6890
  # @!attribute [rw] missing_date_visibility
@@ -6573,29 +6981,79 @@ module Aws::QuickSight
6573
6981
  include Aws::Structure
6574
6982
  end
6575
6983
 
6576
- # The default values of the `DateTimeParameterDeclaration`.
6984
+ # A date time parameter for a dataset.
6577
6985
  #
6578
- # @!attribute [rw] dynamic_value
6579
- # The dynamic value of the `DataTimeDefaultValues`. Different defaults
6580
- # are displayed according to users, groups, and values mapping.
6581
- # @return [Types::DynamicDefaultValue]
6986
+ # @!attribute [rw] id
6987
+ # An identifier for the parameter that is created in the dataset.
6988
+ # @return [String]
6582
6989
  #
6583
- # @!attribute [rw] static_values
6584
- # The static values of the `DataTimeDefaultValues`.
6585
- # @return [Array<Time>]
6990
+ # @!attribute [rw] name
6991
+ # The name of the date time parameter that is created in the dataset.
6992
+ # @return [String]
6586
6993
  #
6587
- # @!attribute [rw] rolling_date
6588
- # The rolling date of the `DataTimeDefaultValues`. The date is
6589
- # determined from the dataset based on input expression.
6590
- # @return [Types::RollingDateConfiguration]
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]
6591
6998
  #
6592
- # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DateTimeDefaultValues AWS API Documentation
6999
+ # @!attribute [rw] time_granularity
7000
+ # The time granularity of the date time parameter.
7001
+ # @return [String]
6593
7002
  #
6594
- class DateTimeDefaultValues < Struct.new(
6595
- :dynamic_value,
6596
- :static_values,
6597
- :rolling_date)
6598
- SENSITIVE = []
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
+
7034
+ # The default values of the `DateTimeParameterDeclaration`.
7035
+ #
7036
+ # @!attribute [rw] dynamic_value
7037
+ # The dynamic value of the `DataTimeDefaultValues`. Different defaults
7038
+ # are displayed according to users, groups, and values mapping.
7039
+ # @return [Types::DynamicDefaultValue]
7040
+ #
7041
+ # @!attribute [rw] static_values
7042
+ # The static values of the `DataTimeDefaultValues`.
7043
+ # @return [Array<Time>]
7044
+ #
7045
+ # @!attribute [rw] rolling_date
7046
+ # The rolling date of the `DataTimeDefaultValues`. The date is
7047
+ # determined from the dataset based on input expression.
7048
+ # @return [Types::RollingDateConfiguration]
7049
+ #
7050
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DateTimeDefaultValues AWS API Documentation
7051
+ #
7052
+ class DateTimeDefaultValues < Struct.new(
7053
+ :dynamic_value,
7054
+ :static_values,
7055
+ :rolling_date)
7056
+ SENSITIVE = []
6599
7057
  include Aws::Structure
6600
7058
  end
6601
7059
 
@@ -6684,13 +7142,19 @@ module Aws::QuickSight
6684
7142
  # parameter when a value has not been set.
6685
7143
  # @return [Types::DateTimeValueWhenUnsetConfiguration]
6686
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
+ #
6687
7150
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DateTimeParameterDeclaration AWS API Documentation
6688
7151
  #
6689
7152
  class DateTimeParameterDeclaration < Struct.new(
6690
7153
  :name,
6691
7154
  :default_values,
6692
7155
  :time_granularity,
6693
- :value_when_unset)
7156
+ :value_when_unset,
7157
+ :mapped_data_set_parameters)
6694
7158
  SENSITIVE = []
6695
7159
  include Aws::Structure
6696
7160
  end
@@ -6740,6 +7204,51 @@ module Aws::QuickSight
6740
7204
  include Aws::Structure
6741
7205
  end
6742
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
+
6743
7252
  # The default values of the `DecimalParameterDeclaration`.
6744
7253
  #
6745
7254
  # @!attribute [rw] dynamic_value
@@ -6801,13 +7310,19 @@ module Aws::QuickSight
6801
7310
  # parameter when a value has not been set.
6802
7311
  # @return [Types::DecimalValueWhenUnsetConfiguration]
6803
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
+ #
6804
7318
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DecimalParameterDeclaration AWS API Documentation
6805
7319
  #
6806
7320
  class DecimalParameterDeclaration < Struct.new(
6807
7321
  :parameter_value_type,
6808
7322
  :name,
6809
7323
  :default_values,
6810
- :value_when_unset)
7324
+ :value_when_unset,
7325
+ :mapped_data_set_parameters)
6811
7326
  SENSITIVE = []
6812
7327
  include Aws::Structure
6813
7328
  end
@@ -6852,6 +7367,26 @@ module Aws::QuickSight
6852
7367
  include Aws::Structure
6853
7368
  end
6854
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
+
6855
7390
  # The options that determine the default settings of a free-form layout
6856
7391
  # configuration.
6857
7392
  #
@@ -7799,6 +8334,109 @@ module Aws::QuickSight
7799
8334
  include Aws::Structure
7800
8335
  end
7801
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
+
7802
8440
  # @!attribute [rw] principal_id
7803
8441
  # The principal ID of the user.
7804
8442
  # @return [String]
@@ -7881,6 +8519,65 @@ module Aws::QuickSight
7881
8519
  include Aws::Structure
7882
8520
  end
7883
8521
 
8522
+ # @!attribute [rw] aws_account_id
8523
+ # The Amazon Web Services account ID of the account where you want to
8524
+ # delete a VPC connection.
8525
+ # @return [String]
8526
+ #
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.
8531
+ # @return [String]
8532
+ #
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
+
7884
8581
  # @!attribute [rw] aws_account_id
7885
8582
  # The ID for the Amazon Web Services account that you want to describe
7886
8583
  # Amazon QuickSight customizations for.
@@ -9536,90 +10233,352 @@ module Aws::QuickSight
9536
10233
  include Aws::Structure
9537
10234
  end
9538
10235
 
9539
- # @!attribute [rw] user_name
9540
- # The name of the user that you want to describe.
9541
- # @return [String]
9542
- #
9543
10236
  # @!attribute [rw] aws_account_id
9544
- # The ID for the Amazon Web Services account that the user is in.
9545
- # Currently, you use the ID for the Amazon Web Services account that
9546
- # contains your Amazon QuickSight account.
10237
+ # The ID of the Amazon Web Services account that contains the topic
10238
+ # that you want described.
9547
10239
  # @return [String]
9548
10240
  #
9549
- # @!attribute [rw] namespace
9550
- # The namespace. Currently, you should set this to `default`.
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.
9551
10244
  # @return [String]
9552
10245
  #
9553
- # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeUserRequest AWS API Documentation
10246
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTopicPermissionsRequest AWS API Documentation
9554
10247
  #
9555
- class DescribeUserRequest < Struct.new(
9556
- :user_name,
10248
+ class DescribeTopicPermissionsRequest < Struct.new(
9557
10249
  :aws_account_id,
9558
- :namespace)
10250
+ :topic_id)
9559
10251
  SENSITIVE = []
9560
10252
  include Aws::Structure
9561
10253
  end
9562
10254
 
9563
- # @!attribute [rw] user
9564
- # The user name.
9565
- # @return [Types::User]
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]
9566
10259
  #
9567
- # @!attribute [rw] request_id
9568
- # The Amazon Web Services request ID for this operation.
10260
+ # @!attribute [rw] topic_arn
10261
+ # The Amazon Resource Name (ARN) of the topic.
9569
10262
  # @return [String]
9570
10263
  #
10264
+ # @!attribute [rw] permissions
10265
+ # A list of resource permissions that are configured to the topic.
10266
+ # @return [Array<Types::ResourcePermission>]
10267
+ #
9571
10268
  # @!attribute [rw] status
9572
10269
  # The HTTP status of the request.
9573
10270
  # @return [Integer]
9574
10271
  #
9575
- # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeUserResponse AWS API Documentation
10272
+ # @!attribute [rw] request_id
10273
+ # The Amazon Web Services request ID for this operation.
10274
+ # @return [String]
9576
10275
  #
9577
- class DescribeUserResponse < Struct.new(
9578
- :user,
9579
- :request_id,
9580
- :status)
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)
9581
10284
  SENSITIVE = []
9582
10285
  include Aws::Structure
9583
10286
  end
9584
10287
 
9585
- # The configuration of destination parameter values.
9586
- #
9587
- # This is a union type structure. For this structure to be valid, only
9588
- # one of the attributes can be defined.
9589
- #
9590
- # @!attribute [rw] custom_values_configuration
9591
- # The configuration of custom values for destination parameter in
9592
- # `DestinationParameterValueConfiguration`.
9593
- # @return [Types::CustomValuesConfiguration]
9594
- #
9595
- # @!attribute [rw] select_all_value_options
9596
- # 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.
9597
10291
  # @return [String]
9598
10292
  #
9599
- # @!attribute [rw] source_parameter_name
9600
- # The source parameter name of the destination parameter.
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.
9601
10296
  # @return [String]
9602
10297
  #
9603
- # @!attribute [rw] source_field
9604
- # The source field ID of the destination parameter.
10298
+ # @!attribute [rw] refresh_id
10299
+ # The ID of the refresh, which is performed when the topic is created
10300
+ # or updated.
9605
10301
  # @return [String]
9606
10302
  #
9607
- # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DestinationParameterValueConfiguration AWS API Documentation
10303
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTopicRefreshRequest AWS API Documentation
9608
10304
  #
9609
- class DestinationParameterValueConfiguration < Struct.new(
9610
- :custom_values_configuration,
9611
- :select_all_value_options,
9612
- :source_parameter_name,
9613
- :source_field)
10305
+ class DescribeTopicRefreshRequest < Struct.new(
10306
+ :aws_account_id,
10307
+ :topic_id,
10308
+ :refresh_id)
9614
10309
  SENSITIVE = []
9615
10310
  include Aws::Structure
9616
10311
  end
9617
10312
 
9618
- # The dimension type field.
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]
9619
10317
  #
9620
- # @!attribute [rw] numerical_dimension_field
9621
- # The dimension type field with numerical type columns.
9622
- # @return [Types::NumericalDimensionField]
10318
+ # @!attribute [rw] request_id
10319
+ # The Amazon Web Services request ID for this operation.
10320
+ # @return [String]
10321
+ #
10322
+ # @!attribute [rw] status
10323
+ # The HTTP status of the request.
10324
+ # @return [Integer]
10325
+ #
10326
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTopicRefreshResponse AWS API Documentation
10327
+ #
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]
10339
+ #
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)
10356
+ SENSITIVE = []
10357
+ include Aws::Structure
10358
+ end
10359
+
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]
10365
+ #
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.
10372
+ # @return [String]
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
+ #
10382
+ # @!attribute [rw] request_id
10383
+ # The Amazon Web Services request ID for this operation.
10384
+ # @return [String]
10385
+ #
10386
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTopicRefreshScheduleResponse AWS API Documentation
10387
+ #
10388
+ class DescribeTopicRefreshScheduleResponse < Struct.new(
10389
+ :topic_id,
10390
+ :topic_arn,
10391
+ :dataset_arn,
10392
+ :refresh_schedule,
10393
+ :status,
10394
+ :request_id)
10395
+ SENSITIVE = []
10396
+ include Aws::Structure
10397
+ end
10398
+
10399
+ # @!attribute [rw] aws_account_id
10400
+ # The Amazon Web Services account ID.
10401
+ # @return [String]
10402
+ #
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.
10406
+ # @return [String]
10407
+ #
10408
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTopicRequest AWS API Documentation
10409
+ #
10410
+ class DescribeTopicRequest < Struct.new(
10411
+ :aws_account_id,
10412
+ :topic_id)
10413
+ SENSITIVE = []
10414
+ include Aws::Structure
10415
+ end
10416
+
10417
+ # @!attribute [rw] arn
10418
+ # The Amazon Resource Name (ARN) of the topic.
10419
+ # @return [String]
10420
+ #
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]
10425
+ #
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]
9623
10582
  #
9624
10583
  # @!attribute [rw] categorical_dimension_field
9625
10584
  # The dimension type field with categorical type columns.
@@ -9639,6 +10598,76 @@ module Aws::QuickSight
9639
10598
  include Aws::Structure
9640
10599
  end
9641
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
+
9642
10671
  # The domain specified isn't on the allow list. All domains for
9643
10672
  # embedded dashboards must be added to the approved list by an Amazon
9644
10673
  # QuickSight admin.
@@ -10697,11 +11726,16 @@ module Aws::QuickSight
10697
11726
  # ^
10698
11727
  # @return [String]
10699
11728
  #
11729
+ # @!attribute [rw] selected_columns
11730
+ # The selected columns of a dataset.
11731
+ # @return [Array<Types::ColumnIdentifier>]
11732
+ #
10700
11733
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FilterOperationSelectedFieldsConfiguration AWS API Documentation
10701
11734
  #
10702
11735
  class FilterOperationSelectedFieldsConfiguration < Struct.new(
10703
11736
  :selected_fields,
10704
- :selected_field_options)
11737
+ :selected_field_options,
11738
+ :selected_columns)
10705
11739
  SENSITIVE = []
10706
11740
  include Aws::Structure
10707
11741
  end
@@ -13367,21 +14401,66 @@ module Aws::QuickSight
13367
14401
  include Aws::Structure
13368
14402
  end
13369
14403
 
13370
- # The default values of the `IntegerParameterDeclaration`.
14404
+ # An integer parameter for a dataset.
13371
14405
  #
13372
- # @!attribute [rw] dynamic_value
13373
- # The dynamic value of the `IntegerDefaultValues`. Different defaults
13374
- # are displayed according to users, groups, and values mapping.
13375
- # @return [Types::DynamicDefaultValue]
14406
+ # @!attribute [rw] id
14407
+ # An identifier for the integer parameter created in the dataset.
14408
+ # @return [String]
13376
14409
  #
13377
- # @!attribute [rw] static_values
13378
- # The static values of the `IntegerDefaultValues`.
13379
- # @return [Array<Integer>]
14410
+ # @!attribute [rw] name
14411
+ # The name of the integer parameter that is created in the dataset.
14412
+ # @return [String]
13380
14413
  #
13381
- # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/IntegerDefaultValues AWS API Documentation
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]
13382
14418
  #
13383
- class IntegerDefaultValues < Struct.new(
13384
- :dynamic_value,
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
14461
+ #
14462
+ class IntegerDefaultValues < Struct.new(
14463
+ :dynamic_value,
13385
14464
  :static_values)
13386
14465
  SENSITIVE = []
13387
14466
  include Aws::Structure
@@ -13427,13 +14506,19 @@ module Aws::QuickSight
13427
14506
  # A parameter declaration for the `Integer` data type.
13428
14507
  # @return [Types::IntegerValueWhenUnsetConfiguration]
13429
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
+ #
13430
14514
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/IntegerParameterDeclaration AWS API Documentation
13431
14515
  #
13432
14516
  class IntegerParameterDeclaration < Struct.new(
13433
14517
  :parameter_value_type,
13434
14518
  :name,
13435
14519
  :default_values,
13436
- :value_when_unset)
14520
+ :value_when_unset,
14521
+ :mapped_data_set_parameters)
13437
14522
  SENSITIVE = []
13438
14523
  include Aws::Structure
13439
14524
  end
@@ -15626,6 +16711,110 @@ module Aws::QuickSight
15626
16711
  include Aws::Structure
15627
16712
  end
15628
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
+
15629
16818
  # @!attribute [rw] user_name
15630
16819
  # The Amazon QuickSight user name that you want to list group
15631
16820
  # memberships for.
@@ -15744,6 +16933,59 @@ module Aws::QuickSight
15744
16933
  include Aws::Structure
15745
16934
  end
15746
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
+
15747
16989
  # The configuration of loading animation in free-form layout.
15748
16990
  #
15749
16991
  # @!attribute [rw] visibility
@@ -15894,6 +17136,26 @@ module Aws::QuickSight
15894
17136
  include Aws::Structure
15895
17137
  end
15896
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
+
15897
17159
  # The display options for margins around the outside edge of sheets.
15898
17160
  #
15899
17161
  # @!attribute [rw] show
@@ -16129,6 +17391,64 @@ module Aws::QuickSight
16129
17391
  include Aws::Structure
16130
17392
  end
16131
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
+
16132
17452
  # Errors that occur during namespace creation.
16133
17453
  #
16134
17454
  # @!attribute [rw] type
@@ -16188,6 +17508,25 @@ module Aws::QuickSight
16188
17508
  include Aws::Structure
16189
17509
  end
16190
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
+
16191
17530
  # The options that determine the negative value configuration.
16192
17531
  #
16193
17532
  # @!attribute [rw] display_mode
@@ -16202,6 +17541,70 @@ module Aws::QuickSight
16202
17541
  include Aws::Structure
16203
17542
  end
16204
17543
 
17544
+ # The structure that contains information about a network interface.
17545
+ #
17546
+ # @!attribute [rw] subnet_id
17547
+ # The subnet ID associated with the network interface.
17548
+ # @return [String]
17549
+ #
17550
+ # @!attribute [rw] availability_zone
17551
+ # The availability zone that the network interface resides in.
17552
+ # @return [String]
17553
+ #
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
+
16205
17608
  # The options that determine the null value format configuration.
16206
17609
  #
16207
17610
  # @!attribute [rw] null_string
@@ -16621,11 +18024,11 @@ module Aws::QuickSight
16621
18024
  # @return [String]
16622
18025
  #
16623
18026
  # @!attribute [rw] port
16624
- # Port.
18027
+ # The port.
16625
18028
  # @return [Integer]
16626
18029
  #
16627
18030
  # @!attribute [rw] database
16628
- # Database.
18031
+ # The database.
16629
18032
  # @return [String]
16630
18033
  #
16631
18034
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/OracleParameters AWS API Documentation
@@ -16649,7 +18052,7 @@ module Aws::QuickSight
16649
18052
  # @return [String]
16650
18053
  #
16651
18054
  # @!attribute [rw] type
16652
- # Type.
18055
+ # The type.
16653
18056
  # @return [String]
16654
18057
  #
16655
18058
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/OutputColumn AWS API Documentation
@@ -16662,6 +18065,31 @@ module Aws::QuickSight
16662
18065
  include Aws::Structure
16663
18066
  end
16664
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
+
16665
18093
  # The pagination configuration for a table visual or boxplot.
16666
18094
  #
16667
18095
  # @!attribute [rw] page_size
@@ -18416,10 +19844,29 @@ module Aws::QuickSight
18416
19844
  include Aws::Structure
18417
19845
  end
18418
19846
 
18419
- # The range ends label type of a data path label.
19847
+ # A structure that represents a range constant.
18420
19848
  #
18421
- # @!attribute [rw] visibility
18422
- # The visibility of the range ends label.
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
+
19866
+ # The range ends label type of a data path label.
19867
+ #
19868
+ # @!attribute [rw] visibility
19869
+ # The visibility of the range ends label.
18423
19870
  # @return [String]
18424
19871
  #
18425
19872
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RangeEndsLabelType AWS API Documentation
@@ -19034,10 +20481,16 @@ module Aws::QuickSight
19034
20481
  # The state persistence settings of an embedded dashboard.
19035
20482
  # @return [Types::StatePersistenceConfigurations]
19036
20483
  #
20484
+ # @!attribute [rw] bookmarks
20485
+ # The bookmarks configuration for an embedded dashboard in Amazon
20486
+ # QuickSight.
20487
+ # @return [Types::BookmarksConfigurations]
20488
+ #
19037
20489
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisteredUserDashboardFeatureConfigurations AWS API Documentation
19038
20490
  #
19039
20491
  class RegisteredUserDashboardFeatureConfigurations < Struct.new(
19040
- :state_persistence)
20492
+ :state_persistence,
20493
+ :bookmarks)
19041
20494
  SENSITIVE = []
19042
20495
  include Aws::Structure
19043
20496
  end
@@ -19919,13 +21372,18 @@ module Aws::QuickSight
19919
21372
  # The size field well of a scatter plot.
19920
21373
  # @return [Array<Types::MeasureField>]
19921
21374
  #
21375
+ # @!attribute [rw] label
21376
+ # The label field well of a scatter plot.
21377
+ # @return [Array<Types::DimensionField>]
21378
+ #
19922
21379
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ScatterPlotCategoricallyAggregatedFieldWells AWS API Documentation
19923
21380
  #
19924
21381
  class ScatterPlotCategoricallyAggregatedFieldWells < Struct.new(
19925
21382
  :x_axis,
19926
21383
  :y_axis,
19927
21384
  :category,
19928
- :size)
21385
+ :size,
21386
+ :label)
19929
21387
  SENSITIVE = []
19930
21388
  include Aws::Structure
19931
21389
  end
@@ -19994,16 +21452,14 @@ module Aws::QuickSight
19994
21452
  # one of the attributes can be defined.
19995
21453
  #
19996
21454
  # @!attribute [rw] scatter_plot_categorically_aggregated_field_wells
19997
- # The aggregated field wells of a scatter plot. Scatter plots that
19998
- # have a field in the category (group/color) field will have
19999
- # aggregated field wells. The x and y-axes of these scatter plots are
20000
- # 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.
20001
21458
  # @return [Types::ScatterPlotCategoricallyAggregatedFieldWells]
20002
21459
  #
20003
21460
  # @!attribute [rw] scatter_plot_unaggregated_field_wells
20004
- # The unaggregated field wells of a scatter plot. Scatter plots
20005
- # without a category field well have unaggregated field wells. The x
20006
- # 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.
20007
21463
  # @return [Types::ScatterPlotUnaggregatedFieldWells]
20008
21464
  #
20009
21465
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ScatterPlotFieldWells AWS API Documentation
@@ -20033,12 +21489,22 @@ module Aws::QuickSight
20033
21489
  # The size field well of a scatter plot.
20034
21490
  # @return [Array<Types::MeasureField>]
20035
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
+ #
20036
21500
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ScatterPlotUnaggregatedFieldWells AWS API Documentation
20037
21501
  #
20038
21502
  class ScatterPlotUnaggregatedFieldWells < Struct.new(
20039
21503
  :x_axis,
20040
21504
  :y_axis,
20041
- :size)
21505
+ :size,
21506
+ :category,
21507
+ :label)
20042
21508
  SENSITIVE = []
20043
21509
  include Aws::Structure
20044
21510
  end
@@ -20656,6 +22122,74 @@ module Aws::QuickSight
20656
22122
  include Aws::Structure
20657
22123
  end
20658
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
+
20659
22193
  # The series item configuration of a line chart.
20660
22194
  #
20661
22195
  # This is a union type structure. For this structure to be valid, only
@@ -21297,6 +22831,52 @@ module Aws::QuickSight
21297
22831
  include Aws::Structure
21298
22832
  end
21299
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
+
21300
22880
  # The default values of the `StringParameterDeclaration`.
21301
22881
  #
21302
22882
  # @!attribute [rw] dynamic_value
@@ -21377,13 +22957,19 @@ module Aws::QuickSight
21377
22957
  # parameter when a value has not been set.
21378
22958
  # @return [Types::StringValueWhenUnsetConfiguration]
21379
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
+ #
21380
22965
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/StringParameterDeclaration AWS API Documentation
21381
22966
  #
21382
22967
  class StringParameterDeclaration < Struct.new(
21383
22968
  :parameter_value_type,
21384
22969
  :name,
21385
22970
  :default_values,
21386
- :value_when_unset)
22971
+ :value_when_unset,
22972
+ :mapped_data_set_parameters)
21387
22973
  SENSITIVE = []
21388
22974
  include Aws::Structure
21389
22975
  end
@@ -23312,178 +24898,846 @@ module Aws::QuickSight
23312
24898
  include Aws::Structure
23313
24899
  end
23314
24900
 
23315
- # The total aggregation computation configuration.
24901
+ # A structure that represents a calculated field.
23316
24902
  #
23317
- # @!attribute [rw] computation_id
23318
- # The ID for a computation.
24903
+ # @!attribute [rw] calculated_field_name
24904
+ # The calculated field name.
23319
24905
  # @return [String]
23320
24906
  #
23321
- # @!attribute [rw] name
23322
- # The name of a computation.
24907
+ # @!attribute [rw] calculated_field_description
24908
+ # The calculated field description.
23323
24909
  # @return [String]
23324
24910
  #
23325
- # @!attribute [rw] value
23326
- # The value field that is used in a computation.
23327
- # @return [Types::MeasureField]
24911
+ # @!attribute [rw] expression
24912
+ # The calculated field expression.
24913
+ # @return [String]
23328
24914
  #
23329
- # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TotalAggregationComputation AWS API Documentation
24915
+ # @!attribute [rw] calculated_field_synonyms
24916
+ # The other names or aliases for the calculated field.
24917
+ # @return [Array<String>]
23330
24918
  #
23331
- class TotalAggregationComputation < Struct.new(
23332
- :computation_id,
23333
- :name,
23334
- :value)
23335
- SENSITIVE = []
23336
- include Aws::Structure
23337
- end
23338
-
23339
- # The total options for a table visual.
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]
23340
24923
  #
23341
- # @!attribute [rw] totals_visibility
23342
- # The visibility configuration for the total cells.
23343
- # @return [String]
24924
+ # @!attribute [rw] disable_indexing
24925
+ # A Boolean value that indicates if a calculated field is visible in
24926
+ # the autocomplete.
24927
+ # @return [Boolean]
23344
24928
  #
23345
- # @!attribute [rw] placement
23346
- # The placement (start, end) for the total cells.
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`.
23347
24932
  # @return [String]
23348
24933
  #
23349
- # @!attribute [rw] scroll_status
23350
- # The scroll status (pinned, scrolled) for the total cells.
24934
+ # @!attribute [rw] time_granularity
24935
+ # The level of time precision that is used to aggregate `DateTime`
24936
+ # values.
23351
24937
  # @return [String]
23352
24938
  #
23353
- # @!attribute [rw] custom_label
23354
- # The custom label string for the total cells.
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`.
23355
24946
  # @return [String]
23356
24947
  #
23357
- # @!attribute [rw] total_cell_style
23358
- # Cell styling options for the total cells.
23359
- # @return [Types::TableCellStyle]
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]
23360
24952
  #
23361
- # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TotalOptions AWS API Documentation
24953
+ # @!attribute [rw] semantic_type
24954
+ # The semantic type.
24955
+ # @return [Types::SemanticType]
23362
24956
  #
23363
- class TotalOptions < Struct.new(
23364
- :totals_visibility,
23365
- :placement,
23366
- :scroll_status,
23367
- :custom_label,
23368
- :total_cell_style)
23369
- SENSITIVE = []
23370
- include Aws::Structure
23371
- end
23372
-
23373
- # A data transformation on a logical table. This is a variant type
23374
- # structure. For this structure to be valid, only one of the attributes
23375
- # can be non-null.
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>]
23376
24963
  #
23377
- # @!attribute [rw] project_operation
23378
- # An operation that projects columns. Operations that come after a
23379
- # projection can only refer to projected columns.
23380
- # @return [Types::ProjectOperation]
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>]
23381
24970
  #
23382
- # @!attribute [rw] filter_operation
23383
- # An operation that filters rows based on some condition.
23384
- # @return [Types::FilterOperation]
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]
23385
24975
  #
23386
- # @!attribute [rw] create_columns_operation
23387
- # An operation that creates calculated columns. Columns created in one
23388
- # such operation form a lexical closure.
23389
- # @return [Types::CreateColumnsOperation]
24976
+ # @!attribute [rw] cell_value_synonyms
24977
+ # The other names or aliases for the calculated field cell value.
24978
+ # @return [Array<Types::CellValueSynonym>]
23390
24979
  #
23391
- # @!attribute [rw] rename_column_operation
23392
- # An operation that renames a column.
23393
- # @return [Types::RenameColumnOperation]
24980
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TopicCalculatedField AWS API Documentation
23394
24981
  #
23395
- # @!attribute [rw] cast_column_type_operation
23396
- # A transform operation that casts a column to a different type.
23397
- # @return [Types::CastColumnTypeOperation]
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.
23398
25004
  #
23399
- # @!attribute [rw] tag_column_operation
23400
- # An operation that tags a column with additional information.
23401
- # @return [Types::TagColumnOperation]
25005
+ # @!attribute [rw] category_filter_function
25006
+ # The category filter function. Valid values for this structure are
25007
+ # `EXACT` and `CONTAINS`.
25008
+ # @return [String]
23402
25009
  #
23403
- # @!attribute [rw] untag_column_operation
23404
- # A transform operation that removes tags associated with a column.
23405
- # @return [Types::UntagColumnOperation]
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]
23406
25014
  #
23407
- # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TransformOperation AWS API Documentation
25015
+ # @!attribute [rw] constant
25016
+ # The constant used in a category filter.
25017
+ # @return [Types::TopicCategoryFilterConstant]
23408
25018
  #
23409
- class TransformOperation < Struct.new(
23410
- :project_operation,
23411
- :filter_operation,
23412
- :create_columns_operation,
23413
- :rename_column_operation,
23414
- :cast_column_type_operation,
23415
- :tag_column_operation,
23416
- :untag_column_operation)
23417
- SENSITIVE = []
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]
23418
25031
  include Aws::Structure
23419
25032
  end
23420
25033
 
23421
- # Aggregated field wells of a tree map.
25034
+ # A constant used in a category filter.
23422
25035
  #
23423
- # @!attribute [rw] groups
23424
- # The group by field well of a tree map. Values are grouped based on
23425
- # group by fields.
23426
- # @return [Array<Types::DimensionField>]
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]
23427
25041
  #
23428
- # @!attribute [rw] sizes
23429
- # The size field well of a tree map. Values are aggregated based on
23430
- # group by fields.
23431
- # @return [Array<Types::MeasureField>]
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]
23432
25046
  #
23433
- # @!attribute [rw] colors
23434
- # The color field well of a tree map. Values are grouped by
23435
- # aggregations based on group by fields.
23436
- # @return [Array<Types::MeasureField>]
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]
23437
25051
  #
23438
- # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TreeMapAggregatedFieldWells AWS API Documentation
25052
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TopicCategoryFilterConstant AWS API Documentation
23439
25053
  #
23440
- class TreeMapAggregatedFieldWells < Struct.new(
23441
- :groups,
23442
- :sizes,
23443
- :colors)
25054
+ class TopicCategoryFilterConstant < Struct.new(
25055
+ :constant_type,
25056
+ :singular_constant,
25057
+ :collective_constant)
23444
25058
  SENSITIVE = []
23445
25059
  include Aws::Structure
23446
25060
  end
23447
25061
 
23448
- # The configuration of a tree map.
25062
+ # Represents a column in a dataset.
23449
25063
  #
23450
- # @!attribute [rw] field_wells
23451
- # The field wells of the visual.
23452
- # @return [Types::TreeMapFieldWells]
25064
+ # @!attribute [rw] column_name
25065
+ # The name of the column.
25066
+ # @return [String]
23453
25067
  #
23454
- # @!attribute [rw] sort_configuration
23455
- # The sort configuration of a tree map.
23456
- # @return [Types::TreeMapSortConfiguration]
25068
+ # @!attribute [rw] column_friendly_name
25069
+ # A user-friendly name for the column.
25070
+ # @return [String]
23457
25071
  #
23458
- # @!attribute [rw] group_label_options
23459
- # The label options (label text, label visibility) of the groups that
23460
- # are displayed in a tree map.
23461
- # @return [Types::ChartAxisLabelOptions]
25072
+ # @!attribute [rw] column_description
25073
+ # A description of the column and its contents.
25074
+ # @return [String]
23462
25075
  #
23463
- # @!attribute [rw] size_label_options
23464
- # The label options (label text, label visibility) of the sizes that
23465
- # are displayed in a tree map.
23466
- # @return [Types::ChartAxisLabelOptions]
25076
+ # @!attribute [rw] column_synonyms
25077
+ # The other names or aliases for the column.
25078
+ # @return [Array<String>]
23467
25079
  #
23468
- # @!attribute [rw] color_label_options
23469
- # The label options (label text, label visibility) for the colors
23470
- # displayed in a tree map.
23471
- # @return [Types::ChartAxisLabelOptions]
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]
23472
25084
  #
23473
- # @!attribute [rw] color_scale
23474
- # The color options (gradient color, point of divergence) of a tree
23475
- # map.
23476
- # @return [Types::ColorScale]
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]
23477
25090
  #
23478
- # @!attribute [rw] legend
23479
- # The legend display setup of the visual.
23480
- # @return [Types::LegendOptions]
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]
23481
25095
  #
23482
- # @!attribute [rw] data_labels
23483
- # The options that determine if visual data labels are displayed.
23484
- # @return [Types::DataLabelOptions]
25096
+ # @!attribute [rw] disable_indexing
25097
+ # A Boolean value that indicates whether the column shows in the
25098
+ # autocomplete functionality.
25099
+ # @return [Boolean]
23485
25100
  #
23486
- # @!attribute [rw] tooltip
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.
25588
+ #
25589
+ # @!attribute [rw] totals_visibility
25590
+ # The visibility configuration for the total cells.
25591
+ # @return [String]
25592
+ #
25593
+ # @!attribute [rw] placement
25594
+ # The placement (start, end) for the total cells.
25595
+ # @return [String]
25596
+ #
25597
+ # @!attribute [rw] scroll_status
25598
+ # The scroll status (pinned, scrolled) for the total cells.
25599
+ # @return [String]
25600
+ #
25601
+ # @!attribute [rw] custom_label
25602
+ # The custom label string for the total cells.
25603
+ # @return [String]
25604
+ #
25605
+ # @!attribute [rw] total_cell_style
25606
+ # Cell styling options for the total cells.
25607
+ # @return [Types::TableCellStyle]
25608
+ #
25609
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TotalOptions AWS API Documentation
25610
+ #
25611
+ class TotalOptions < Struct.new(
25612
+ :totals_visibility,
25613
+ :placement,
25614
+ :scroll_status,
25615
+ :custom_label,
25616
+ :total_cell_style)
25617
+ SENSITIVE = []
25618
+ include Aws::Structure
25619
+ end
25620
+
25621
+ # A data transformation on a logical table. This is a variant type
25622
+ # structure. For this structure to be valid, only one of the attributes
25623
+ # can be non-null.
25624
+ #
25625
+ # @!attribute [rw] project_operation
25626
+ # An operation that projects columns. Operations that come after a
25627
+ # projection can only refer to projected columns.
25628
+ # @return [Types::ProjectOperation]
25629
+ #
25630
+ # @!attribute [rw] filter_operation
25631
+ # An operation that filters rows based on some condition.
25632
+ # @return [Types::FilterOperation]
25633
+ #
25634
+ # @!attribute [rw] create_columns_operation
25635
+ # An operation that creates calculated columns. Columns created in one
25636
+ # such operation form a lexical closure.
25637
+ # @return [Types::CreateColumnsOperation]
25638
+ #
25639
+ # @!attribute [rw] rename_column_operation
25640
+ # An operation that renames a column.
25641
+ # @return [Types::RenameColumnOperation]
25642
+ #
25643
+ # @!attribute [rw] cast_column_type_operation
25644
+ # A transform operation that casts a column to a different type.
25645
+ # @return [Types::CastColumnTypeOperation]
25646
+ #
25647
+ # @!attribute [rw] tag_column_operation
25648
+ # An operation that tags a column with additional information.
25649
+ # @return [Types::TagColumnOperation]
25650
+ #
25651
+ # @!attribute [rw] untag_column_operation
25652
+ # A transform operation that removes tags associated with a column.
25653
+ # @return [Types::UntagColumnOperation]
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
+ #
25660
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TransformOperation AWS API Documentation
25661
+ #
25662
+ class TransformOperation < Struct.new(
25663
+ :project_operation,
25664
+ :filter_operation,
25665
+ :create_columns_operation,
25666
+ :rename_column_operation,
25667
+ :cast_column_type_operation,
25668
+ :tag_column_operation,
25669
+ :untag_column_operation,
25670
+ :override_dataset_parameter_operation)
25671
+ SENSITIVE = []
25672
+ include Aws::Structure
25673
+ end
25674
+
25675
+ # Aggregated field wells of a tree map.
25676
+ #
25677
+ # @!attribute [rw] groups
25678
+ # The group by field well of a tree map. Values are grouped based on
25679
+ # group by fields.
25680
+ # @return [Array<Types::DimensionField>]
25681
+ #
25682
+ # @!attribute [rw] sizes
25683
+ # The size field well of a tree map. Values are aggregated based on
25684
+ # group by fields.
25685
+ # @return [Array<Types::MeasureField>]
25686
+ #
25687
+ # @!attribute [rw] colors
25688
+ # The color field well of a tree map. Values are grouped by
25689
+ # aggregations based on group by fields.
25690
+ # @return [Array<Types::MeasureField>]
25691
+ #
25692
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TreeMapAggregatedFieldWells AWS API Documentation
25693
+ #
25694
+ class TreeMapAggregatedFieldWells < Struct.new(
25695
+ :groups,
25696
+ :sizes,
25697
+ :colors)
25698
+ SENSITIVE = []
25699
+ include Aws::Structure
25700
+ end
25701
+
25702
+ # The configuration of a tree map.
25703
+ #
25704
+ # @!attribute [rw] field_wells
25705
+ # The field wells of the visual.
25706
+ # @return [Types::TreeMapFieldWells]
25707
+ #
25708
+ # @!attribute [rw] sort_configuration
25709
+ # The sort configuration of a tree map.
25710
+ # @return [Types::TreeMapSortConfiguration]
25711
+ #
25712
+ # @!attribute [rw] group_label_options
25713
+ # The label options (label text, label visibility) of the groups that
25714
+ # are displayed in a tree map.
25715
+ # @return [Types::ChartAxisLabelOptions]
25716
+ #
25717
+ # @!attribute [rw] size_label_options
25718
+ # The label options (label text, label visibility) of the sizes that
25719
+ # are displayed in a tree map.
25720
+ # @return [Types::ChartAxisLabelOptions]
25721
+ #
25722
+ # @!attribute [rw] color_label_options
25723
+ # The label options (label text, label visibility) for the colors
25724
+ # displayed in a tree map.
25725
+ # @return [Types::ChartAxisLabelOptions]
25726
+ #
25727
+ # @!attribute [rw] color_scale
25728
+ # The color options (gradient color, point of divergence) of a tree
25729
+ # map.
25730
+ # @return [Types::ColorScale]
25731
+ #
25732
+ # @!attribute [rw] legend
25733
+ # The legend display setup of the visual.
25734
+ # @return [Types::LegendOptions]
25735
+ #
25736
+ # @!attribute [rw] data_labels
25737
+ # The options that determine if visual data labels are displayed.
25738
+ # @return [Types::DataLabelOptions]
25739
+ #
25740
+ # @!attribute [rw] tooltip
23487
25741
  # The tooltip display setup of the visual.
23488
25742
  # @return [Types::TooltipOptions]
23489
25743
  #
@@ -24536,6 +26790,10 @@ module Aws::QuickSight
24536
26790
  # this dataset as a source.
24537
26791
  # @return [Types::DataSetUsageConfiguration]
24538
26792
  #
26793
+ # @!attribute [rw] dataset_parameters
26794
+ # The parameter declarations of the dataset.
26795
+ # @return [Array<Types::DatasetParameter>]
26796
+ #
24539
26797
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDataSetRequest AWS API Documentation
24540
26798
  #
24541
26799
  class UpdateDataSetRequest < Struct.new(
@@ -24550,7 +26808,8 @@ module Aws::QuickSight
24550
26808
  :row_level_permission_data_set,
24551
26809
  :row_level_permission_tag_configuration,
24552
26810
  :column_level_permission_rules,
24553
- :data_set_usage_configuration)
26811
+ :data_set_usage_configuration,
26812
+ :dataset_parameters)
24554
26813
  SENSITIVE = []
24555
26814
  include Aws::Structure
24556
26815
  end
@@ -24901,8 +27160,8 @@ module Aws::QuickSight
24901
27160
  # @return [String]
24902
27161
  #
24903
27162
  # @!attribute [rw] assignment_name
24904
- # The name of the assignment, also called a rule. This name must be
24905
- # unique within an Amazon Web Services account.
27163
+ # The name of the assignment, also called a rule. The name must be
27164
+ # unique within the Amazon Web Services account.
24906
27165
  # @return [String]
24907
27166
  #
24908
27167
  # @!attribute [rw] namespace
@@ -25528,6 +27787,187 @@ module Aws::QuickSight
25528
27787
  include Aws::Structure
25529
27788
  end
25530
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
+
25531
27971
  # @!attribute [rw] user_name
25532
27972
  # The Amazon QuickSight user name that you want to update.
25533
27973
  # @return [String]
@@ -25671,6 +28111,91 @@ module Aws::QuickSight
25671
28111
  include Aws::Structure
25672
28112
  end
25673
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
+
25674
28199
  # Information about the format for a source file or files.
25675
28200
  #
25676
28201
  # @!attribute [rw] format
@@ -25795,6 +28320,152 @@ module Aws::QuickSight
25795
28320
  include Aws::Structure
25796
28321
  end
25797
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
+
25798
28469
  # The range options for the data zoom scroll bar.
25799
28470
  #
25800
28471
  # @!attribute [rw] percent_range