aws-sdk-quicksight 1.86.0 → 1.88.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -91,6 +91,10 @@ module Aws::QuickSight
91
91
  # The status of your account subscription.
92
92
  # @return [String]
93
93
  #
94
+ # @!attribute [rw] iam_identity_center_instance_arn
95
+ # The Amazon Resource Name (ARN) for the IAM Identity Center instance.
96
+ # @return [String]
97
+ #
94
98
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AccountInfo AWS API Documentation
95
99
  #
96
100
  class AccountInfo < Struct.new(
@@ -98,7 +102,8 @@ module Aws::QuickSight
98
102
  :edition,
99
103
  :notification_email,
100
104
  :authentication_type,
101
- :account_subscription_status)
105
+ :account_subscription_status,
106
+ :iam_identity_center_instance_arn)
102
107
  SENSITIVE = []
103
108
  include Aws::Structure
104
109
  end
@@ -224,12 +229,17 @@ module Aws::QuickSight
224
229
  # * `MAX`: Select the largest date value.
225
230
  # @return [String]
226
231
  #
232
+ # @!attribute [rw] attribute_aggregation_function
233
+ # Aggregation for attributes.
234
+ # @return [Types::AttributeAggregationFunction]
235
+ #
227
236
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AggregationFunction AWS API Documentation
228
237
  #
229
238
  class AggregationFunction < Struct.new(
230
239
  :numerical_aggregation_function,
231
240
  :categorical_aggregation_function,
232
- :date_aggregation_function)
241
+ :date_aggregation_function,
242
+ :attribute_aggregation_function)
233
243
  SENSITIVE = []
234
244
  include Aws::Structure
235
245
  end
@@ -716,6 +726,26 @@ module Aws::QuickSight
716
726
  include Aws::Structure
717
727
  end
718
728
 
729
+ # A structure that contains the file groups that are requested for the
730
+ # artifact generation in a `StartDashboardSnapshotJob` API call.
731
+ #
732
+ # @!attribute [rw] file_groups
733
+ # A list of `SnapshotJobResultFileGroup` objects that contain
734
+ # information on the files that are requested during a
735
+ # `StartDashboardSnapshotJob` API call. If the job succeeds, these
736
+ # objects contain the location where the snapshot artifacts are
737
+ # stored. If the job fails, the objects contain information about the
738
+ # error that caused the job to fail.
739
+ # @return [Array<Types::SnapshotJobResultFileGroup>]
740
+ #
741
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnonymousUserSnapshotJobResult AWS API Documentation
742
+ #
743
+ class AnonymousUserSnapshotJobResult < Struct.new(
744
+ :file_groups)
745
+ SENSITIVE = []
746
+ include Aws::Structure
747
+ end
748
+
719
749
  # The arc axis configuration of a `GaugeChartVisual`.
720
750
  #
721
751
  # @!attribute [rw] range
@@ -1536,6 +1566,32 @@ module Aws::QuickSight
1536
1566
  include Aws::Structure
1537
1567
  end
1538
1568
 
1569
+ # Aggregation for attributes.
1570
+ #
1571
+ # @!attribute [rw] simple_attribute_aggregation
1572
+ # The built-in aggregation functions for attributes.
1573
+ #
1574
+ # * `UNIQUE_VALUE`: Returns the unique value for a field, aggregated
1575
+ # by the dimension fields.
1576
+ #
1577
+ # ^
1578
+ # @return [String]
1579
+ #
1580
+ # @!attribute [rw] value_for_multiple_values
1581
+ # Used by the `UNIQUE_VALUE` aggregation function. If there are
1582
+ # multiple values for the field used by the aggregation, the value for
1583
+ # this property will be returned instead. Defaults to '*'.
1584
+ # @return [String]
1585
+ #
1586
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AttributeAggregationFunction AWS API Documentation
1587
+ #
1588
+ class AttributeAggregationFunction < Struct.new(
1589
+ :simple_attribute_aggregation,
1590
+ :value_for_multiple_values)
1591
+ SENSITIVE = []
1592
+ include Aws::Structure
1593
+ end
1594
+
1539
1595
  # Parameters for Amazon Aurora.
1540
1596
  #
1541
1597
  # @!attribute [rw] host
@@ -7936,11 +7992,16 @@ module Aws::QuickSight
7936
7992
  # Customize how dates are formatted in controls.
7937
7993
  # @return [String]
7938
7994
  #
7995
+ # @!attribute [rw] info_icon_label_options
7996
+ # The configuration of info icon label options.
7997
+ # @return [Types::SheetControlInfoIconLabelOptions]
7998
+ #
7939
7999
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DateTimePickerControlDisplayOptions AWS API Documentation
7940
8000
  #
7941
8001
  class DateTimePickerControlDisplayOptions < Struct.new(
7942
8002
  :title_options,
7943
- :date_time_format)
8003
+ :date_time_format,
8004
+ :info_icon_label_options)
7944
8005
  SENSITIVE = []
7945
8006
  include Aws::Structure
7946
8007
  end
@@ -10137,6 +10198,185 @@ module Aws::QuickSight
10137
10198
  include Aws::Structure
10138
10199
  end
10139
10200
 
10201
+ # @!attribute [rw] aws_account_id
10202
+ # The ID of the Amazon Web Services account that the dashboard
10203
+ # snapshot job is executed in.
10204
+ # @return [String]
10205
+ #
10206
+ # @!attribute [rw] dashboard_id
10207
+ # The ID of the dashboard that you have started a snapshot job for.
10208
+ # @return [String]
10209
+ #
10210
+ # @!attribute [rw] snapshot_job_id
10211
+ # The ID of the job to be described. The job ID is set when you start
10212
+ # a new job with a `StartDashboardSnapshotJob` API call.
10213
+ # @return [String]
10214
+ #
10215
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardSnapshotJobRequest AWS API Documentation
10216
+ #
10217
+ class DescribeDashboardSnapshotJobRequest < Struct.new(
10218
+ :aws_account_id,
10219
+ :dashboard_id,
10220
+ :snapshot_job_id)
10221
+ SENSITIVE = []
10222
+ include Aws::Structure
10223
+ end
10224
+
10225
+ # @!attribute [rw] aws_account_id
10226
+ # The ID of the Amazon Web Services account that the dashboard
10227
+ # snapshot job is executed in.
10228
+ # @return [String]
10229
+ #
10230
+ # @!attribute [rw] dashboard_id
10231
+ # The ID of the dashboard that you have started a snapshot job for.
10232
+ # @return [String]
10233
+ #
10234
+ # @!attribute [rw] snapshot_job_id
10235
+ # The ID of the job to be described. The job ID is set when you start
10236
+ # a new job with a `StartDashboardSnapshotJob` API call.
10237
+ # @return [String]
10238
+ #
10239
+ # @!attribute [rw] user_configuration
10240
+ # The user configuration for the snapshot job. This information is
10241
+ # provided when you make a `StartDashboardSnapshotJob` API call.
10242
+ # @return [Types::SnapshotUserConfigurationRedacted]
10243
+ #
10244
+ # @!attribute [rw] snapshot_configuration
10245
+ # The snapshot configuration of the job. This information is provided
10246
+ # when you make a `StartDashboardSnapshotJob` API call.
10247
+ # @return [Types::SnapshotConfiguration]
10248
+ #
10249
+ # @!attribute [rw] arn
10250
+ # The Amazon Resource Name (ARN) for the snapshot job. The job ARN is
10251
+ # generated when you start a new job with a
10252
+ # `StartDashboardSnapshotJob` API call.
10253
+ # @return [String]
10254
+ #
10255
+ # @!attribute [rw] job_status
10256
+ # Indicates the status of a job. The status updates as the job
10257
+ # executes. This shows one of the following values.
10258
+ #
10259
+ # * `COMPLETED` - The job was completed successfully.
10260
+ #
10261
+ # * `FAILED` - The job failed to execute.
10262
+ #
10263
+ # * `QUEUED` - The job is queued and hasn't started yet.
10264
+ #
10265
+ # * `RUNNING` - The job is still running.
10266
+ # @return [String]
10267
+ #
10268
+ # @!attribute [rw] created_time
10269
+ # The time that the snapshot job was created.
10270
+ # @return [Time]
10271
+ #
10272
+ # @!attribute [rw] last_updated_time
10273
+ # The time that the snapshot job status was last updated.
10274
+ # @return [Time]
10275
+ #
10276
+ # @!attribute [rw] request_id
10277
+ # The Amazon Web Services request ID for this operation.
10278
+ # @return [String]
10279
+ #
10280
+ # @!attribute [rw] status
10281
+ # The HTTP status of the request
10282
+ # @return [Integer]
10283
+ #
10284
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardSnapshotJobResponse AWS API Documentation
10285
+ #
10286
+ class DescribeDashboardSnapshotJobResponse < Struct.new(
10287
+ :aws_account_id,
10288
+ :dashboard_id,
10289
+ :snapshot_job_id,
10290
+ :user_configuration,
10291
+ :snapshot_configuration,
10292
+ :arn,
10293
+ :job_status,
10294
+ :created_time,
10295
+ :last_updated_time,
10296
+ :request_id,
10297
+ :status)
10298
+ SENSITIVE = []
10299
+ include Aws::Structure
10300
+ end
10301
+
10302
+ # @!attribute [rw] aws_account_id
10303
+ # The ID of the Amazon Web Services account that the dashboard
10304
+ # snapshot job is executed in.
10305
+ # @return [String]
10306
+ #
10307
+ # @!attribute [rw] dashboard_id
10308
+ # The ID of the dashboard that you have started a snapshot job for.
10309
+ # @return [String]
10310
+ #
10311
+ # @!attribute [rw] snapshot_job_id
10312
+ # The ID of the job to be described. The job ID is set when you start
10313
+ # a new job with a `StartDashboardSnapshotJob` API call.
10314
+ # @return [String]
10315
+ #
10316
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardSnapshotJobResultRequest AWS API Documentation
10317
+ #
10318
+ class DescribeDashboardSnapshotJobResultRequest < Struct.new(
10319
+ :aws_account_id,
10320
+ :dashboard_id,
10321
+ :snapshot_job_id)
10322
+ SENSITIVE = []
10323
+ include Aws::Structure
10324
+ end
10325
+
10326
+ # @!attribute [rw] arn
10327
+ # The Amazon Resource Name (ARN) for the snapshot job. The job ARN is
10328
+ # generated when you start a new job with a
10329
+ # `StartDashboardSnapshotJob` API call.
10330
+ # @return [String]
10331
+ #
10332
+ # @!attribute [rw] job_status
10333
+ # Indicates the status of a job after it has reached a terminal state.
10334
+ # A finished snapshot job will retuen a `COMPLETED` or `FAILED`
10335
+ # status.
10336
+ # @return [String]
10337
+ #
10338
+ # @!attribute [rw] created_time
10339
+ # The time that a snapshot job was created.
10340
+ # @return [Time]
10341
+ #
10342
+ # @!attribute [rw] last_updated_time
10343
+ # The time that a snapshot job status was last updated.
10344
+ # @return [Time]
10345
+ #
10346
+ # @!attribute [rw] result
10347
+ # The result of the snapshot job. Jobs that have successfully
10348
+ # completed will return the S3Uri where they are located. Jobs that
10349
+ # have failedwill return information on the error that caused the job
10350
+ # to fail.
10351
+ # @return [Types::SnapshotJobResult]
10352
+ #
10353
+ # @!attribute [rw] error_info
10354
+ # Displays information for the error that caused a job to fail.
10355
+ # @return [Types::SnapshotJobErrorInfo]
10356
+ #
10357
+ # @!attribute [rw] request_id
10358
+ # The Amazon Web Services request ID for this operation.
10359
+ # @return [String]
10360
+ #
10361
+ # @!attribute [rw] status
10362
+ # The HTTP status of the request
10363
+ # @return [Integer]
10364
+ #
10365
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardSnapshotJobResultResponse AWS API Documentation
10366
+ #
10367
+ class DescribeDashboardSnapshotJobResultResponse < Struct.new(
10368
+ :arn,
10369
+ :job_status,
10370
+ :created_time,
10371
+ :last_updated_time,
10372
+ :result,
10373
+ :error_info,
10374
+ :request_id,
10375
+ :status)
10376
+ SENSITIVE = []
10377
+ include Aws::Structure
10378
+ end
10379
+
10140
10380
  # @!attribute [rw] aws_account_id
10141
10381
  # The Amazon Web Services account ID.
10142
10382
  # @return [String]
@@ -11765,11 +12005,16 @@ module Aws::QuickSight
11765
12005
  # The options to configure the title visibility, name, and font size.
11766
12006
  # @return [Types::LabelOptions]
11767
12007
  #
12008
+ # @!attribute [rw] info_icon_label_options
12009
+ # The configuration of info icon label options.
12010
+ # @return [Types::SheetControlInfoIconLabelOptions]
12011
+ #
11768
12012
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DropDownControlDisplayOptions AWS API Documentation
11769
12013
  #
11770
12014
  class DropDownControlDisplayOptions < Struct.new(
11771
12015
  :select_all_options,
11772
- :title_options)
12016
+ :title_options,
12017
+ :info_icon_label_options)
11773
12018
  SENSITIVE = []
11774
12019
  include Aws::Structure
11775
12020
  end
@@ -16704,12 +16949,17 @@ module Aws::QuickSight
16704
16949
  # The options to configure the title visibility, name, and font size.
16705
16950
  # @return [Types::LabelOptions]
16706
16951
  #
16952
+ # @!attribute [rw] info_icon_label_options
16953
+ # The configuration of info icon label options.
16954
+ # @return [Types::SheetControlInfoIconLabelOptions]
16955
+ #
16707
16956
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListControlDisplayOptions AWS API Documentation
16708
16957
  #
16709
16958
  class ListControlDisplayOptions < Struct.new(
16710
16959
  :search_options,
16711
16960
  :select_all_options,
16712
- :title_options)
16961
+ :title_options,
16962
+ :info_icon_label_options)
16713
16963
  SENSITIVE = []
16714
16964
  include Aws::Structure
16715
16965
  end
@@ -20422,6 +20672,28 @@ module Aws::QuickSight
20422
20672
  # is `VISIBLE`.
20423
20673
  # @return [String]
20424
20674
  #
20675
+ # @!attribute [rw] rows_layout
20676
+ # The layout for the row dimension headers of a pivot table. Choose
20677
+ # one of the following options.
20678
+ #
20679
+ # * `TABULAR`: (Default) Each row field is displayed in a separate
20680
+ # column.
20681
+ #
20682
+ # * `HIERARCHY`: All row fields are displayed in a single column.
20683
+ # Indentation is used to differentiate row headers of different
20684
+ # fields.
20685
+ # @return [String]
20686
+ #
20687
+ # @!attribute [rw] rows_label_options
20688
+ # The options for the label that is located above the row headers.
20689
+ # This option is only applicable when `RowsLayout` is set to
20690
+ # `HIERARCHY`.
20691
+ # @return [Types::PivotTableRowsLabelOptions]
20692
+ #
20693
+ # @!attribute [rw] default_cell_width
20694
+ # The default cell width of the pivot table.
20695
+ # @return [String]
20696
+ #
20425
20697
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/PivotTableOptions AWS API Documentation
20426
20698
  #
20427
20699
  class PivotTableOptions < Struct.new(
@@ -20434,7 +20706,10 @@ module Aws::QuickSight
20434
20706
  :cell_style,
20435
20707
  :row_field_names_style,
20436
20708
  :row_alternate_color_options,
20437
- :collapsed_row_dimensions_visibility)
20709
+ :collapsed_row_dimensions_visibility,
20710
+ :rows_layout,
20711
+ :rows_label_options,
20712
+ :default_cell_width)
20438
20713
  SENSITIVE = []
20439
20714
  include Aws::Structure
20440
20715
  end
@@ -20458,6 +20733,26 @@ module Aws::QuickSight
20458
20733
  include Aws::Structure
20459
20734
  end
20460
20735
 
20736
+ # The options for the label thta is located above the row headers. This
20737
+ # option is only applicable when `RowsLayout` is set to `HIERARCHY`.
20738
+ #
20739
+ # @!attribute [rw] visibility
20740
+ # The visibility of the rows label.
20741
+ # @return [String]
20742
+ #
20743
+ # @!attribute [rw] custom_label
20744
+ # The custom label string for the rows label.
20745
+ # @return [String]
20746
+ #
20747
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/PivotTableRowsLabelOptions AWS API Documentation
20748
+ #
20749
+ class PivotTableRowsLabelOptions < Struct.new(
20750
+ :visibility,
20751
+ :custom_label)
20752
+ SENSITIVE = []
20753
+ include Aws::Structure
20754
+ end
20755
+
20461
20756
  # The sort by field for the field sort options.
20462
20757
  #
20463
20758
  # @!attribute [rw] field
@@ -21901,11 +22196,16 @@ module Aws::QuickSight
21901
22196
  # Customize how dates are formatted in controls.
21902
22197
  # @return [String]
21903
22198
  #
22199
+ # @!attribute [rw] info_icon_label_options
22200
+ # The configuration of info icon label options.
22201
+ # @return [Types::SheetControlInfoIconLabelOptions]
22202
+ #
21904
22203
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RelativeDateTimeControlDisplayOptions AWS API Documentation
21905
22204
  #
21906
22205
  class RelativeDateTimeControlDisplayOptions < Struct.new(
21907
22206
  :title_options,
21908
- :date_time_format)
22207
+ :date_time_format,
22208
+ :info_icon_label_options)
21909
22209
  SENSITIVE = []
21910
22210
  include Aws::Structure
21911
22211
  end
@@ -22184,11 +22484,16 @@ module Aws::QuickSight
22184
22484
  # Determines the list of row alternate colors.
22185
22485
  # @return [Array<String>]
22186
22486
  #
22487
+ # @!attribute [rw] use_primary_background_color
22488
+ # The primary background color options for alternate rows.
22489
+ # @return [String]
22490
+ #
22187
22491
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RowAlternateColorOptions AWS API Documentation
22188
22492
  #
22189
22493
  class RowAlternateColorOptions < Struct.new(
22190
22494
  :status,
22191
- :row_alternate_colors)
22495
+ :row_alternate_colors,
22496
+ :use_primary_background_color)
22192
22497
  SENSITIVE = []
22193
22498
  include Aws::Structure
22194
22499
  end
@@ -22335,6 +22640,37 @@ module Aws::QuickSight
22335
22640
  include Aws::Structure
22336
22641
  end
22337
22642
 
22643
+ # An optional structure that contains the Amazon S3 bucket configuration
22644
+ # that the generated snapshots are stored in. If you don't provide this
22645
+ # information, generated snapshots are stored in the default Amazon
22646
+ # QuickSight bucket.
22647
+ #
22648
+ # @!attribute [rw] bucket_name
22649
+ # The name of an existing Amazon S3 bucket where the generated
22650
+ # snapshot artifacts are sent.
22651
+ # @return [String]
22652
+ #
22653
+ # @!attribute [rw] bucket_prefix
22654
+ # The prefix of the Amazon S3 bucket that the generated snapshots are
22655
+ # stored in.
22656
+ # @return [String]
22657
+ #
22658
+ # @!attribute [rw] bucket_region
22659
+ # The region that the Amazon S3 bucket is located in. The bucket must
22660
+ # be located in the same region that the `StartDashboardSnapshotJob`
22661
+ # API call is made.
22662
+ # @return [String]
22663
+ #
22664
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/S3BucketConfiguration AWS API Documentation
22665
+ #
22666
+ class S3BucketConfiguration < Struct.new(
22667
+ :bucket_name,
22668
+ :bucket_prefix,
22669
+ :bucket_region)
22670
+ SENSITIVE = []
22671
+ include Aws::Structure
22672
+ end
22673
+
22338
22674
  # The parameters for S3.
22339
22675
  #
22340
22676
  # @!attribute [rw] manifest_file_location
@@ -23530,6 +23866,25 @@ module Aws::QuickSight
23530
23866
  include Aws::Structure
23531
23867
  end
23532
23868
 
23869
+ # A control to display info icons for filters and parameters.
23870
+ #
23871
+ # @!attribute [rw] visibility
23872
+ # The visibility configuration of info icon label options.
23873
+ # @return [String]
23874
+ #
23875
+ # @!attribute [rw] info_icon_text
23876
+ # The text content of info icon.
23877
+ # @return [String]
23878
+ #
23879
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SheetControlInfoIconLabelOptions AWS API Documentation
23880
+ #
23881
+ class SheetControlInfoIconLabelOptions < Struct.new(
23882
+ :visibility,
23883
+ :info_icon_text)
23884
+ SENSITIVE = []
23885
+ include Aws::Structure
23886
+ end
23887
+
23533
23888
  # A grid layout to define the placement of sheet control.
23534
23889
  #
23535
23890
  # @!attribute [rw] configuration
@@ -23867,10 +24222,15 @@ module Aws::QuickSight
23867
24222
  # The options to configure the title visibility, name, and font size.
23868
24223
  # @return [Types::LabelOptions]
23869
24224
  #
24225
+ # @!attribute [rw] info_icon_label_options
24226
+ # The configuration of info icon label options.
24227
+ # @return [Types::SheetControlInfoIconLabelOptions]
24228
+ #
23870
24229
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SliderControlDisplayOptions AWS API Documentation
23871
24230
  #
23872
24231
  class SliderControlDisplayOptions < Struct.new(
23873
- :title_options)
24232
+ :title_options,
24233
+ :info_icon_label_options)
23874
24234
  SENSITIVE = []
23875
24235
  include Aws::Structure
23876
24236
  end
@@ -23941,6 +24301,327 @@ module Aws::QuickSight
23941
24301
  include Aws::Structure
23942
24302
  end
23943
24303
 
24304
+ # A structure that contains information on the anonymous user
24305
+ # configuration.
24306
+ #
24307
+ # @!attribute [rw] row_level_permission_tags
24308
+ # The tags to be used for row-level security (RLS). Make sure that the
24309
+ # relevant datasets have RLS tags configured before you start a
24310
+ # snapshot export job. You can configure the RLS tags of a dataset
24311
+ # with a `DataSet$RowLevelPermissionTagConfiguration` API call.
24312
+ #
24313
+ # These are not the tags that are used for Amazon Web Services
24314
+ # resource tagging. For more information on row level security in
24315
+ # Amazon QuickSight, see [Using Row-Level Security (RLS) with
24316
+ # Tags][1]in the *Amazon QuickSight User Guide*.
24317
+ #
24318
+ #
24319
+ #
24320
+ # [1]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html
24321
+ # @return [Array<Types::SessionTag>]
24322
+ #
24323
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotAnonymousUser AWS API Documentation
24324
+ #
24325
+ class SnapshotAnonymousUser < Struct.new(
24326
+ :row_level_permission_tags)
24327
+ SENSITIVE = []
24328
+ include Aws::Structure
24329
+ end
24330
+
24331
+ # Use this structure to redact sensitive information that you provide
24332
+ # about an anonymous user from the snapshot.
24333
+ #
24334
+ # @!attribute [rw] row_level_permission_tag_keys
24335
+ # The tag keys for the `RowLevelPermissionTags`.
24336
+ # @return [Array<String>]
24337
+ #
24338
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotAnonymousUserRedacted AWS API Documentation
24339
+ #
24340
+ class SnapshotAnonymousUserRedacted < Struct.new(
24341
+ :row_level_permission_tag_keys)
24342
+ SENSITIVE = []
24343
+ include Aws::Structure
24344
+ end
24345
+
24346
+ # Describes the configuration of the dashboard snapshot.
24347
+ #
24348
+ # @!attribute [rw] file_groups
24349
+ # A list of `SnapshotJobResultFileGroup` objects that contain
24350
+ # information about the snapshot that is generated. This list can hold
24351
+ # a maximum of 6 `FileGroup` configurations.
24352
+ # @return [Array<Types::SnapshotFileGroup>]
24353
+ #
24354
+ # @!attribute [rw] destination_configuration
24355
+ # A structure that contains information on the Amazon S3 bucket that
24356
+ # the generated snapshot is stored in.
24357
+ # @return [Types::SnapshotDestinationConfiguration]
24358
+ #
24359
+ # @!attribute [rw] parameters
24360
+ # A list of Amazon QuickSight parameters and the list's override
24361
+ # values.
24362
+ # @return [Types::Parameters]
24363
+ #
24364
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotConfiguration AWS API Documentation
24365
+ #
24366
+ class SnapshotConfiguration < Struct.new(
24367
+ :file_groups,
24368
+ :destination_configuration,
24369
+ :parameters)
24370
+ SENSITIVE = []
24371
+ include Aws::Structure
24372
+ end
24373
+
24374
+ # A structure that contains information on the Amazon S3 destinations of
24375
+ # the generated snapshot.
24376
+ #
24377
+ # @!attribute [rw] s3_destinations
24378
+ # A list of `SnapshotS3DestinationConfiguration` objects that contain
24379
+ # Amazon S3 destination configurations. This structure can hold a
24380
+ # maximum of 1 `S3DestinationConfiguration`.
24381
+ # @return [Array<Types::SnapshotS3DestinationConfiguration>]
24382
+ #
24383
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotDestinationConfiguration AWS API Documentation
24384
+ #
24385
+ class SnapshotDestinationConfiguration < Struct.new(
24386
+ :s3_destinations)
24387
+ SENSITIVE = []
24388
+ include Aws::Structure
24389
+ end
24390
+
24391
+ # A structure that contains the information for the snapshot that you
24392
+ # want to generate. This information is provided by you when you start a
24393
+ # new snapshot job.
24394
+ #
24395
+ # @!attribute [rw] sheet_selections
24396
+ # A list of `SnapshotFileSheetSelection` objects that contain
24397
+ # information on the dashboard sheet that is exported. These objects
24398
+ # provide information about the snapshot artifacts that are generated
24399
+ # during the job. This structure can hold a maximum of 5 CSV
24400
+ # configurations or 1 configuration for PDF.
24401
+ # @return [Array<Types::SnapshotFileSheetSelection>]
24402
+ #
24403
+ # @!attribute [rw] format_type
24404
+ # The format of the snapshot file to be generated. You can choose
24405
+ # between `CSV` or `PDF`.
24406
+ # @return [String]
24407
+ #
24408
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotFile AWS API Documentation
24409
+ #
24410
+ class SnapshotFile < Struct.new(
24411
+ :sheet_selections,
24412
+ :format_type)
24413
+ SENSITIVE = []
24414
+ include Aws::Structure
24415
+ end
24416
+
24417
+ # A structure that contains the information on the snapshot files.
24418
+ #
24419
+ # @!attribute [rw] files
24420
+ # A list of `SnapshotFile` objects that contain the information on the
24421
+ # snapshot files that need to be generated. This structure can hold 1
24422
+ # configuration at a time.
24423
+ # @return [Array<Types::SnapshotFile>]
24424
+ #
24425
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotFileGroup AWS API Documentation
24426
+ #
24427
+ class SnapshotFileGroup < Struct.new(
24428
+ :files)
24429
+ SENSITIVE = []
24430
+ include Aws::Structure
24431
+ end
24432
+
24433
+ # A structure that contains information that identifies the snapshot
24434
+ # that needs to be generated.
24435
+ #
24436
+ # @!attribute [rw] sheet_id
24437
+ # The sheet ID of the dashboard to generate the snapshot artifact
24438
+ # from. This value is required for CSV and PDF format types.
24439
+ # @return [String]
24440
+ #
24441
+ # @!attribute [rw] selection_scope
24442
+ # The selection scope of the visuals on a sheet of a dashboard that
24443
+ # you are generating a snapthot of. You can choose one of the
24444
+ # following options.
24445
+ #
24446
+ # * `ALL_VISUALS` - Selects all visuals that are on the sheet. This
24447
+ # value is required if the snapshot is a PDF.
24448
+ #
24449
+ # * `SELECTED_VISUALS` - Select the visual that you want to add to the
24450
+ # snapshot. This value is required if the snapshot is a CSV.
24451
+ # @return [String]
24452
+ #
24453
+ # @!attribute [rw] visual_ids
24454
+ # A list of visual IDs that are located in the selected sheet. This
24455
+ # structure supports tables and pivot tables. This structure is
24456
+ # required if you are generating a CSV. You can add a maximum of 1
24457
+ # visual ID to this structure.
24458
+ # @return [Array<String>]
24459
+ #
24460
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotFileSheetSelection AWS API Documentation
24461
+ #
24462
+ class SnapshotFileSheetSelection < Struct.new(
24463
+ :sheet_id,
24464
+ :selection_scope,
24465
+ :visual_ids)
24466
+ SENSITIVE = []
24467
+ include Aws::Structure
24468
+ end
24469
+
24470
+ # An object that contains information on the error that caused the
24471
+ # snapshot job to fail.
24472
+ #
24473
+ # @!attribute [rw] error_message
24474
+ # The error message.
24475
+ # @return [String]
24476
+ #
24477
+ # @!attribute [rw] error_type
24478
+ # The error type.
24479
+ # @return [String]
24480
+ #
24481
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotJobErrorInfo AWS API Documentation
24482
+ #
24483
+ class SnapshotJobErrorInfo < Struct.new(
24484
+ :error_message,
24485
+ :error_type)
24486
+ SENSITIVE = []
24487
+ include Aws::Structure
24488
+ end
24489
+
24490
+ # An object that provides information on the result of a snapshot job.
24491
+ # This object provides information about the job, the job status, and
24492
+ # the location of the generated file.
24493
+ #
24494
+ # @!attribute [rw] anonymous_users
24495
+ # A list of `AnonymousUserSnapshotJobResult` objects that contain
24496
+ # information on anonymous users and their user configurations. This
24497
+ # data provided by you when you make a `StartDashboardSnapshotJob` API
24498
+ # call.
24499
+ # @return [Array<Types::AnonymousUserSnapshotJobResult>]
24500
+ #
24501
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotJobResult AWS API Documentation
24502
+ #
24503
+ class SnapshotJobResult < Struct.new(
24504
+ :anonymous_users)
24505
+ SENSITIVE = []
24506
+ include Aws::Structure
24507
+ end
24508
+
24509
+ # Information on the error that caused the snapshot job to fail.
24510
+ #
24511
+ # @!attribute [rw] error_message
24512
+ # The error message.
24513
+ # @return [String]
24514
+ #
24515
+ # @!attribute [rw] error_type
24516
+ # The error type.
24517
+ # @return [String]
24518
+ #
24519
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotJobResultErrorInfo AWS API Documentation
24520
+ #
24521
+ class SnapshotJobResultErrorInfo < Struct.new(
24522
+ :error_message,
24523
+ :error_type)
24524
+ SENSITIVE = []
24525
+ include Aws::Structure
24526
+ end
24527
+
24528
+ # A structure that contains information on the generated snapshot file
24529
+ # groups.
24530
+ #
24531
+ # @!attribute [rw] files
24532
+ # A list of `SnapshotFile` objects.
24533
+ # @return [Array<Types::SnapshotFile>]
24534
+ #
24535
+ # @!attribute [rw] s3_results
24536
+ # A list of `SnapshotJobS3Result` objects.
24537
+ # @return [Array<Types::SnapshotJobS3Result>]
24538
+ #
24539
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotJobResultFileGroup AWS API Documentation
24540
+ #
24541
+ class SnapshotJobResultFileGroup < Struct.new(
24542
+ :files,
24543
+ :s3_results)
24544
+ SENSITIVE = []
24545
+ include Aws::Structure
24546
+ end
24547
+
24548
+ # The Amazon S3 result from the snapshot job. The result includes the
24549
+ # `DestinationConfiguration` and the Amazon S3 Uri. If an error occured
24550
+ # during the job, the result returns information on the error.
24551
+ #
24552
+ # @!attribute [rw] s3_destination_configuration
24553
+ # A list of Amazon S3 bucket configurations that are provided when you
24554
+ # make a `StartDashboardSnapshotJob` API call.
24555
+ # @return [Types::SnapshotS3DestinationConfiguration]
24556
+ #
24557
+ # @!attribute [rw] s3_uri
24558
+ # The Amazon S3 Uri.
24559
+ # @return [String]
24560
+ #
24561
+ # @!attribute [rw] error_info
24562
+ # An array of error records that describe any failures that occur
24563
+ # while the dashboard snapshot job runs.
24564
+ # @return [Array<Types::SnapshotJobResultErrorInfo>]
24565
+ #
24566
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotJobS3Result AWS API Documentation
24567
+ #
24568
+ class SnapshotJobS3Result < Struct.new(
24569
+ :s3_destination_configuration,
24570
+ :s3_uri,
24571
+ :error_info)
24572
+ SENSITIVE = [:s3_uri]
24573
+ include Aws::Structure
24574
+ end
24575
+
24576
+ # A structure that describes the Amazon S3 settings to use to save the
24577
+ # generated dashboard snapshot.
24578
+ #
24579
+ # @!attribute [rw] bucket_configuration
24580
+ # A structure that contains details about the Amazon S3 bucket that
24581
+ # the generated dashboard snapshot is saved in.
24582
+ # @return [Types::S3BucketConfiguration]
24583
+ #
24584
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotS3DestinationConfiguration AWS API Documentation
24585
+ #
24586
+ class SnapshotS3DestinationConfiguration < Struct.new(
24587
+ :bucket_configuration)
24588
+ SENSITIVE = []
24589
+ include Aws::Structure
24590
+ end
24591
+
24592
+ # A structure that contains information about the users that the
24593
+ # dashboard snapshot is generated for.
24594
+ #
24595
+ # @!attribute [rw] anonymous_users
24596
+ # An array of records that describe the anonymous users that the
24597
+ # dashboard snapshot is generated for.
24598
+ # @return [Array<Types::SnapshotAnonymousUser>]
24599
+ #
24600
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotUserConfiguration AWS API Documentation
24601
+ #
24602
+ class SnapshotUserConfiguration < Struct.new(
24603
+ :anonymous_users)
24604
+ SENSITIVE = []
24605
+ include Aws::Structure
24606
+ end
24607
+
24608
+ # A structure that contains information about the users that the
24609
+ # dashboard snapshot is generated for. Sensitive user information is
24610
+ # excluded.
24611
+ #
24612
+ # @!attribute [rw] anonymous_users
24613
+ # An array of records that describe anonymous users that the dashboard
24614
+ # snapshot is generated for. Sensitive user information is excluded.
24615
+ # @return [Array<Types::SnapshotAnonymousUserRedacted>]
24616
+ #
24617
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotUserConfigurationRedacted AWS API Documentation
24618
+ #
24619
+ class SnapshotUserConfigurationRedacted < Struct.new(
24620
+ :anonymous_users)
24621
+ SENSITIVE = []
24622
+ include Aws::Structure
24623
+ end
24624
+
23944
24625
  # The parameters for Snowflake.
23945
24626
  #
23946
24627
  # @!attribute [rw] host
@@ -24217,6 +24898,74 @@ module Aws::QuickSight
24217
24898
  include Aws::Structure
24218
24899
  end
24219
24900
 
24901
+ # @!attribute [rw] aws_account_id
24902
+ # The ID of the Amazon Web Services account that the dashboard
24903
+ # snapshot job is executed in.
24904
+ # @return [String]
24905
+ #
24906
+ # @!attribute [rw] dashboard_id
24907
+ # The ID of the dashboard that you want to start a snapshot job for.
24908
+ # @return [String]
24909
+ #
24910
+ # @!attribute [rw] snapshot_job_id
24911
+ # An ID for the dashboard snapshot job. This ID is unique to the
24912
+ # dashboard while the job is running. This ID can be used to poll the
24913
+ # status of a job with a `DescribeDashboardSnapshotJob` while the job
24914
+ # runs. You can reuse this ID for another job 24 hours after the
24915
+ # current job is completed.
24916
+ # @return [String]
24917
+ #
24918
+ # @!attribute [rw] user_configuration
24919
+ # A structure that contains information about the anonymous users that
24920
+ # the generated snapshot is for. This API will not return information
24921
+ # about registered Amazon QuickSight.
24922
+ # @return [Types::SnapshotUserConfiguration]
24923
+ #
24924
+ # @!attribute [rw] snapshot_configuration
24925
+ # A structure that describes the configuration of the dashboard
24926
+ # snapshot.
24927
+ # @return [Types::SnapshotConfiguration]
24928
+ #
24929
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/StartDashboardSnapshotJobRequest AWS API Documentation
24930
+ #
24931
+ class StartDashboardSnapshotJobRequest < Struct.new(
24932
+ :aws_account_id,
24933
+ :dashboard_id,
24934
+ :snapshot_job_id,
24935
+ :user_configuration,
24936
+ :snapshot_configuration)
24937
+ SENSITIVE = []
24938
+ include Aws::Structure
24939
+ end
24940
+
24941
+ # @!attribute [rw] arn
24942
+ # The Amazon Resource Name (ARN) for the dashboard snapshot job.
24943
+ # @return [String]
24944
+ #
24945
+ # @!attribute [rw] snapshot_job_id
24946
+ # The ID of the job. The job ID is set when you start a new job with a
24947
+ # `StartDashboardSnapshotJob` API call.
24948
+ # @return [String]
24949
+ #
24950
+ # @!attribute [rw] request_id
24951
+ # The Amazon Web Services request ID for this operation.
24952
+ # @return [String]
24953
+ #
24954
+ # @!attribute [rw] status
24955
+ # The HTTP status of the request
24956
+ # @return [Integer]
24957
+ #
24958
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/StartDashboardSnapshotJobResponse AWS API Documentation
24959
+ #
24960
+ class StartDashboardSnapshotJobResponse < Struct.new(
24961
+ :arn,
24962
+ :snapshot_job_id,
24963
+ :request_id,
24964
+ :status)
24965
+ SENSITIVE = []
24966
+ include Aws::Structure
24967
+ end
24968
+
24220
24969
  # The state perssitence configuration of an embedded dashboard.
24221
24970
  #
24222
24971
  # @!attribute [rw] enabled
@@ -24431,6 +25180,10 @@ module Aws::QuickSight
24431
25180
  # The cell styling options for the subtotals of header cells.
24432
25181
  # @return [Types::TableCellStyle]
24433
25182
  #
25183
+ # @!attribute [rw] style_targets
25184
+ # The style targets options for subtotals.
25185
+ # @return [Array<Types::TableStyleTarget>]
25186
+ #
24434
25187
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SubtotalOptions AWS API Documentation
24435
25188
  #
24436
25189
  class SubtotalOptions < Struct.new(
@@ -24440,7 +25193,8 @@ module Aws::QuickSight
24440
25193
  :field_level_options,
24441
25194
  :total_cell_style,
24442
25195
  :value_cell_style,
24443
- :metric_header_cell_style)
25196
+ :metric_header_cell_style,
25197
+ :style_targets)
24444
25198
  SENSITIVE = []
24445
25199
  include Aws::Structure
24446
25200
  end
@@ -24980,6 +25734,20 @@ module Aws::QuickSight
24980
25734
  include Aws::Structure
24981
25735
  end
24982
25736
 
25737
+ # The table style target.
25738
+ #
25739
+ # @!attribute [rw] cell_type
25740
+ # The cell type of the table style target.
25741
+ # @return [String]
25742
+ #
25743
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TableStyleTarget AWS API Documentation
25744
+ #
25745
+ class TableStyleTarget < Struct.new(
25746
+ :cell_type)
25747
+ SENSITIVE = []
25748
+ include Aws::Structure
25749
+ end
25750
+
24983
25751
  # The unaggregated field well for the table.
24984
25752
  #
24985
25753
  # @!attribute [rw] values
@@ -25520,11 +26288,16 @@ module Aws::QuickSight
25520
26288
  # The configuration of the placeholder options in a text area control.
25521
26289
  # @return [Types::TextControlPlaceholderOptions]
25522
26290
  #
26291
+ # @!attribute [rw] info_icon_label_options
26292
+ # The configuration of info icon label options.
26293
+ # @return [Types::SheetControlInfoIconLabelOptions]
26294
+ #
25523
26295
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TextAreaControlDisplayOptions AWS API Documentation
25524
26296
  #
25525
26297
  class TextAreaControlDisplayOptions < Struct.new(
25526
26298
  :title_options,
25527
- :placeholder_options)
26299
+ :placeholder_options,
26300
+ :info_icon_label_options)
25528
26301
  SENSITIVE = []
25529
26302
  include Aws::Structure
25530
26303
  end
@@ -25579,11 +26352,16 @@ module Aws::QuickSight
25579
26352
  # control.
25580
26353
  # @return [Types::TextControlPlaceholderOptions]
25581
26354
  #
26355
+ # @!attribute [rw] info_icon_label_options
26356
+ # The configuration of info icon label options.
26357
+ # @return [Types::SheetControlInfoIconLabelOptions]
26358
+ #
25582
26359
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TextFieldControlDisplayOptions AWS API Documentation
25583
26360
  #
25584
26361
  class TextFieldControlDisplayOptions < Struct.new(
25585
26362
  :title_options,
25586
- :placeholder_options)
26363
+ :placeholder_options,
26364
+ :info_icon_label_options)
25587
26365
  SENSITIVE = []
25588
26366
  include Aws::Structure
25589
26367
  end
@@ -26378,6 +27156,10 @@ module Aws::QuickSight
26378
27156
  # The other names or aliases for the calculated field cell value.
26379
27157
  # @return [Array<Types::CellValueSynonym>]
26380
27158
  #
27159
+ # @!attribute [rw] non_additive
27160
+ # The non additive for the table style target.
27161
+ # @return [Boolean]
27162
+ #
26381
27163
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TopicCalculatedField AWS API Documentation
26382
27164
  #
26383
27165
  class TopicCalculatedField < Struct.new(
@@ -26396,7 +27178,8 @@ module Aws::QuickSight
26396
27178
  :allowed_aggregations,
26397
27179
  :not_allowed_aggregations,
26398
27180
  :never_aggregate_in_filter,
26399
- :cell_value_synonyms)
27181
+ :cell_value_synonyms,
27182
+ :non_additive)
26400
27183
  SENSITIVE = [:expression]
26401
27184
  include Aws::Structure
26402
27185
  end
@@ -26485,8 +27268,7 @@ module Aws::QuickSight
26485
27268
  #
26486
27269
  # @!attribute [rw] aggregation
26487
27270
  # The type of aggregation that is performed on the column data when
26488
- # it's queried. Valid values for this structure are `SUM`, `MAX`,
26489
- # `MIN`, `COUNT`, `DISTINCT_COUNT`, and `AVERAGE`.
27271
+ # it's queried.
26490
27272
  # @return [String]
26491
27273
  #
26492
27274
  # @!attribute [rw] is_included_in_topic
@@ -26540,6 +27322,10 @@ module Aws::QuickSight
26540
27322
  # The other names or aliases for the column cell value.
26541
27323
  # @return [Array<Types::CellValueSynonym>]
26542
27324
  #
27325
+ # @!attribute [rw] non_additive
27326
+ # The non additive value for the column.
27327
+ # @return [Boolean]
27328
+ #
26543
27329
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TopicColumn AWS API Documentation
26544
27330
  #
26545
27331
  class TopicColumn < Struct.new(
@@ -26558,7 +27344,8 @@ module Aws::QuickSight
26558
27344
  :not_allowed_aggregations,
26559
27345
  :default_formatting,
26560
27346
  :never_aggregate_in_filter,
26561
- :cell_value_synonyms)
27347
+ :cell_value_synonyms,
27348
+ :non_additive)
26562
27349
  SENSITIVE = []
26563
27350
  include Aws::Structure
26564
27351
  end