aws-sdk-quicksight 1.86.0 → 1.87.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.
@@ -224,12 +224,17 @@ module Aws::QuickSight
224
224
  # * `MAX`: Select the largest date value.
225
225
  # @return [String]
226
226
  #
227
+ # @!attribute [rw] attribute_aggregation_function
228
+ # Aggregation for attributes.
229
+ # @return [Types::AttributeAggregationFunction]
230
+ #
227
231
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AggregationFunction AWS API Documentation
228
232
  #
229
233
  class AggregationFunction < Struct.new(
230
234
  :numerical_aggregation_function,
231
235
  :categorical_aggregation_function,
232
- :date_aggregation_function)
236
+ :date_aggregation_function,
237
+ :attribute_aggregation_function)
233
238
  SENSITIVE = []
234
239
  include Aws::Structure
235
240
  end
@@ -716,6 +721,26 @@ module Aws::QuickSight
716
721
  include Aws::Structure
717
722
  end
718
723
 
724
+ # A structure that contains the file groups that are requested for the
725
+ # artifact generation in a `StartDashboardSnapshotJob` API call.
726
+ #
727
+ # @!attribute [rw] file_groups
728
+ # A list of `SnapshotJobResultFileGroup` objects that contain
729
+ # information on the files that are requested during a
730
+ # `StartDashboardSnapshotJob` API call. If the job succeeds, these
731
+ # objects contain the location where the snapshot artifacts are
732
+ # stored. If the job fails, the objects contain information about the
733
+ # error that caused the job to fail.
734
+ # @return [Array<Types::SnapshotJobResultFileGroup>]
735
+ #
736
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnonymousUserSnapshotJobResult AWS API Documentation
737
+ #
738
+ class AnonymousUserSnapshotJobResult < Struct.new(
739
+ :file_groups)
740
+ SENSITIVE = []
741
+ include Aws::Structure
742
+ end
743
+
719
744
  # The arc axis configuration of a `GaugeChartVisual`.
720
745
  #
721
746
  # @!attribute [rw] range
@@ -1536,6 +1561,32 @@ module Aws::QuickSight
1536
1561
  include Aws::Structure
1537
1562
  end
1538
1563
 
1564
+ # Aggregation for attributes.
1565
+ #
1566
+ # @!attribute [rw] simple_attribute_aggregation
1567
+ # The built-in aggregation functions for attributes.
1568
+ #
1569
+ # * `UNIQUE_VALUE`: Returns the unique value for a field, aggregated
1570
+ # by the dimension fields.
1571
+ #
1572
+ # ^
1573
+ # @return [String]
1574
+ #
1575
+ # @!attribute [rw] value_for_multiple_values
1576
+ # Used by the `UNIQUE_VALUE` aggregation function. If there are
1577
+ # multiple values for the field used by the aggregation, the value for
1578
+ # this property will be returned instead. Defaults to '*'.
1579
+ # @return [String]
1580
+ #
1581
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AttributeAggregationFunction AWS API Documentation
1582
+ #
1583
+ class AttributeAggregationFunction < Struct.new(
1584
+ :simple_attribute_aggregation,
1585
+ :value_for_multiple_values)
1586
+ SENSITIVE = []
1587
+ include Aws::Structure
1588
+ end
1589
+
1539
1590
  # Parameters for Amazon Aurora.
1540
1591
  #
1541
1592
  # @!attribute [rw] host
@@ -7936,11 +7987,16 @@ module Aws::QuickSight
7936
7987
  # Customize how dates are formatted in controls.
7937
7988
  # @return [String]
7938
7989
  #
7990
+ # @!attribute [rw] info_icon_label_options
7991
+ # The configuration of info icon label options.
7992
+ # @return [Types::SheetControlInfoIconLabelOptions]
7993
+ #
7939
7994
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DateTimePickerControlDisplayOptions AWS API Documentation
7940
7995
  #
7941
7996
  class DateTimePickerControlDisplayOptions < Struct.new(
7942
7997
  :title_options,
7943
- :date_time_format)
7998
+ :date_time_format,
7999
+ :info_icon_label_options)
7944
8000
  SENSITIVE = []
7945
8001
  include Aws::Structure
7946
8002
  end
@@ -10137,6 +10193,185 @@ module Aws::QuickSight
10137
10193
  include Aws::Structure
10138
10194
  end
10139
10195
 
10196
+ # @!attribute [rw] aws_account_id
10197
+ # The ID of the Amazon Web Services account that the dashboard
10198
+ # snapshot job is executed in.
10199
+ # @return [String]
10200
+ #
10201
+ # @!attribute [rw] dashboard_id
10202
+ # The ID of the dashboard that you have started a snapshot job for.
10203
+ # @return [String]
10204
+ #
10205
+ # @!attribute [rw] snapshot_job_id
10206
+ # The ID of the job to be described. The job ID is set when you start
10207
+ # a new job with a `StartDashboardSnapshotJob` API call.
10208
+ # @return [String]
10209
+ #
10210
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardSnapshotJobRequest AWS API Documentation
10211
+ #
10212
+ class DescribeDashboardSnapshotJobRequest < Struct.new(
10213
+ :aws_account_id,
10214
+ :dashboard_id,
10215
+ :snapshot_job_id)
10216
+ SENSITIVE = []
10217
+ include Aws::Structure
10218
+ end
10219
+
10220
+ # @!attribute [rw] aws_account_id
10221
+ # The ID of the Amazon Web Services account that the dashboard
10222
+ # snapshot job is executed in.
10223
+ # @return [String]
10224
+ #
10225
+ # @!attribute [rw] dashboard_id
10226
+ # The ID of the dashboard that you have started a snapshot job for.
10227
+ # @return [String]
10228
+ #
10229
+ # @!attribute [rw] snapshot_job_id
10230
+ # The ID of the job to be described. The job ID is set when you start
10231
+ # a new job with a `StartDashboardSnapshotJob` API call.
10232
+ # @return [String]
10233
+ #
10234
+ # @!attribute [rw] user_configuration
10235
+ # The user configuration for the snapshot job. This information is
10236
+ # provided when you make a `StartDashboardSnapshotJob` API call.
10237
+ # @return [Types::SnapshotUserConfigurationRedacted]
10238
+ #
10239
+ # @!attribute [rw] snapshot_configuration
10240
+ # The snapshot configuration of the job. This information is provided
10241
+ # when you make a `StartDashboardSnapshotJob` API call.
10242
+ # @return [Types::SnapshotConfiguration]
10243
+ #
10244
+ # @!attribute [rw] arn
10245
+ # The Amazon Resource Name (ARN) for the snapshot job. The job ARN is
10246
+ # generated when you start a new job with a
10247
+ # `StartDashboardSnapshotJob` API call.
10248
+ # @return [String]
10249
+ #
10250
+ # @!attribute [rw] job_status
10251
+ # Indicates the status of a job. The status updates as the job
10252
+ # executes. This shows one of the following values.
10253
+ #
10254
+ # * `COMPLETED` - The job was completed successfully.
10255
+ #
10256
+ # * `FAILED` - The job failed to execute.
10257
+ #
10258
+ # * `QUEUED` - The job is queued and hasn't started yet.
10259
+ #
10260
+ # * `RUNNING` - The job is still running.
10261
+ # @return [String]
10262
+ #
10263
+ # @!attribute [rw] created_time
10264
+ # The time that the snapshot job was created.
10265
+ # @return [Time]
10266
+ #
10267
+ # @!attribute [rw] last_updated_time
10268
+ # The time that the snapshot job status was last updated.
10269
+ # @return [Time]
10270
+ #
10271
+ # @!attribute [rw] request_id
10272
+ # The Amazon Web Services request ID for this operation.
10273
+ # @return [String]
10274
+ #
10275
+ # @!attribute [rw] status
10276
+ # The HTTP status of the request
10277
+ # @return [Integer]
10278
+ #
10279
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardSnapshotJobResponse AWS API Documentation
10280
+ #
10281
+ class DescribeDashboardSnapshotJobResponse < Struct.new(
10282
+ :aws_account_id,
10283
+ :dashboard_id,
10284
+ :snapshot_job_id,
10285
+ :user_configuration,
10286
+ :snapshot_configuration,
10287
+ :arn,
10288
+ :job_status,
10289
+ :created_time,
10290
+ :last_updated_time,
10291
+ :request_id,
10292
+ :status)
10293
+ SENSITIVE = []
10294
+ include Aws::Structure
10295
+ end
10296
+
10297
+ # @!attribute [rw] aws_account_id
10298
+ # The ID of the Amazon Web Services account that the dashboard
10299
+ # snapshot job is executed in.
10300
+ # @return [String]
10301
+ #
10302
+ # @!attribute [rw] dashboard_id
10303
+ # The ID of the dashboard that you have started a snapshot job for.
10304
+ # @return [String]
10305
+ #
10306
+ # @!attribute [rw] snapshot_job_id
10307
+ # The ID of the job to be described. The job ID is set when you start
10308
+ # a new job with a `StartDashboardSnapshotJob` API call.
10309
+ # @return [String]
10310
+ #
10311
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardSnapshotJobResultRequest AWS API Documentation
10312
+ #
10313
+ class DescribeDashboardSnapshotJobResultRequest < Struct.new(
10314
+ :aws_account_id,
10315
+ :dashboard_id,
10316
+ :snapshot_job_id)
10317
+ SENSITIVE = []
10318
+ include Aws::Structure
10319
+ end
10320
+
10321
+ # @!attribute [rw] arn
10322
+ # The Amazon Resource Name (ARN) for the snapshot job. The job ARN is
10323
+ # generated when you start a new job with a
10324
+ # `StartDashboardSnapshotJob` API call.
10325
+ # @return [String]
10326
+ #
10327
+ # @!attribute [rw] job_status
10328
+ # Indicates the status of a job after it has reached a terminal state.
10329
+ # A finished snapshot job will retuen a `COMPLETED` or `FAILED`
10330
+ # status.
10331
+ # @return [String]
10332
+ #
10333
+ # @!attribute [rw] created_time
10334
+ # The time that a snapshot job was created.
10335
+ # @return [Time]
10336
+ #
10337
+ # @!attribute [rw] last_updated_time
10338
+ # The time that a snapshot job status was last updated.
10339
+ # @return [Time]
10340
+ #
10341
+ # @!attribute [rw] result
10342
+ # The result of the snapshot job. Jobs that have successfully
10343
+ # completed will return the S3Uri where they are located. Jobs that
10344
+ # have failedwill return information on the error that caused the job
10345
+ # to fail.
10346
+ # @return [Types::SnapshotJobResult]
10347
+ #
10348
+ # @!attribute [rw] error_info
10349
+ # Displays information for the error that caused a job to fail.
10350
+ # @return [Types::SnapshotJobErrorInfo]
10351
+ #
10352
+ # @!attribute [rw] request_id
10353
+ # The Amazon Web Services request ID for this operation.
10354
+ # @return [String]
10355
+ #
10356
+ # @!attribute [rw] status
10357
+ # The HTTP status of the request
10358
+ # @return [Integer]
10359
+ #
10360
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardSnapshotJobResultResponse AWS API Documentation
10361
+ #
10362
+ class DescribeDashboardSnapshotJobResultResponse < Struct.new(
10363
+ :arn,
10364
+ :job_status,
10365
+ :created_time,
10366
+ :last_updated_time,
10367
+ :result,
10368
+ :error_info,
10369
+ :request_id,
10370
+ :status)
10371
+ SENSITIVE = []
10372
+ include Aws::Structure
10373
+ end
10374
+
10140
10375
  # @!attribute [rw] aws_account_id
10141
10376
  # The Amazon Web Services account ID.
10142
10377
  # @return [String]
@@ -11765,11 +12000,16 @@ module Aws::QuickSight
11765
12000
  # The options to configure the title visibility, name, and font size.
11766
12001
  # @return [Types::LabelOptions]
11767
12002
  #
12003
+ # @!attribute [rw] info_icon_label_options
12004
+ # The configuration of info icon label options.
12005
+ # @return [Types::SheetControlInfoIconLabelOptions]
12006
+ #
11768
12007
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DropDownControlDisplayOptions AWS API Documentation
11769
12008
  #
11770
12009
  class DropDownControlDisplayOptions < Struct.new(
11771
12010
  :select_all_options,
11772
- :title_options)
12011
+ :title_options,
12012
+ :info_icon_label_options)
11773
12013
  SENSITIVE = []
11774
12014
  include Aws::Structure
11775
12015
  end
@@ -16704,12 +16944,17 @@ module Aws::QuickSight
16704
16944
  # The options to configure the title visibility, name, and font size.
16705
16945
  # @return [Types::LabelOptions]
16706
16946
  #
16947
+ # @!attribute [rw] info_icon_label_options
16948
+ # The configuration of info icon label options.
16949
+ # @return [Types::SheetControlInfoIconLabelOptions]
16950
+ #
16707
16951
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListControlDisplayOptions AWS API Documentation
16708
16952
  #
16709
16953
  class ListControlDisplayOptions < Struct.new(
16710
16954
  :search_options,
16711
16955
  :select_all_options,
16712
- :title_options)
16956
+ :title_options,
16957
+ :info_icon_label_options)
16713
16958
  SENSITIVE = []
16714
16959
  include Aws::Structure
16715
16960
  end
@@ -21901,11 +22146,16 @@ module Aws::QuickSight
21901
22146
  # Customize how dates are formatted in controls.
21902
22147
  # @return [String]
21903
22148
  #
22149
+ # @!attribute [rw] info_icon_label_options
22150
+ # The configuration of info icon label options.
22151
+ # @return [Types::SheetControlInfoIconLabelOptions]
22152
+ #
21904
22153
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RelativeDateTimeControlDisplayOptions AWS API Documentation
21905
22154
  #
21906
22155
  class RelativeDateTimeControlDisplayOptions < Struct.new(
21907
22156
  :title_options,
21908
- :date_time_format)
22157
+ :date_time_format,
22158
+ :info_icon_label_options)
21909
22159
  SENSITIVE = []
21910
22160
  include Aws::Structure
21911
22161
  end
@@ -22335,6 +22585,37 @@ module Aws::QuickSight
22335
22585
  include Aws::Structure
22336
22586
  end
22337
22587
 
22588
+ # An optional structure that contains the Amazon S3 bucket configuration
22589
+ # that the generated snapshots are stored in. If you don't provide this
22590
+ # information, generated snapshots are stored in the default Amazon
22591
+ # QuickSight bucket.
22592
+ #
22593
+ # @!attribute [rw] bucket_name
22594
+ # The name of an existing Amazon S3 bucket where the generated
22595
+ # snapshot artifacts are sent.
22596
+ # @return [String]
22597
+ #
22598
+ # @!attribute [rw] bucket_prefix
22599
+ # The prefix of the Amazon S3 bucket that the generated snapshots are
22600
+ # stored in.
22601
+ # @return [String]
22602
+ #
22603
+ # @!attribute [rw] bucket_region
22604
+ # The region that the Amazon S3 bucket is located in. The bucket must
22605
+ # be located in the same region that the `StartDashboardSnapshotJob`
22606
+ # API call is made.
22607
+ # @return [String]
22608
+ #
22609
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/S3BucketConfiguration AWS API Documentation
22610
+ #
22611
+ class S3BucketConfiguration < Struct.new(
22612
+ :bucket_name,
22613
+ :bucket_prefix,
22614
+ :bucket_region)
22615
+ SENSITIVE = []
22616
+ include Aws::Structure
22617
+ end
22618
+
22338
22619
  # The parameters for S3.
22339
22620
  #
22340
22621
  # @!attribute [rw] manifest_file_location
@@ -23530,6 +23811,25 @@ module Aws::QuickSight
23530
23811
  include Aws::Structure
23531
23812
  end
23532
23813
 
23814
+ # A control to display info icons for filters and parameters.
23815
+ #
23816
+ # @!attribute [rw] visibility
23817
+ # The visibility configuration of info icon label options.
23818
+ # @return [String]
23819
+ #
23820
+ # @!attribute [rw] info_icon_text
23821
+ # The text content of info icon.
23822
+ # @return [String]
23823
+ #
23824
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SheetControlInfoIconLabelOptions AWS API Documentation
23825
+ #
23826
+ class SheetControlInfoIconLabelOptions < Struct.new(
23827
+ :visibility,
23828
+ :info_icon_text)
23829
+ SENSITIVE = []
23830
+ include Aws::Structure
23831
+ end
23832
+
23533
23833
  # A grid layout to define the placement of sheet control.
23534
23834
  #
23535
23835
  # @!attribute [rw] configuration
@@ -23867,10 +24167,15 @@ module Aws::QuickSight
23867
24167
  # The options to configure the title visibility, name, and font size.
23868
24168
  # @return [Types::LabelOptions]
23869
24169
  #
24170
+ # @!attribute [rw] info_icon_label_options
24171
+ # The configuration of info icon label options.
24172
+ # @return [Types::SheetControlInfoIconLabelOptions]
24173
+ #
23870
24174
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SliderControlDisplayOptions AWS API Documentation
23871
24175
  #
23872
24176
  class SliderControlDisplayOptions < Struct.new(
23873
- :title_options)
24177
+ :title_options,
24178
+ :info_icon_label_options)
23874
24179
  SENSITIVE = []
23875
24180
  include Aws::Structure
23876
24181
  end
@@ -23941,6 +24246,327 @@ module Aws::QuickSight
23941
24246
  include Aws::Structure
23942
24247
  end
23943
24248
 
24249
+ # A structure that contains information on the anonymous user
24250
+ # configuration.
24251
+ #
24252
+ # @!attribute [rw] row_level_permission_tags
24253
+ # The tags to be used for row-level security (RLS). Make sure that the
24254
+ # relevant datasets have RLS tags configured before you start a
24255
+ # snapshot export job. You can configure the RLS tags of a dataset
24256
+ # with a `DataSet$RowLevelPermissionTagConfiguration` API call.
24257
+ #
24258
+ # These are not the tags that are used for Amazon Web Services
24259
+ # resource tagging. For more information on row level security in
24260
+ # Amazon QuickSight, see [Using Row-Level Security (RLS) with
24261
+ # Tags][1]in the *Amazon QuickSight User Guide*.
24262
+ #
24263
+ #
24264
+ #
24265
+ # [1]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html
24266
+ # @return [Array<Types::SessionTag>]
24267
+ #
24268
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotAnonymousUser AWS API Documentation
24269
+ #
24270
+ class SnapshotAnonymousUser < Struct.new(
24271
+ :row_level_permission_tags)
24272
+ SENSITIVE = []
24273
+ include Aws::Structure
24274
+ end
24275
+
24276
+ # Use this structure to redact sensitive information that you provide
24277
+ # about an anonymous user from the snapshot.
24278
+ #
24279
+ # @!attribute [rw] row_level_permission_tag_keys
24280
+ # The tag keys for the `RowLevelPermissionTags`.
24281
+ # @return [Array<String>]
24282
+ #
24283
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotAnonymousUserRedacted AWS API Documentation
24284
+ #
24285
+ class SnapshotAnonymousUserRedacted < Struct.new(
24286
+ :row_level_permission_tag_keys)
24287
+ SENSITIVE = []
24288
+ include Aws::Structure
24289
+ end
24290
+
24291
+ # Describes the configuration of the dashboard snapshot.
24292
+ #
24293
+ # @!attribute [rw] file_groups
24294
+ # A list of `SnapshotJobResultFileGroup` objects that contain
24295
+ # information about the snapshot that is generated. This list can hold
24296
+ # a maximum of 6 `FileGroup` configurations.
24297
+ # @return [Array<Types::SnapshotFileGroup>]
24298
+ #
24299
+ # @!attribute [rw] destination_configuration
24300
+ # A structure that contains information on the Amazon S3 bucket that
24301
+ # the generated snapshot is stored in.
24302
+ # @return [Types::SnapshotDestinationConfiguration]
24303
+ #
24304
+ # @!attribute [rw] parameters
24305
+ # A list of Amazon QuickSight parameters and the list's override
24306
+ # values.
24307
+ # @return [Types::Parameters]
24308
+ #
24309
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotConfiguration AWS API Documentation
24310
+ #
24311
+ class SnapshotConfiguration < Struct.new(
24312
+ :file_groups,
24313
+ :destination_configuration,
24314
+ :parameters)
24315
+ SENSITIVE = []
24316
+ include Aws::Structure
24317
+ end
24318
+
24319
+ # A structure that contains information on the Amazon S3 destinations of
24320
+ # the generated snapshot.
24321
+ #
24322
+ # @!attribute [rw] s3_destinations
24323
+ # A list of `SnapshotS3DestinationConfiguration` objects that contain
24324
+ # Amazon S3 destination configurations. This structure can hold a
24325
+ # maximum of 1 `S3DestinationConfiguration`.
24326
+ # @return [Array<Types::SnapshotS3DestinationConfiguration>]
24327
+ #
24328
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotDestinationConfiguration AWS API Documentation
24329
+ #
24330
+ class SnapshotDestinationConfiguration < Struct.new(
24331
+ :s3_destinations)
24332
+ SENSITIVE = []
24333
+ include Aws::Structure
24334
+ end
24335
+
24336
+ # A structure that contains the information for the snapshot that you
24337
+ # want to generate. This information is provided by you when you start a
24338
+ # new snapshot job.
24339
+ #
24340
+ # @!attribute [rw] sheet_selections
24341
+ # A list of `SnapshotFileSheetSelection` objects that contain
24342
+ # information on the dashboard sheet that is exported. These objects
24343
+ # provide information about the snapshot artifacts that are generated
24344
+ # during the job. This structure can hold a maximum of 5 CSV
24345
+ # configurations or 1 configuration for PDF.
24346
+ # @return [Array<Types::SnapshotFileSheetSelection>]
24347
+ #
24348
+ # @!attribute [rw] format_type
24349
+ # The format of the snapshot file to be generated. You can choose
24350
+ # between `CSV` and `PDF`.
24351
+ # @return [String]
24352
+ #
24353
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotFile AWS API Documentation
24354
+ #
24355
+ class SnapshotFile < Struct.new(
24356
+ :sheet_selections,
24357
+ :format_type)
24358
+ SENSITIVE = []
24359
+ include Aws::Structure
24360
+ end
24361
+
24362
+ # A structure that contains the information on the snapshot files.
24363
+ #
24364
+ # @!attribute [rw] files
24365
+ # A list of `SnapshotFile` objects that contain the information on the
24366
+ # snapshot files that need to be generated. This structure can hold 1
24367
+ # configuration at a time.
24368
+ # @return [Array<Types::SnapshotFile>]
24369
+ #
24370
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotFileGroup AWS API Documentation
24371
+ #
24372
+ class SnapshotFileGroup < Struct.new(
24373
+ :files)
24374
+ SENSITIVE = []
24375
+ include Aws::Structure
24376
+ end
24377
+
24378
+ # A structure that contains information that identifies the snapshot
24379
+ # that needs to be generated.
24380
+ #
24381
+ # @!attribute [rw] sheet_id
24382
+ # The sheet ID of the dashboard to generate the snapshot artifact
24383
+ # from. This value is required for CSV or PDF format types.
24384
+ # @return [String]
24385
+ #
24386
+ # @!attribute [rw] selection_scope
24387
+ # The selection scope of the visuals on a sheet of a dashboard that
24388
+ # you are generating a snapthot of. You can choose one of the
24389
+ # following options.
24390
+ #
24391
+ # * `ALL_VISUALS` - Selects all visuals that are on the sheet. This
24392
+ # value is required if the snapshot is a PDF.
24393
+ #
24394
+ # * `SELECTED_VISUALS` - Select the visual that you want to add to the
24395
+ # snapshot. This value is required if the snapshot is a CSV.
24396
+ # @return [String]
24397
+ #
24398
+ # @!attribute [rw] visual_ids
24399
+ # A structure that lists the IDs of the visuals in the selected sheet.
24400
+ # Supported visual types are table, pivot table visuals. This value is
24401
+ # required if you are generating a CSV. This value supports a maximum
24402
+ # of 1 visual ID.
24403
+ # @return [Array<String>]
24404
+ #
24405
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotFileSheetSelection AWS API Documentation
24406
+ #
24407
+ class SnapshotFileSheetSelection < Struct.new(
24408
+ :sheet_id,
24409
+ :selection_scope,
24410
+ :visual_ids)
24411
+ SENSITIVE = []
24412
+ include Aws::Structure
24413
+ end
24414
+
24415
+ # An object that contains information on the error that caused the
24416
+ # snapshot job to fail.
24417
+ #
24418
+ # @!attribute [rw] error_message
24419
+ # The error message.
24420
+ # @return [String]
24421
+ #
24422
+ # @!attribute [rw] error_type
24423
+ # The error type.
24424
+ # @return [String]
24425
+ #
24426
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotJobErrorInfo AWS API Documentation
24427
+ #
24428
+ class SnapshotJobErrorInfo < Struct.new(
24429
+ :error_message,
24430
+ :error_type)
24431
+ SENSITIVE = []
24432
+ include Aws::Structure
24433
+ end
24434
+
24435
+ # An object that provides information on the result of a snapshot job.
24436
+ # This object provides information about the job, the job status, and
24437
+ # the location of the generated file.
24438
+ #
24439
+ # @!attribute [rw] anonymous_users
24440
+ # A list of `AnonymousUserSnapshotJobResult` objects that contain
24441
+ # information on anonymous users and their user configurations. This
24442
+ # data provided by you when you make a `StartDashboardSnapshotJob` API
24443
+ # call.
24444
+ # @return [Array<Types::AnonymousUserSnapshotJobResult>]
24445
+ #
24446
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotJobResult AWS API Documentation
24447
+ #
24448
+ class SnapshotJobResult < Struct.new(
24449
+ :anonymous_users)
24450
+ SENSITIVE = []
24451
+ include Aws::Structure
24452
+ end
24453
+
24454
+ # Information on the error that caused the snapshot job to fail.
24455
+ #
24456
+ # @!attribute [rw] error_message
24457
+ # The error message.
24458
+ # @return [String]
24459
+ #
24460
+ # @!attribute [rw] error_type
24461
+ # The error type.
24462
+ # @return [String]
24463
+ #
24464
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotJobResultErrorInfo AWS API Documentation
24465
+ #
24466
+ class SnapshotJobResultErrorInfo < Struct.new(
24467
+ :error_message,
24468
+ :error_type)
24469
+ SENSITIVE = []
24470
+ include Aws::Structure
24471
+ end
24472
+
24473
+ # A structure that contains information on the generated snapshot file
24474
+ # groups.
24475
+ #
24476
+ # @!attribute [rw] files
24477
+ # A list of `SnapshotFile` objects.
24478
+ # @return [Array<Types::SnapshotFile>]
24479
+ #
24480
+ # @!attribute [rw] s3_results
24481
+ # A list of `SnapshotJobS3Result` objects.
24482
+ # @return [Array<Types::SnapshotJobS3Result>]
24483
+ #
24484
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotJobResultFileGroup AWS API Documentation
24485
+ #
24486
+ class SnapshotJobResultFileGroup < Struct.new(
24487
+ :files,
24488
+ :s3_results)
24489
+ SENSITIVE = []
24490
+ include Aws::Structure
24491
+ end
24492
+
24493
+ # The Amazon S3 result from the snapshot job. The result includes the
24494
+ # `DestinationConfiguration` and the Amazon S3 Uri. If an error occured
24495
+ # during the job, the result returns information on the error.
24496
+ #
24497
+ # @!attribute [rw] s3_destination_configuration
24498
+ # A list of Amazon S3 bucket configurations that are provided when you
24499
+ # make a `StartDashboardSnapshotJob` API call.
24500
+ # @return [Types::SnapshotS3DestinationConfiguration]
24501
+ #
24502
+ # @!attribute [rw] s3_uri
24503
+ # The Amazon S3 Uri.
24504
+ # @return [String]
24505
+ #
24506
+ # @!attribute [rw] error_info
24507
+ # An array of error records that describe any failures that occur
24508
+ # while the dashboard snapshot job runs.
24509
+ # @return [Array<Types::SnapshotJobResultErrorInfo>]
24510
+ #
24511
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotJobS3Result AWS API Documentation
24512
+ #
24513
+ class SnapshotJobS3Result < Struct.new(
24514
+ :s3_destination_configuration,
24515
+ :s3_uri,
24516
+ :error_info)
24517
+ SENSITIVE = [:s3_uri]
24518
+ include Aws::Structure
24519
+ end
24520
+
24521
+ # A structure that describes the Amazon S3 settings to use to save the
24522
+ # generated dashboard snapshot.
24523
+ #
24524
+ # @!attribute [rw] bucket_configuration
24525
+ # A structure that contains details about the Amazon S3 bucket that
24526
+ # the generated dashboard snapshot is saved in.
24527
+ # @return [Types::S3BucketConfiguration]
24528
+ #
24529
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotS3DestinationConfiguration AWS API Documentation
24530
+ #
24531
+ class SnapshotS3DestinationConfiguration < Struct.new(
24532
+ :bucket_configuration)
24533
+ SENSITIVE = []
24534
+ include Aws::Structure
24535
+ end
24536
+
24537
+ # A structure that contains information about the users that the
24538
+ # dashboard snapshot is generated for.
24539
+ #
24540
+ # @!attribute [rw] anonymous_users
24541
+ # An array of records that describe the anonymous users that the
24542
+ # dashboard snapshot is generated for.
24543
+ # @return [Array<Types::SnapshotAnonymousUser>]
24544
+ #
24545
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotUserConfiguration AWS API Documentation
24546
+ #
24547
+ class SnapshotUserConfiguration < Struct.new(
24548
+ :anonymous_users)
24549
+ SENSITIVE = []
24550
+ include Aws::Structure
24551
+ end
24552
+
24553
+ # A structure that contains information about the users that the
24554
+ # dashboard snapshot is generated for. Sensitive user information is
24555
+ # excluded.
24556
+ #
24557
+ # @!attribute [rw] anonymous_users
24558
+ # An array of records that describe anonymous users that the dashboard
24559
+ # snapshot is generated for. Sensitive user information is excluded.
24560
+ # @return [Array<Types::SnapshotAnonymousUserRedacted>]
24561
+ #
24562
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SnapshotUserConfigurationRedacted AWS API Documentation
24563
+ #
24564
+ class SnapshotUserConfigurationRedacted < Struct.new(
24565
+ :anonymous_users)
24566
+ SENSITIVE = []
24567
+ include Aws::Structure
24568
+ end
24569
+
23944
24570
  # The parameters for Snowflake.
23945
24571
  #
23946
24572
  # @!attribute [rw] host
@@ -24217,6 +24843,74 @@ module Aws::QuickSight
24217
24843
  include Aws::Structure
24218
24844
  end
24219
24845
 
24846
+ # @!attribute [rw] aws_account_id
24847
+ # The ID of the Amazon Web Services account that the dashboard
24848
+ # snapshot job is executed in.
24849
+ # @return [String]
24850
+ #
24851
+ # @!attribute [rw] dashboard_id
24852
+ # The ID of the dashboard that you want to start a snapshot job for.
24853
+ # @return [String]
24854
+ #
24855
+ # @!attribute [rw] snapshot_job_id
24856
+ # An ID for the dashboard snapshot job. This ID is unique to the
24857
+ # dashboard while the job is running. This ID can be used to poll the
24858
+ # status of a job with a `DescribeDashboardSnapshotJob` while the job
24859
+ # runs. You can reuse this ID for another job 24 hours after the
24860
+ # current job is completed.
24861
+ # @return [String]
24862
+ #
24863
+ # @!attribute [rw] user_configuration
24864
+ # A structure that contains information about the anonymous users that
24865
+ # the generated snapshot is for. This API will not return information
24866
+ # about registered Amazon QuickSight.
24867
+ # @return [Types::SnapshotUserConfiguration]
24868
+ #
24869
+ # @!attribute [rw] snapshot_configuration
24870
+ # A structure that describes the configuration of the dashboard
24871
+ # snapshot.
24872
+ # @return [Types::SnapshotConfiguration]
24873
+ #
24874
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/StartDashboardSnapshotJobRequest AWS API Documentation
24875
+ #
24876
+ class StartDashboardSnapshotJobRequest < Struct.new(
24877
+ :aws_account_id,
24878
+ :dashboard_id,
24879
+ :snapshot_job_id,
24880
+ :user_configuration,
24881
+ :snapshot_configuration)
24882
+ SENSITIVE = []
24883
+ include Aws::Structure
24884
+ end
24885
+
24886
+ # @!attribute [rw] arn
24887
+ # The Amazon Resource Name (ARN) for the dashboard snapshot job.
24888
+ # @return [String]
24889
+ #
24890
+ # @!attribute [rw] snapshot_job_id
24891
+ # The ID of the job. The job ID is set when you start a new job with a
24892
+ # `StartDashboardSnapshotJob` API call.
24893
+ # @return [String]
24894
+ #
24895
+ # @!attribute [rw] request_id
24896
+ # The Amazon Web Services request ID for this operation.
24897
+ # @return [String]
24898
+ #
24899
+ # @!attribute [rw] status
24900
+ # The HTTP status of the request
24901
+ # @return [Integer]
24902
+ #
24903
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/StartDashboardSnapshotJobResponse AWS API Documentation
24904
+ #
24905
+ class StartDashboardSnapshotJobResponse < Struct.new(
24906
+ :arn,
24907
+ :snapshot_job_id,
24908
+ :request_id,
24909
+ :status)
24910
+ SENSITIVE = []
24911
+ include Aws::Structure
24912
+ end
24913
+
24220
24914
  # The state perssitence configuration of an embedded dashboard.
24221
24915
  #
24222
24916
  # @!attribute [rw] enabled
@@ -25520,11 +26214,16 @@ module Aws::QuickSight
25520
26214
  # The configuration of the placeholder options in a text area control.
25521
26215
  # @return [Types::TextControlPlaceholderOptions]
25522
26216
  #
26217
+ # @!attribute [rw] info_icon_label_options
26218
+ # The configuration of info icon label options.
26219
+ # @return [Types::SheetControlInfoIconLabelOptions]
26220
+ #
25523
26221
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TextAreaControlDisplayOptions AWS API Documentation
25524
26222
  #
25525
26223
  class TextAreaControlDisplayOptions < Struct.new(
25526
26224
  :title_options,
25527
- :placeholder_options)
26225
+ :placeholder_options,
26226
+ :info_icon_label_options)
25528
26227
  SENSITIVE = []
25529
26228
  include Aws::Structure
25530
26229
  end
@@ -25579,11 +26278,16 @@ module Aws::QuickSight
25579
26278
  # control.
25580
26279
  # @return [Types::TextControlPlaceholderOptions]
25581
26280
  #
26281
+ # @!attribute [rw] info_icon_label_options
26282
+ # The configuration of info icon label options.
26283
+ # @return [Types::SheetControlInfoIconLabelOptions]
26284
+ #
25582
26285
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TextFieldControlDisplayOptions AWS API Documentation
25583
26286
  #
25584
26287
  class TextFieldControlDisplayOptions < Struct.new(
25585
26288
  :title_options,
25586
- :placeholder_options)
26289
+ :placeholder_options,
26290
+ :info_icon_label_options)
25587
26291
  SENSITIVE = []
25588
26292
  include Aws::Structure
25589
26293
  end