aws-sdk-quicksight 1.165.0 → 1.166.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3309,6 +3309,15 @@ module Aws::QuickSight
3309
3309
  # visibility) for a color that is used in a bar chart.
3310
3310
  # @return [Types::ChartAxisLabelOptions]
3311
3311
  #
3312
+ # @!attribute [rw] default_series_settings
3313
+ # The options that determine the default presentation of all bar
3314
+ # series in `BarChartVisual`.
3315
+ # @return [Types::BarChartDefaultSeriesSettings]
3316
+ #
3317
+ # @!attribute [rw] series
3318
+ # The series item configuration of a `BarChartVisual`.
3319
+ # @return [Array<Types::BarSeriesItem>]
3320
+ #
3312
3321
  # @!attribute [rw] legend
3313
3322
  # The legend display setup of the visual.
3314
3323
  # @return [Types::LegendOptions]
@@ -3348,6 +3357,8 @@ module Aws::QuickSight
3348
3357
  :value_axis,
3349
3358
  :value_label_options,
3350
3359
  :color_label_options,
3360
+ :default_series_settings,
3361
+ :series,
3351
3362
  :legend,
3352
3363
  :data_labels,
3353
3364
  :tooltip,
@@ -3358,6 +3369,26 @@ module Aws::QuickSight
3358
3369
  include Aws::Structure
3359
3370
  end
3360
3371
 
3372
+ # The options that determine the default presentation of all bar series
3373
+ # in `BarChartVisual`.
3374
+ #
3375
+ # @!attribute [rw] decal_settings
3376
+ # Decal settings for all bar series in the visual.
3377
+ # @return [Types::DecalSettings]
3378
+ #
3379
+ # @!attribute [rw] border_settings
3380
+ # Border settings for all bar series in the visual.
3381
+ # @return [Types::BorderSettings]
3382
+ #
3383
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/BarChartDefaultSeriesSettings AWS API Documentation
3384
+ #
3385
+ class BarChartDefaultSeriesSettings < Struct.new(
3386
+ :decal_settings,
3387
+ :border_settings)
3388
+ SENSITIVE = []
3389
+ include Aws::Structure
3390
+ end
3391
+
3361
3392
  # The field wells of a `BarChartVisual`.
3362
3393
  #
3363
3394
  # This is a union type structure. For this structure to be valid, only
@@ -3375,6 +3406,25 @@ module Aws::QuickSight
3375
3406
  include Aws::Structure
3376
3407
  end
3377
3408
 
3409
+ # Options that determine the presentation of a bar series in the visual.
3410
+ #
3411
+ # @!attribute [rw] decal_settings
3412
+ # Decal settings for the bar series.
3413
+ # @return [Types::DecalSettings]
3414
+ #
3415
+ # @!attribute [rw] border_settings
3416
+ # Border settings for the bar series.
3417
+ # @return [Types::BorderSettings]
3418
+ #
3419
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/BarChartSeriesSettings AWS API Documentation
3420
+ #
3421
+ class BarChartSeriesSettings < Struct.new(
3422
+ :decal_settings,
3423
+ :border_settings)
3424
+ SENSITIVE = []
3425
+ include Aws::Structure
3426
+ end
3427
+
3378
3428
  # sort-configuration-description
3379
3429
  #
3380
3430
  # @!attribute [rw] category_sort
@@ -3485,6 +3535,28 @@ module Aws::QuickSight
3485
3535
  include Aws::Structure
3486
3536
  end
3487
3537
 
3538
+ # The series item configuration of a `BarChartVisual`.
3539
+ #
3540
+ # This is a union type structure. For this structure to be valid, only
3541
+ # one of the attributes can be defined.
3542
+ #
3543
+ # @!attribute [rw] field_bar_series_item
3544
+ # The field series item configuration of a `BarChartVisual`.
3545
+ # @return [Types::FieldBarSeriesItem]
3546
+ #
3547
+ # @!attribute [rw] data_field_bar_series_item
3548
+ # The data field series item configuration of a `BarChartVisual`.
3549
+ # @return [Types::DataFieldBarSeriesItem]
3550
+ #
3551
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/BarSeriesItem AWS API Documentation
3552
+ #
3553
+ class BarSeriesItem < Struct.new(
3554
+ :field_bar_series_item,
3555
+ :data_field_bar_series_item)
3556
+ SENSITIVE = []
3557
+ include Aws::Structure
3558
+ end
3559
+
3488
3560
  # Metadata for basic authentication using username and password.
3489
3561
  #
3490
3562
  # @!attribute [rw] base_endpoint
@@ -3871,6 +3943,31 @@ module Aws::QuickSight
3871
3943
  include Aws::Structure
3872
3944
  end
3873
3945
 
3946
+ # Border settings configuration for visual elements, including
3947
+ # visibility, width, and color properties.
3948
+ #
3949
+ # @!attribute [rw] border_visibility
3950
+ # Visibility setting for the border.
3951
+ # @return [String]
3952
+ #
3953
+ # @!attribute [rw] border_width
3954
+ # Width of the border. Valid range is from 1px to 8px.
3955
+ # @return [String]
3956
+ #
3957
+ # @!attribute [rw] border_color
3958
+ # Color of the border.
3959
+ # @return [String]
3960
+ #
3961
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/BorderSettings AWS API Documentation
3962
+ #
3963
+ class BorderSettings < Struct.new(
3964
+ :border_visibility,
3965
+ :border_width,
3966
+ :border_color)
3967
+ SENSITIVE = []
3968
+ include Aws::Structure
3969
+ end
3970
+
3874
3971
  # The display options for tile borders for visuals.
3875
3972
  #
3876
3973
  # @!attribute [rw] color
@@ -5148,13 +5245,18 @@ module Aws::QuickSight
5148
5245
  # The color configurations of the column.
5149
5246
  # @return [Types::ColorsConfiguration]
5150
5247
  #
5248
+ # @!attribute [rw] decal_settings_configuration
5249
+ # Decal configuration of the column.
5250
+ # @return [Types::DecalSettingsConfiguration]
5251
+ #
5151
5252
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ColumnConfiguration AWS API Documentation
5152
5253
  #
5153
5254
  class ColumnConfiguration < Struct.new(
5154
5255
  :column,
5155
5256
  :format_configuration,
5156
5257
  :role,
5157
- :colors_configuration)
5258
+ :colors_configuration,
5259
+ :decal_settings_configuration)
5158
5260
  SENSITIVE = []
5159
5261
  include Aws::Structure
5160
5262
  end
@@ -5509,6 +5611,15 @@ module Aws::QuickSight
5509
5611
  # visibility) of a combo chart's color field well.
5510
5612
  # @return [Types::ChartAxisLabelOptions]
5511
5613
  #
5614
+ # @!attribute [rw] default_series_settings
5615
+ # The options that determine the default presentation of all series in
5616
+ # `ComboChartVisual`.
5617
+ # @return [Types::ComboChartDefaultSeriesSettings]
5618
+ #
5619
+ # @!attribute [rw] series
5620
+ # The series item configuration of a `ComboChartVisual`.
5621
+ # @return [Array<Types::ComboSeriesItem>]
5622
+ #
5512
5623
  # @!attribute [rw] legend
5513
5624
  # The legend display setup of the visual.
5514
5625
  # @return [Types::LegendOptions]
@@ -5555,6 +5666,8 @@ module Aws::QuickSight
5555
5666
  :secondary_y_axis_label_options,
5556
5667
  :single_axis_options,
5557
5668
  :color_label_options,
5669
+ :default_series_settings,
5670
+ :series,
5558
5671
  :legend,
5559
5672
  :bar_data_labels,
5560
5673
  :line_data_labels,
@@ -5566,6 +5679,36 @@ module Aws::QuickSight
5566
5679
  include Aws::Structure
5567
5680
  end
5568
5681
 
5682
+ # The options that determine the default presentation of all series in
5683
+ # `ComboChartVisual`.
5684
+ #
5685
+ # @!attribute [rw] line_style_settings
5686
+ # Line styles options for all line series in the visual.
5687
+ # @return [Types::LineChartLineStyleSettings]
5688
+ #
5689
+ # @!attribute [rw] marker_style_settings
5690
+ # Marker styles options for all line series in the visual.
5691
+ # @return [Types::LineChartMarkerStyleSettings]
5692
+ #
5693
+ # @!attribute [rw] decal_settings
5694
+ # Decal settings for all series in the visual.
5695
+ # @return [Types::DecalSettings]
5696
+ #
5697
+ # @!attribute [rw] border_settings
5698
+ # Border settings for all bar series in the visual.
5699
+ # @return [Types::BorderSettings]
5700
+ #
5701
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ComboChartDefaultSeriesSettings AWS API Documentation
5702
+ #
5703
+ class ComboChartDefaultSeriesSettings < Struct.new(
5704
+ :line_style_settings,
5705
+ :marker_style_settings,
5706
+ :decal_settings,
5707
+ :border_settings)
5708
+ SENSITIVE = []
5709
+ include Aws::Structure
5710
+ end
5711
+
5569
5712
  # The field wells of the visual.
5570
5713
  #
5571
5714
  # This is a union type structure. For this structure to be valid, only
@@ -5585,6 +5728,35 @@ module Aws::QuickSight
5585
5728
  include Aws::Structure
5586
5729
  end
5587
5730
 
5731
+ # Options that determine the presentation of a series in the visual.
5732
+ #
5733
+ # @!attribute [rw] line_style_settings
5734
+ # Line styles options for the line series in the visual.
5735
+ # @return [Types::LineChartLineStyleSettings]
5736
+ #
5737
+ # @!attribute [rw] marker_style_settings
5738
+ # Marker styles options for the line series in the visual.
5739
+ # @return [Types::LineChartMarkerStyleSettings]
5740
+ #
5741
+ # @!attribute [rw] decal_settings
5742
+ # Decal settings for the series in the visual.
5743
+ # @return [Types::DecalSettings]
5744
+ #
5745
+ # @!attribute [rw] border_settings
5746
+ # Border settings for the bar series in the visual.
5747
+ # @return [Types::BorderSettings]
5748
+ #
5749
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ComboChartSeriesSettings AWS API Documentation
5750
+ #
5751
+ class ComboChartSeriesSettings < Struct.new(
5752
+ :line_style_settings,
5753
+ :marker_style_settings,
5754
+ :decal_settings,
5755
+ :border_settings)
5756
+ SENSITIVE = []
5757
+ include Aws::Structure
5758
+ end
5759
+
5588
5760
  # The sort configuration of a `ComboChartVisual`.
5589
5761
  #
5590
5762
  # @!attribute [rw] category_sort
@@ -5673,6 +5845,28 @@ module Aws::QuickSight
5673
5845
  include Aws::Structure
5674
5846
  end
5675
5847
 
5848
+ # The series item configuration of a `ComboChartVisual`.
5849
+ #
5850
+ # This is a union type structure. For this structure to be valid, only
5851
+ # one of the attributes can be defined.
5852
+ #
5853
+ # @!attribute [rw] field_combo_series_item
5854
+ # The field series item configuration of a `ComboChartVisual`.
5855
+ # @return [Types::FieldComboSeriesItem]
5856
+ #
5857
+ # @!attribute [rw] data_field_combo_series_item
5858
+ # The data field series item configuration of a `ComboChartVisual`.
5859
+ # @return [Types::DataFieldComboSeriesItem]
5860
+ #
5861
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ComboSeriesItem AWS API Documentation
5862
+ #
5863
+ class ComboSeriesItem < Struct.new(
5864
+ :field_combo_series_item,
5865
+ :data_field_combo_series_item)
5866
+ SENSITIVE = []
5867
+ include Aws::Structure
5868
+ end
5869
+
5676
5870
  # A structure that represents a comparative order.
5677
5871
  #
5678
5872
  # @!attribute [rw] use_ordering
@@ -6118,6 +6312,25 @@ module Aws::QuickSight
6118
6312
  include Aws::Structure
6119
6313
  end
6120
6314
 
6315
+ # The preference coordinate for the geocode preference.
6316
+ #
6317
+ # @!attribute [rw] latitude
6318
+ # The latitude coordinate value for the geocode preference.
6319
+ # @return [Float]
6320
+ #
6321
+ # @!attribute [rw] longitude
6322
+ # The longitude coordinate value for the geocode preference.
6323
+ # @return [Float]
6324
+ #
6325
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Coordinate AWS API Documentation
6326
+ #
6327
+ class Coordinate < Struct.new(
6328
+ :latitude,
6329
+ :longitude)
6330
+ SENSITIVE = []
6331
+ include Aws::Structure
6332
+ end
6333
+
6121
6334
  # @!attribute [rw] aws_account_id
6122
6335
  # The ID for the Amazon Web Services account that you want to
6123
6336
  # customize Quick Sight for.
@@ -9003,6 +9216,22 @@ module Aws::QuickSight
9003
9216
  include Aws::Structure
9004
9217
  end
9005
9218
 
9219
+ # The options that define customizations available to dashboard readers
9220
+ # for a specific visual
9221
+ #
9222
+ # @!attribute [rw] fields_configuration
9223
+ # The configuration that controls field customization options
9224
+ # available to dashboard readers for a visual.
9225
+ # @return [Types::VisualCustomizationFieldsConfiguration]
9226
+ #
9227
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DashboardCustomizationVisualOptions AWS API Documentation
9228
+ #
9229
+ class DashboardCustomizationVisualOptions < Struct.new(
9230
+ :fields_configuration)
9231
+ SENSITIVE = []
9232
+ include Aws::Structure
9233
+ end
9234
+
9006
9235
  # Dashboard error.
9007
9236
  #
9008
9237
  # @!attribute [rw] type
@@ -9639,6 +9868,60 @@ module Aws::QuickSight
9639
9868
  include Aws::Structure
9640
9869
  end
9641
9870
 
9871
+ # The data field series item configuration of a `BarChartVisual`.
9872
+ #
9873
+ # @!attribute [rw] field_id
9874
+ # Field ID of the field that you are setting the series configuration
9875
+ # for.
9876
+ # @return [String]
9877
+ #
9878
+ # @!attribute [rw] field_value
9879
+ # Field value of the field that you are setting the series
9880
+ # configuration for.
9881
+ # @return [String]
9882
+ #
9883
+ # @!attribute [rw] settings
9884
+ # Options that determine the presentation of bar series associated to
9885
+ # the field.
9886
+ # @return [Types::BarChartSeriesSettings]
9887
+ #
9888
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataFieldBarSeriesItem AWS API Documentation
9889
+ #
9890
+ class DataFieldBarSeriesItem < Struct.new(
9891
+ :field_id,
9892
+ :field_value,
9893
+ :settings)
9894
+ SENSITIVE = [:field_value]
9895
+ include Aws::Structure
9896
+ end
9897
+
9898
+ # The data field series item configuration of a `ComboChartVisual`.
9899
+ #
9900
+ # @!attribute [rw] field_id
9901
+ # Field ID of the field that you are setting the series configuration
9902
+ # for.
9903
+ # @return [String]
9904
+ #
9905
+ # @!attribute [rw] field_value
9906
+ # Field value of the field that you are setting the series
9907
+ # configuration for.
9908
+ # @return [String]
9909
+ #
9910
+ # @!attribute [rw] settings
9911
+ # Options that determine the presentation of series associated to the
9912
+ # field.
9913
+ # @return [Types::ComboChartSeriesSettings]
9914
+ #
9915
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataFieldComboSeriesItem AWS API Documentation
9916
+ #
9917
+ class DataFieldComboSeriesItem < Struct.new(
9918
+ :field_id,
9919
+ :field_value,
9920
+ :settings)
9921
+ SENSITIVE = [:field_value]
9922
+ include Aws::Structure
9923
+ end
9924
+
9642
9925
  # The data field series item configuration of a line chart.
9643
9926
  #
9644
9927
  # @!attribute [rw] field_id
@@ -10851,6 +11134,10 @@ module Aws::QuickSight
10851
11134
  # data source in Amazon Secrets Manager.
10852
11135
  # @return [String]
10853
11136
  #
11137
+ # @!attribute [rw] key_pair_credentials
11138
+ # The credentials for connecting using key-pair.
11139
+ # @return [Types::KeyPairCredentials]
11140
+ #
10854
11141
  # @!attribute [rw] web_proxy_credentials
10855
11142
  # The credentials for connecting through a web proxy server.
10856
11143
  # @return [Types::WebProxyCredentials]
@@ -10861,6 +11148,7 @@ module Aws::QuickSight
10861
11148
  :credential_pair,
10862
11149
  :copy_source_arn,
10863
11150
  :secret_arn,
11151
+ :key_pair_credentials,
10864
11152
  :web_proxy_credentials)
10865
11153
  SENSITIVE = []
10866
11154
  include Aws::Structure
@@ -11630,6 +11918,108 @@ module Aws::QuickSight
11630
11918
  include Aws::Structure
11631
11919
  end
11632
11920
 
11921
+ # Decal settings for accessibility features that define visual patterns
11922
+ # and styling for data elements.
11923
+ #
11924
+ # @!attribute [rw] element_value
11925
+ # Field value of the field that you are setting the decal pattern to.
11926
+ # Applicable only for field level settings.
11927
+ # @return [String]
11928
+ #
11929
+ # @!attribute [rw] decal_visibility
11930
+ # Visibility setting for the decal pattern.
11931
+ # @return [String]
11932
+ #
11933
+ # @!attribute [rw] decal_color
11934
+ # Color configuration for the decal pattern.
11935
+ # @return [String]
11936
+ #
11937
+ # @!attribute [rw] decal_pattern_type
11938
+ # Type of pattern used for the decal, such as solid, diagonal, or
11939
+ # circular patterns in various sizes.
11940
+ #
11941
+ # * `SOLID`: Solid fill pattern.
11942
+ #
11943
+ # * `DIAGONAL_SMALL`: Small diagonal stripes pattern.
11944
+ #
11945
+ # * `DIAGONAL_MEDIUM`: Medium diagonal stripes pattern.
11946
+ #
11947
+ # * `DIAGONAL_LARGE`: Large diagonal stripes pattern.
11948
+ #
11949
+ # * `DIAGONAL_OPPOSITE_SMALL`: Small cross-diagonal stripes pattern.
11950
+ #
11951
+ # * `DIAGONAL_OPPOSITE_MEDIUM`: Medium cross-diagonal stripes pattern.
11952
+ #
11953
+ # * `DIAGONAL_OPPOSITE_LARGE`: Large cross-diagonal stripes pattern.
11954
+ #
11955
+ # * `CIRCLE_SMALL`: Small circle pattern.
11956
+ #
11957
+ # * `CIRCLE_MEDIUM`: Medium circle pattern.
11958
+ #
11959
+ # * `CIRCLE_LARGE`: Large circle pattern.
11960
+ #
11961
+ # * `DIAMOND_SMALL`: Small diamonds pattern.
11962
+ #
11963
+ # * `DIAMOND_MEDIUM`: Medium diamonds pattern.
11964
+ #
11965
+ # * `DIAMOND_LARGE`: Large diamonds pattern.
11966
+ #
11967
+ # * `DIAMOND_GRID_SMALL`: Small diamond grid pattern.
11968
+ #
11969
+ # * `DIAMOND_GRID_MEDIUM`: Medium diamond grid pattern.
11970
+ #
11971
+ # * `DIAMOND_GRID_LARGE`: Large diamond grid pattern.
11972
+ #
11973
+ # * `CHECKERBOARD_SMALL`: Small checkerboard pattern.
11974
+ #
11975
+ # * `CHECKERBOARD_MEDIUM`: Medium checkerboard pattern.
11976
+ #
11977
+ # * `CHECKERBOARD_LARGE`: Large checkerboard pattern.
11978
+ #
11979
+ # * `TRIANGLE_SMALL`: Small triangles pattern.
11980
+ #
11981
+ # * `TRIANGLE_MEDIUM`: Medium triangles pattern.
11982
+ #
11983
+ # * `TRIANGLE_LARGE`: Large triangles pattern.
11984
+ # @return [String]
11985
+ #
11986
+ # @!attribute [rw] decal_style_type
11987
+ # Style type for the decal, which can be either manual or automatic.
11988
+ # This field is only applicable for line series.
11989
+ #
11990
+ # * `Manual`: Apply manual line and marker configuration for line
11991
+ # series.
11992
+ #
11993
+ # * `Auto`: Apply automatic line and marker configuration for line
11994
+ # series.
11995
+ # @return [String]
11996
+ #
11997
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DecalSettings AWS API Documentation
11998
+ #
11999
+ class DecalSettings < Struct.new(
12000
+ :element_value,
12001
+ :decal_visibility,
12002
+ :decal_color,
12003
+ :decal_pattern_type,
12004
+ :decal_style_type)
12005
+ SENSITIVE = []
12006
+ include Aws::Structure
12007
+ end
12008
+
12009
+ # Decal settings configuration for a column
12010
+ #
12011
+ # @!attribute [rw] custom_decal_settings
12012
+ # A list of up to 50 decal settings.
12013
+ # @return [Array<Types::DecalSettings>]
12014
+ #
12015
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DecalSettingsConfiguration AWS API Documentation
12016
+ #
12017
+ class DecalSettingsConfiguration < Struct.new(
12018
+ :custom_decal_settings)
12019
+ SENSITIVE = []
12020
+ include Aws::Structure
12021
+ end
12022
+
11633
12023
  # A decimal parameter for a dataset.
11634
12024
  #
11635
12025
  # @!attribute [rw] id
@@ -17227,6 +17617,27 @@ module Aws::QuickSight
17227
17617
  include Aws::Structure
17228
17618
  end
17229
17619
 
17620
+ # The field series item configuration of a `BarChartVisual`.
17621
+ #
17622
+ # @!attribute [rw] field_id
17623
+ # Field ID of the field for which you are setting the series
17624
+ # configuration.
17625
+ # @return [String]
17626
+ #
17627
+ # @!attribute [rw] settings
17628
+ # Options that determine the presentation of bar series associated to
17629
+ # the field.
17630
+ # @return [Types::BarChartSeriesSettings]
17631
+ #
17632
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FieldBarSeriesItem AWS API Documentation
17633
+ #
17634
+ class FieldBarSeriesItem < Struct.new(
17635
+ :field_id,
17636
+ :settings)
17637
+ SENSITIVE = []
17638
+ include Aws::Structure
17639
+ end
17640
+
17230
17641
  # The setup for the detailed tooltip.
17231
17642
  #
17232
17643
  # @!attribute [rw] aggregation_visibility
@@ -17256,6 +17667,27 @@ module Aws::QuickSight
17256
17667
  include Aws::Structure
17257
17668
  end
17258
17669
 
17670
+ # The field series item configuration of a `ComboChartVisual`.
17671
+ #
17672
+ # @!attribute [rw] field_id
17673
+ # Field ID of the field for which you are setting the series
17674
+ # configuration.
17675
+ # @return [String]
17676
+ #
17677
+ # @!attribute [rw] settings
17678
+ # Options that determine the presentation of series associated to the
17679
+ # field.
17680
+ # @return [Types::ComboChartSeriesSettings]
17681
+ #
17682
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FieldComboSeriesItem AWS API Documentation
17683
+ #
17684
+ class FieldComboSeriesItem < Struct.new(
17685
+ :field_id,
17686
+ :settings)
17687
+ SENSITIVE = []
17688
+ include Aws::Structure
17689
+ end
17690
+
17259
17691
  # A FieldFolder element is a folder that contains fields and nested
17260
17692
  # subfolders.
17261
17693
  #
@@ -17584,6 +18016,10 @@ module Aws::QuickSight
17584
18016
  # The alt text for the visual.
17585
18017
  # @return [String]
17586
18018
  #
18019
+ # @!attribute [rw] geocoding_preferences
18020
+ # The geocoding prefences for filled map visual.
18021
+ # @return [Array<Types::GeocodePreference>]
18022
+ #
17587
18023
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FilledMapVisual AWS API Documentation
17588
18024
  #
17589
18025
  class FilledMapVisual < Struct.new(
@@ -17594,7 +18030,8 @@ module Aws::QuickSight
17594
18030
  :conditional_formatting,
17595
18031
  :column_hierarchies,
17596
18032
  :actions,
17597
- :visual_content_alt_text)
18033
+ :visual_content_alt_text,
18034
+ :geocoding_preferences)
17598
18035
  SENSITIVE = []
17599
18036
  include Aws::Structure
17600
18037
  end
@@ -19778,6 +20215,88 @@ module Aws::QuickSight
19778
20215
  include Aws::Structure
19779
20216
  end
19780
20217
 
20218
+ # The geocode preference.
20219
+ #
20220
+ # @!attribute [rw] request_key
20221
+ # The unique request key for the geocode preference.
20222
+ # @return [Types::GeocoderHierarchy]
20223
+ #
20224
+ # @!attribute [rw] preference
20225
+ # The preference definition for the geocode preference.
20226
+ # @return [Types::GeocodePreferenceValue]
20227
+ #
20228
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GeocodePreference AWS API Documentation
20229
+ #
20230
+ class GeocodePreference < Struct.new(
20231
+ :request_key,
20232
+ :preference)
20233
+ SENSITIVE = []
20234
+ include Aws::Structure
20235
+ end
20236
+
20237
+ # The preference value for the geocode preference.
20238
+ #
20239
+ # @note GeocodePreferenceValue is a union - when making an API calls you must set exactly one of the members.
20240
+ #
20241
+ # @note GeocodePreferenceValue is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of GeocodePreferenceValue corresponding to the set member.
20242
+ #
20243
+ # @!attribute [rw] geocoder_hierarchy
20244
+ # The preference hierarchy for the geocode preference.
20245
+ # @return [Types::GeocoderHierarchy]
20246
+ #
20247
+ # @!attribute [rw] coordinate
20248
+ # The preference coordinate for the geocode preference.
20249
+ # @return [Types::Coordinate]
20250
+ #
20251
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GeocodePreferenceValue AWS API Documentation
20252
+ #
20253
+ class GeocodePreferenceValue < Struct.new(
20254
+ :geocoder_hierarchy,
20255
+ :coordinate,
20256
+ :unknown)
20257
+ SENSITIVE = []
20258
+ include Aws::Structure
20259
+ include Aws::Structure::Union
20260
+
20261
+ class GeocoderHierarchy < GeocodePreferenceValue; end
20262
+ class Coordinate < GeocodePreferenceValue; end
20263
+ class Unknown < GeocodePreferenceValue; end
20264
+ end
20265
+
20266
+ # The preference hierarchy for the geocode preference.
20267
+ #
20268
+ # @!attribute [rw] country
20269
+ # The country value for the preference hierarchy.
20270
+ # @return [String]
20271
+ #
20272
+ # @!attribute [rw] state
20273
+ # The state/region value for the preference hierarchy.
20274
+ # @return [String]
20275
+ #
20276
+ # @!attribute [rw] county
20277
+ # The county/district value for the preference hierarchy.
20278
+ # @return [String]
20279
+ #
20280
+ # @!attribute [rw] city
20281
+ # The city value for the preference hierarchy.
20282
+ # @return [String]
20283
+ #
20284
+ # @!attribute [rw] post_code
20285
+ # The postcode value for the preference hierarchy.
20286
+ # @return [String]
20287
+ #
20288
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GeocoderHierarchy AWS API Documentation
20289
+ #
20290
+ class GeocoderHierarchy < Struct.new(
20291
+ :country,
20292
+ :state,
20293
+ :county,
20294
+ :city,
20295
+ :post_code)
20296
+ SENSITIVE = []
20297
+ include Aws::Structure
20298
+ end
20299
+
19781
20300
  # The definition for a categorical color.
19782
20301
  #
19783
20302
  # @!attribute [rw] category_data_colors
@@ -20435,6 +20954,10 @@ module Aws::QuickSight
20435
20954
  # The alt text for the visual.
20436
20955
  # @return [String]
20437
20956
  #
20957
+ # @!attribute [rw] geocoding_preferences
20958
+ # The geocoding prefences for geospatial map.
20959
+ # @return [Array<Types::GeocodePreference>]
20960
+ #
20438
20961
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GeospatialMapVisual AWS API Documentation
20439
20962
  #
20440
20963
  class GeospatialMapVisual < Struct.new(
@@ -20444,7 +20967,8 @@ module Aws::QuickSight
20444
20967
  :chart_configuration,
20445
20968
  :column_hierarchies,
20446
20969
  :actions,
20447
- :visual_content_alt_text)
20970
+ :visual_content_alt_text,
20971
+ :geocoding_preferences)
20448
20972
  SENSITIVE = []
20449
20973
  include Aws::Structure
20450
20974
  end
@@ -20895,6 +21419,70 @@ module Aws::QuickSight
20895
21419
  include Aws::Structure
20896
21420
  end
20897
21421
 
21422
+ # ///////////////////////// /////////////////////////
21423
+ #
21424
+ # @!attribute [rw] aws_account_id
21425
+ # The ID for the Amazon Web Services account that the user whose
21426
+ # identity context you want to retrieve is in. Currently, you use the
21427
+ # ID for the Amazon Web Services account that contains your Quick
21428
+ # Sight account.
21429
+ # @return [String]
21430
+ #
21431
+ # @!attribute [rw] user_identifier
21432
+ # The identifier for the user whose identity context you want to
21433
+ # retrieve.
21434
+ # @return [Types::UserIdentifier]
21435
+ #
21436
+ # @!attribute [rw] namespace
21437
+ # The namespace of the user that you want to get identity context for.
21438
+ # This parameter is required when the UserIdentifier is specified
21439
+ # using Email or UserName.
21440
+ # @return [String]
21441
+ #
21442
+ # @!attribute [rw] session_expires_at
21443
+ # The timestamp at which the session will expire.
21444
+ # @return [Time]
21445
+ #
21446
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetIdentityContextRequest AWS API Documentation
21447
+ #
21448
+ class GetIdentityContextRequest < Struct.new(
21449
+ :aws_account_id,
21450
+ :user_identifier,
21451
+ :namespace,
21452
+ :session_expires_at)
21453
+ SENSITIVE = []
21454
+ include Aws::Structure
21455
+ end
21456
+
21457
+ # @!attribute [rw] status
21458
+ # The HTTP status of the request.
21459
+ # @return [Integer]
21460
+ #
21461
+ # @!attribute [rw] request_id
21462
+ # The Amazon Web Services request ID for this operation.
21463
+ # @return [String]
21464
+ #
21465
+ # @!attribute [rw] context
21466
+ # The identity context information for the user. This is an identity
21467
+ # token that should be used as the ContextAssertion parameter in the
21468
+ # [STS AssumeRole API][1] call to obtain identity enhanced AWS
21469
+ # credentials.
21470
+ #
21471
+ #
21472
+ #
21473
+ # [1]: https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html
21474
+ # @return [String]
21475
+ #
21476
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetIdentityContextResponse AWS API Documentation
21477
+ #
21478
+ class GetIdentityContextResponse < Struct.new(
21479
+ :status,
21480
+ :request_id,
21481
+ :context)
21482
+ SENSITIVE = []
21483
+ include Aws::Structure
21484
+ end
21485
+
20898
21486
  # @!attribute [rw] aws_account_id
20899
21487
  # The ID for the Amazon Web Services account associated with your
20900
21488
  # Amazon Quick Sight subscription.
@@ -23128,6 +23716,31 @@ module Aws::QuickSight
23128
23716
  include Aws::Structure
23129
23717
  end
23130
23718
 
23719
+ # The combination of username, private key and passphrase that are used
23720
+ # as credentials.
23721
+ #
23722
+ # @!attribute [rw] key_pair_username
23723
+ # Username
23724
+ # @return [String]
23725
+ #
23726
+ # @!attribute [rw] private_key
23727
+ # PrivateKey
23728
+ # @return [String]
23729
+ #
23730
+ # @!attribute [rw] private_key_passphrase
23731
+ # PrivateKeyPassphrase
23732
+ # @return [String]
23733
+ #
23734
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/KeyPairCredentials AWS API Documentation
23735
+ #
23736
+ class KeyPairCredentials < Struct.new(
23737
+ :key_pair_username,
23738
+ :private_key,
23739
+ :private_key_passphrase)
23740
+ SENSITIVE = [:private_key, :private_key_passphrase]
23741
+ include Aws::Structure
23742
+ end
23743
+
23131
23744
  # The share label options for the labels.
23132
23745
  #
23133
23746
  # @!attribute [rw] visibility
@@ -23569,12 +24182,17 @@ module Aws::QuickSight
23569
24182
  # Marker styles options for all line series in the visual.
23570
24183
  # @return [Types::LineChartMarkerStyleSettings]
23571
24184
  #
24185
+ # @!attribute [rw] decal_settings
24186
+ # Decal settings options for all line series in the visual.
24187
+ # @return [Types::DecalSettings]
24188
+ #
23572
24189
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/LineChartDefaultSeriesSettings AWS API Documentation
23573
24190
  #
23574
24191
  class LineChartDefaultSeriesSettings < Struct.new(
23575
24192
  :axis_binding,
23576
24193
  :line_style_settings,
23577
- :marker_style_settings)
24194
+ :marker_style_settings,
24195
+ :decal_settings)
23578
24196
  SENSITIVE = []
23579
24197
  include Aws::Structure
23580
24198
  end
@@ -23686,11 +24304,16 @@ module Aws::QuickSight
23686
24304
  # Marker styles options for a line series in `LineChartVisual`.
23687
24305
  # @return [Types::LineChartMarkerStyleSettings]
23688
24306
  #
24307
+ # @!attribute [rw] decal_settings
24308
+ # Decal settings for a line series in `LineChartVisual`.
24309
+ # @return [Types::DecalSettings]
24310
+ #
23689
24311
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/LineChartSeriesSettings AWS API Documentation
23690
24312
  #
23691
24313
  class LineChartSeriesSettings < Struct.new(
23692
24314
  :line_style_settings,
23693
- :marker_style_settings)
24315
+ :marker_style_settings,
24316
+ :decal_settings)
23694
24317
  SENSITIVE = []
23695
24318
  include Aws::Structure
23696
24319
  end
@@ -28394,6 +29017,11 @@ module Aws::QuickSight
28394
29017
  # The paginated report options for a pivot table visual.
28395
29018
  # @return [Types::PivotTablePaginatedReportOptions]
28396
29019
  #
29020
+ # @!attribute [rw] dashboard_customization_visual_options
29021
+ # The options that define customizations available to dashboard
29022
+ # readers for a specific visual
29023
+ # @return [Types::DashboardCustomizationVisualOptions]
29024
+ #
28397
29025
  # @!attribute [rw] interactions
28398
29026
  # The general visual interactions setup for a visual.
28399
29027
  # @return [Types::VisualInteractionOptions]
@@ -28407,6 +29035,7 @@ module Aws::QuickSight
28407
29035
  :total_options,
28408
29036
  :field_options,
28409
29037
  :paginated_report_options,
29038
+ :dashboard_customization_visual_options,
28410
29039
  :interactions)
28411
29040
  SENSITIVE = []
28412
29041
  include Aws::Structure
@@ -31057,6 +31686,26 @@ module Aws::QuickSight
31057
31686
  include Aws::Structure
31058
31687
  end
31059
31688
 
31689
+ # A structure that contains information about files that are requested
31690
+ # for registered user during a `StartDashboardSnapshotJob` API call.
31691
+ #
31692
+ # @!attribute [rw] file_groups
31693
+ # A list of `SnapshotJobResultFileGroup` objects that contain
31694
+ # information on the files that are requested for registered user
31695
+ # during a `StartDashboardSnapshotJob` API call. If the job succeeds,
31696
+ # these objects contain the location where the snapshot artifacts are
31697
+ # stored. If the job fails, the objects contain information about the
31698
+ # error that caused the job to fail.
31699
+ # @return [Array<Types::SnapshotJobResultFileGroup>]
31700
+ #
31701
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisteredUserSnapshotJobResult AWS API Documentation
31702
+ #
31703
+ class RegisteredUserSnapshotJobResult < Struct.new(
31704
+ :file_groups)
31705
+ SENSITIVE = []
31706
+ include Aws::Structure
31707
+ end
31708
+
31060
31709
  # A physical table type for relational data sources.
31061
31710
  #
31062
31711
  # @!attribute [rw] data_source_arn
@@ -34060,6 +34709,12 @@ module Aws::QuickSight
34060
34709
  # An object that contains information on the error that caused the
34061
34710
  # snapshot job to fail.
34062
34711
  #
34712
+ # For more information, see [DescribeDashboardSnapshotJobResult API][1].
34713
+ #
34714
+ #
34715
+ #
34716
+ # [1]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeDashboardSnapshotJobResult.html
34717
+ #
34063
34718
  # @!attribute [rw] error_message
34064
34719
  # The error message.
34065
34720
  # @return [String]
@@ -34088,10 +34743,17 @@ module Aws::QuickSight
34088
34743
  # call.
34089
34744
  # @return [Array<Types::AnonymousUserSnapshotJobResult>]
34090
34745
  #
34746
+ # @!attribute [rw] registered_users
34747
+ # A list of `RegisteredUserSnapshotJobResult` objects that contain
34748
+ # information about files that are requested for registered user
34749
+ # during a `StartDashboardSnapshotJob` API call.
34750
+ # @return [Array<Types::RegisteredUserSnapshotJobResult>]
34751
+ #
34091
34752
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotJobResult AWS API Documentation
34092
34753
  #
34093
34754
  class SnapshotJobResult < Struct.new(
34094
- :anonymous_users)
34755
+ :anonymous_users,
34756
+ :registered_users)
34095
34757
  SENSITIVE = []
34096
34758
  include Aws::Structure
34097
34759
  end
@@ -34182,6 +34844,10 @@ module Aws::QuickSight
34182
34844
  # A structure that contains information about the users that the
34183
34845
  # dashboard snapshot is generated for.
34184
34846
  #
34847
+ # When using identity-enhanced session credentials, set the
34848
+ # UserConfiguration request attribute to null. Otherwise, the request
34849
+ # will be invalid.
34850
+ #
34185
34851
  # @!attribute [rw] anonymous_users
34186
34852
  # An array of records that describe the anonymous users that the
34187
34853
  # dashboard snapshot is generated for.
@@ -34666,9 +35332,14 @@ module Aws::QuickSight
34666
35332
  # @return [String]
34667
35333
  #
34668
35334
  # @!attribute [rw] user_configuration
34669
- # A structure that contains information about the anonymous users that
34670
- # the generated snapshot is for. This API will not return information
34671
- # about registered Amazon Quick Sight.
35335
+ # A structure that contains information about the users that the
35336
+ # dashboard snapshot is generated for. The users can be either
35337
+ # anonymous users or registered users. Anonymous users cannot be used
35338
+ # together with registered users.
35339
+ #
35340
+ # When using identity-enhanced session credentials, set the
35341
+ # UserConfiguration request attribute to null. Otherwise, the request
35342
+ # will be invalid.
34672
35343
  # @return [Types::SnapshotUserConfiguration]
34673
35344
  #
34674
35345
  # @!attribute [rw] snapshot_configuration
@@ -35300,6 +35971,11 @@ module Aws::QuickSight
35300
35971
  # A collection of inline visualizations to display within a chart.
35301
35972
  # @return [Array<Types::TableInlineVisualization>]
35302
35973
  #
35974
+ # @!attribute [rw] dashboard_customization_visual_options
35975
+ # The options that define customizations available to dashboard
35976
+ # readers for a specific visual
35977
+ # @return [Types::DashboardCustomizationVisualOptions]
35978
+ #
35303
35979
  # @!attribute [rw] interactions
35304
35980
  # The general visual interactions setup for a visual.
35305
35981
  # @return [Types::VisualInteractionOptions]
@@ -35314,6 +35990,7 @@ module Aws::QuickSight
35314
35990
  :field_options,
35315
35991
  :paginated_report_options,
35316
35992
  :table_inline_visualizations,
35993
+ :dashboard_customization_visual_options,
35317
35994
  :interactions)
35318
35995
  SENSITIVE = []
35319
35996
  include Aws::Structure
@@ -42377,6 +43054,41 @@ module Aws::QuickSight
42377
43054
  include Aws::Structure
42378
43055
  end
42379
43056
 
43057
+ # A structure that contains information to identify a user.
43058
+ #
43059
+ # @note UserIdentifier is a union - when making an API calls you must set exactly one of the members.
43060
+ #
43061
+ # @!attribute [rw] user_name
43062
+ # The name of the user that you want to get identity context for.
43063
+ # @return [String]
43064
+ #
43065
+ # @!attribute [rw] email
43066
+ # The email address of the user that you want to get identity context
43067
+ # for.
43068
+ # @return [String]
43069
+ #
43070
+ # @!attribute [rw] user_arn
43071
+ # The Amazon Resource Name (ARN) of the user that you want to get
43072
+ # identity context for.
43073
+ # @return [String]
43074
+ #
43075
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UserIdentifier AWS API Documentation
43076
+ #
43077
+ class UserIdentifier < Struct.new(
43078
+ :user_name,
43079
+ :email,
43080
+ :user_arn,
43081
+ :unknown)
43082
+ SENSITIVE = [:user_name, :email]
43083
+ include Aws::Structure
43084
+ include Aws::Structure::Union
43085
+
43086
+ class UserName < UserIdentifier; end
43087
+ class Email < UserIdentifier; end
43088
+ class UserArn < UserIdentifier; end
43089
+ class Unknown < UserIdentifier; end
43090
+ end
43091
+
42380
43092
  # The structure of a VPC connection.
42381
43093
  #
42382
43094
  # @!attribute [rw] vpc_connection_id
@@ -42972,6 +43684,29 @@ module Aws::QuickSight
42972
43684
  include Aws::Structure
42973
43685
  end
42974
43686
 
43687
+ # The configuration that controls field customization options available
43688
+ # to dashboard readers for a visual.
43689
+ #
43690
+ # @!attribute [rw] status
43691
+ # Specifies whether dashboard readers can customize fields for this
43692
+ # visual. This option is `ENABLED` by default.
43693
+ # @return [String]
43694
+ #
43695
+ # @!attribute [rw] additional_fields
43696
+ # The additional dataset fields available for dashboard readers to
43697
+ # customize the visual with, beyond the fields already configured on
43698
+ # the visual.
43699
+ # @return [Array<Types::ColumnIdentifier>]
43700
+ #
43701
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/VisualCustomizationFieldsConfiguration AWS API Documentation
43702
+ #
43703
+ class VisualCustomizationFieldsConfiguration < Struct.new(
43704
+ :status,
43705
+ :additional_fields)
43706
+ SENSITIVE = []
43707
+ include Aws::Structure
43708
+ end
43709
+
42975
43710
  # Defines what initiates a highlight operation on a visual, such as a
42976
43711
  # click or hover.
42977
43712
  #