aws-sdk 2.1419.0 → 2.1421.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.
@@ -459,6 +459,22 @@ declare class QuickSight extends Service {
459
459
  * Describes read and write permissions for a dashboard.
460
460
  */
461
461
  describeDashboardPermissions(callback?: (err: AWSError, data: QuickSight.Types.DescribeDashboardPermissionsResponse) => void): Request<QuickSight.Types.DescribeDashboardPermissionsResponse, AWSError>;
462
+ /**
463
+ * Describes an existing snapshot job. Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see JobStatus.
464
+ */
465
+ describeDashboardSnapshotJob(params: QuickSight.Types.DescribeDashboardSnapshotJobRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeDashboardSnapshotJobResponse) => void): Request<QuickSight.Types.DescribeDashboardSnapshotJobResponse, AWSError>;
466
+ /**
467
+ * Describes an existing snapshot job. Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see JobStatus.
468
+ */
469
+ describeDashboardSnapshotJob(callback?: (err: AWSError, data: QuickSight.Types.DescribeDashboardSnapshotJobResponse) => void): Request<QuickSight.Types.DescribeDashboardSnapshotJobResponse, AWSError>;
470
+ /**
471
+ * Describes the result of an existing snapshot job that has finished running. A finished snapshot job will return a COMPLETED or FAILED status when you poll the job with a DescribeDashboardSnapshotJob API call. If the job has not finished running, this operation returns a message that says Dashboard Snapshot Job with id &lt;SnapshotjobId&gt; has not reached a terminal state..
472
+ */
473
+ describeDashboardSnapshotJobResult(params: QuickSight.Types.DescribeDashboardSnapshotJobResultRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeDashboardSnapshotJobResultResponse) => void): Request<QuickSight.Types.DescribeDashboardSnapshotJobResultResponse, AWSError>;
474
+ /**
475
+ * Describes the result of an existing snapshot job that has finished running. A finished snapshot job will return a COMPLETED or FAILED status when you poll the job with a DescribeDashboardSnapshotJob API call. If the job has not finished running, this operation returns a message that says Dashboard Snapshot Job with id &lt;SnapshotjobId&gt; has not reached a terminal state..
476
+ */
477
+ describeDashboardSnapshotJobResult(callback?: (err: AWSError, data: QuickSight.Types.DescribeDashboardSnapshotJobResultResponse) => void): Request<QuickSight.Types.DescribeDashboardSnapshotJobResultResponse, AWSError>;
462
478
  /**
463
479
  * Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.
464
480
  */
@@ -1027,6 +1043,14 @@ declare class QuickSight extends Service {
1027
1043
  * Starts an Asset Bundle import job. An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 5 import jobs concurrently. The API caller must have the necessary "create", "describe", and "update" permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.
1028
1044
  */
1029
1045
  startAssetBundleImportJob(callback?: (err: AWSError, data: QuickSight.Types.StartAssetBundleImportJobResponse) => void): Request<QuickSight.Types.StartAssetBundleImportJobResponse, AWSError>;
1046
+ /**
1047
+ * Starts an asynchronous job that generates a dashboard snapshot. You can request up to one paginated PDF and up to five CSVs per API call. Poll job descriptions with a DescribeDashboardSnapshotJob API call. Once the job succeeds, use the DescribeDashboardSnapshotJobResult API to obtain the download URIs that the job generates.
1048
+ */
1049
+ startDashboardSnapshotJob(params: QuickSight.Types.StartDashboardSnapshotJobRequest, callback?: (err: AWSError, data: QuickSight.Types.StartDashboardSnapshotJobResponse) => void): Request<QuickSight.Types.StartDashboardSnapshotJobResponse, AWSError>;
1050
+ /**
1051
+ * Starts an asynchronous job that generates a dashboard snapshot. You can request up to one paginated PDF and up to five CSVs per API call. Poll job descriptions with a DescribeDashboardSnapshotJob API call. Once the job succeeds, use the DescribeDashboardSnapshotJobResult API to obtain the download URIs that the job generates.
1052
+ */
1053
+ startDashboardSnapshotJob(callback?: (err: AWSError, data: QuickSight.Types.StartDashboardSnapshotJobResponse) => void): Request<QuickSight.Types.StartDashboardSnapshotJobResponse, AWSError>;
1030
1054
  /**
1031
1055
  * Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data set, data source, dashboard, template, and topic. Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for the following: You can't use tags to track costs for Amazon QuickSight. This isn't possible because you can't tag the resources that Amazon QuickSight costs are based on, for example Amazon QuickSight storage capacity (SPICE), number of users, type of users, and usage metrics. Amazon QuickSight doesn't currently support the tag editor for Resource Groups.
1032
1056
  */
@@ -1367,6 +1391,10 @@ declare namespace QuickSight {
1367
1391
  * Aggregation for date values. COUNT: Aggregate by the total number of values, including duplicates. DISTINCT_COUNT: Aggregate by the total number of distinct values. MIN: Select the smallest date value. MAX: Select the largest date value.
1368
1392
  */
1369
1393
  DateAggregationFunction?: DateAggregationFunction;
1394
+ /**
1395
+ * Aggregation for attributes.
1396
+ */
1397
+ AttributeAggregationFunction?: AttributeAggregationFunction;
1370
1398
  }
1371
1399
  export type AggregationFunctionParameters = {[key: string]: LimitedString};
1372
1400
  export interface AggregationSortConfiguration {
@@ -1591,6 +1619,13 @@ declare namespace QuickSight {
1591
1619
  */
1592
1620
  InitialTopicId: RestrictiveResourceId;
1593
1621
  }
1622
+ export interface AnonymousUserSnapshotJobResult {
1623
+ /**
1624
+ * A list of SnapshotJobResultFileGroup objects that contain information on the files that are requested during a StartDashboardSnapshotJob API call. If the job succeeds, these objects contain the location where the snapshot artifacts are stored. If the job fails, the objects contain information about the error that caused the job to fail.
1625
+ */
1626
+ FileGroups?: SnapshotJobResultFileGroupList;
1627
+ }
1628
+ export type AnonymousUserSnapshotJobResultList = AnonymousUserSnapshotJobResult[];
1594
1629
  export interface ArcAxisConfiguration {
1595
1630
  /**
1596
1631
  * The arc axis range of a GaugeChartVisual.
@@ -2043,6 +2078,16 @@ declare namespace QuickSight {
2043
2078
  */
2044
2079
  RoleArn?: RoleArn;
2045
2080
  }
2081
+ export interface AttributeAggregationFunction {
2082
+ /**
2083
+ * The built-in aggregation functions for attributes. UNIQUE_VALUE: Returns the unique value for a field, aggregated by the dimension fields.
2084
+ */
2085
+ SimpleAttributeAggregation?: SimpleAttributeAggregationFunction;
2086
+ /**
2087
+ * Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to '*'.
2088
+ */
2089
+ ValueForMultipleValues?: String;
2090
+ }
2046
2091
  export interface AuroraParameters {
2047
2092
  /**
2048
2093
  * Host.
@@ -5639,6 +5684,10 @@ declare namespace QuickSight {
5639
5684
  * Customize how dates are formatted in controls.
5640
5685
  */
5641
5686
  DateTimeFormat?: DateTimeFormat;
5687
+ /**
5688
+ * The configuration of info icon label options.
5689
+ */
5690
+ InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
5642
5691
  }
5643
5692
  export interface DateTimeValueWhenUnsetConfiguration {
5644
5693
  /**
@@ -6881,6 +6930,114 @@ declare namespace QuickSight {
6881
6930
  */
6882
6931
  RequestId?: String;
6883
6932
  }
6933
+ export interface DescribeDashboardSnapshotJobRequest {
6934
+ /**
6935
+ * The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
6936
+ */
6937
+ AwsAccountId: AwsAccountId;
6938
+ /**
6939
+ * The ID of the dashboard that you have started a snapshot job for.
6940
+ */
6941
+ DashboardId: ShortRestrictiveResourceId;
6942
+ /**
6943
+ * The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.
6944
+ */
6945
+ SnapshotJobId: ShortRestrictiveResourceId;
6946
+ }
6947
+ export interface DescribeDashboardSnapshotJobResponse {
6948
+ /**
6949
+ * The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
6950
+ */
6951
+ AwsAccountId?: AwsAccountId;
6952
+ /**
6953
+ * The ID of the dashboard that you have started a snapshot job for.
6954
+ */
6955
+ DashboardId?: ShortRestrictiveResourceId;
6956
+ /**
6957
+ * The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.
6958
+ */
6959
+ SnapshotJobId?: ShortRestrictiveResourceId;
6960
+ /**
6961
+ * The user configuration for the snapshot job. This information is provided when you make a StartDashboardSnapshotJob API call.
6962
+ */
6963
+ UserConfiguration?: SnapshotUserConfigurationRedacted;
6964
+ /**
6965
+ * The snapshot configuration of the job. This information is provided when you make a StartDashboardSnapshotJob API call.
6966
+ */
6967
+ SnapshotConfiguration?: SnapshotConfiguration;
6968
+ /**
6969
+ * The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.
6970
+ */
6971
+ Arn?: Arn;
6972
+ /**
6973
+ * Indicates the status of a job. The status updates as the job executes. This shows one of the following values. COMPLETED - The job was completed successfully. FAILED - The job failed to execute. QUEUED - The job is queued and hasn't started yet. RUNNING - The job is still running.
6974
+ */
6975
+ JobStatus?: SnapshotJobStatus;
6976
+ /**
6977
+ * The time that the snapshot job was created.
6978
+ */
6979
+ CreatedTime?: Timestamp;
6980
+ /**
6981
+ * The time that the snapshot job status was last updated.
6982
+ */
6983
+ LastUpdatedTime?: Timestamp;
6984
+ /**
6985
+ * The Amazon Web Services request ID for this operation.
6986
+ */
6987
+ RequestId?: NonEmptyString;
6988
+ /**
6989
+ * The HTTP status of the request
6990
+ */
6991
+ Status?: StatusCode;
6992
+ }
6993
+ export interface DescribeDashboardSnapshotJobResultRequest {
6994
+ /**
6995
+ * The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
6996
+ */
6997
+ AwsAccountId: AwsAccountId;
6998
+ /**
6999
+ * The ID of the dashboard that you have started a snapshot job for.
7000
+ */
7001
+ DashboardId: ShortRestrictiveResourceId;
7002
+ /**
7003
+ * The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.
7004
+ */
7005
+ SnapshotJobId: ShortRestrictiveResourceId;
7006
+ }
7007
+ export interface DescribeDashboardSnapshotJobResultResponse {
7008
+ /**
7009
+ * The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.
7010
+ */
7011
+ Arn?: Arn;
7012
+ /**
7013
+ * Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a COMPLETED or FAILED status.
7014
+ */
7015
+ JobStatus?: SnapshotJobStatus;
7016
+ /**
7017
+ * The time that a snapshot job was created.
7018
+ */
7019
+ CreatedTime?: Timestamp;
7020
+ /**
7021
+ * The time that a snapshot job status was last updated.
7022
+ */
7023
+ LastUpdatedTime?: Timestamp;
7024
+ /**
7025
+ * The result of the snapshot job. Jobs that have successfully completed will return the S3Uri where they are located. Jobs that have failedwill return information on the error that caused the job to fail.
7026
+ */
7027
+ Result?: SnapshotJobResult;
7028
+ /**
7029
+ * Displays information for the error that caused a job to fail.
7030
+ */
7031
+ ErrorInfo?: SnapshotJobErrorInfo;
7032
+ /**
7033
+ * The Amazon Web Services request ID for this operation.
7034
+ */
7035
+ RequestId?: NonEmptyString;
7036
+ /**
7037
+ * The HTTP status of the request
7038
+ */
7039
+ Status?: StatusCode;
7040
+ }
6884
7041
  export interface DescribeDataSetPermissionsRequest {
6885
7042
  /**
6886
7043
  * The Amazon Web Services account ID.
@@ -7850,6 +8007,10 @@ declare namespace QuickSight {
7850
8007
  * The options to configure the title visibility, name, and font size.
7851
8008
  */
7852
8009
  TitleOptions?: LabelOptions;
8010
+ /**
8011
+ * The configuration of info icon label options.
8012
+ */
8013
+ InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
7853
8014
  }
7854
8015
  export interface DynamicDefaultValue {
7855
8016
  /**
@@ -10513,6 +10674,10 @@ declare namespace QuickSight {
10513
10674
  * The options to configure the title visibility, name, and font size.
10514
10675
  */
10515
10676
  TitleOptions?: LabelOptions;
10677
+ /**
10678
+ * The configuration of info icon label options.
10679
+ */
10680
+ InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
10516
10681
  }
10517
10682
  export interface ListControlSearchOptions {
10518
10683
  /**
@@ -13439,6 +13604,10 @@ declare namespace QuickSight {
13439
13604
  * Customize how dates are formatted in controls.
13440
13605
  */
13441
13606
  DateTimeFormat?: DateTimeFormat;
13607
+ /**
13608
+ * The configuration of info icon label options.
13609
+ */
13610
+ InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
13442
13611
  }
13443
13612
  export type RelativeDateType = "PREVIOUS"|"THIS"|"LAST"|"NOW"|"NEXT"|string;
13444
13613
  export interface RelativeDatesFilter {
@@ -13638,6 +13807,20 @@ declare namespace QuickSight {
13638
13807
  export type RowLevelPermissionTagRuleList = RowLevelPermissionTagRule[];
13639
13808
  export type RowSortList = FieldSortOptions[];
13640
13809
  export type S3Bucket = string;
13810
+ export interface S3BucketConfiguration {
13811
+ /**
13812
+ * The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.
13813
+ */
13814
+ BucketName: NonEmptyString;
13815
+ /**
13816
+ * The prefix of the Amazon S3 bucket that the generated snapshots are stored in.
13817
+ */
13818
+ BucketPrefix: NonEmptyString;
13819
+ /**
13820
+ * The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob API call is made.
13821
+ */
13822
+ BucketRegion: NonEmptyString;
13823
+ }
13641
13824
  export type S3Key = string;
13642
13825
  export interface S3Parameters {
13643
13826
  /**
@@ -14239,6 +14422,7 @@ declare namespace QuickSight {
14239
14422
  export type SensitiveLong = number;
14240
14423
  export type SensitiveLongList = SensitiveLong[];
14241
14424
  export type SensitiveLongObject = number;
14425
+ export type SensitiveS3Uri = string;
14242
14426
  export type SensitiveString = string;
14243
14427
  export type SensitiveStringList = SensitiveString[];
14244
14428
  export type SensitiveStringObject = string;
@@ -14273,6 +14457,7 @@ declare namespace QuickSight {
14273
14457
  Value: SessionTagValue;
14274
14458
  }
14275
14459
  export type SessionTagKey = string;
14460
+ export type SessionTagKeyList = SessionTagKey[];
14276
14461
  export type SessionTagList = SessionTag[];
14277
14462
  export type SessionTagValue = string;
14278
14463
  export interface SetParameterValueConfiguration {
@@ -14301,6 +14486,17 @@ declare namespace QuickSight {
14301
14486
  }
14302
14487
  export type SheetContentType = "PAGINATED"|"INTERACTIVE"|string;
14303
14488
  export type SheetControlDateTimePickerType = "SINGLE_VALUED"|"DATE_RANGE"|string;
14489
+ export interface SheetControlInfoIconLabelOptions {
14490
+ /**
14491
+ * The visibility configuration of info icon label options.
14492
+ */
14493
+ Visibility?: Visibility;
14494
+ /**
14495
+ * The text content of info icon.
14496
+ */
14497
+ InfoIconText?: SheetControlInfoIconText;
14498
+ }
14499
+ export type SheetControlInfoIconText = string;
14304
14500
  export interface SheetControlLayout {
14305
14501
  /**
14306
14502
  * The configuration that determines the elements and canvas size options of sheet control.
@@ -14465,6 +14661,7 @@ declare namespace QuickSight {
14465
14661
  */
14466
14662
  directoryType?: String;
14467
14663
  }
14664
+ export type SimpleAttributeAggregationFunction = "UNIQUE_VALUE"|string;
14468
14665
  export interface SimpleClusterMarker {
14469
14666
  /**
14470
14667
  * The color of the simple cluster marker.
@@ -14478,6 +14675,10 @@ declare namespace QuickSight {
14478
14675
  * The options to configure the title visibility, name, and font size.
14479
14676
  */
14480
14677
  TitleOptions?: LabelOptions;
14678
+ /**
14679
+ * The configuration of info icon label options.
14680
+ */
14681
+ InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
14481
14682
  }
14482
14683
  export type SmallMultiplesAxisPlacement = "OUTSIDE"|"INSIDE"|string;
14483
14684
  export interface SmallMultiplesAxisProperties {
@@ -14514,6 +14715,146 @@ declare namespace QuickSight {
14514
14715
  */
14515
14716
  YAxis?: SmallMultiplesAxisProperties;
14516
14717
  }
14718
+ export interface SnapshotAnonymousUser {
14719
+ /**
14720
+ * The tags to be used for row-level security (RLS). Make sure that the relevant datasets have RLS tags configured before you start a snapshot export job. You can configure the RLS tags of a dataset with a DataSet$RowLevelPermissionTagConfiguration API call. These are not the tags that are used for Amazon Web Services resource tagging. For more information on row level security in Amazon QuickSight, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.
14721
+ */
14722
+ RowLevelPermissionTags?: SessionTagList;
14723
+ }
14724
+ export type SnapshotAnonymousUserList = SnapshotAnonymousUser[];
14725
+ export interface SnapshotAnonymousUserRedacted {
14726
+ /**
14727
+ * The tag keys for the RowLevelPermissionTags.
14728
+ */
14729
+ RowLevelPermissionTagKeys?: SessionTagKeyList;
14730
+ }
14731
+ export type SnapshotAnonymousUserRedactedList = SnapshotAnonymousUserRedacted[];
14732
+ export interface SnapshotConfiguration {
14733
+ /**
14734
+ * A list of SnapshotJobResultFileGroup objects that contain information about the snapshot that is generated. This list can hold a maximum of 6 FileGroup configurations.
14735
+ */
14736
+ FileGroups: SnapshotFileGroupList;
14737
+ /**
14738
+ * A structure that contains information on the Amazon S3 bucket that the generated snapshot is stored in.
14739
+ */
14740
+ DestinationConfiguration?: SnapshotDestinationConfiguration;
14741
+ Parameters?: Parameters;
14742
+ }
14743
+ export interface SnapshotDestinationConfiguration {
14744
+ /**
14745
+ * A list of SnapshotS3DestinationConfiguration objects that contain Amazon S3 destination configurations. This structure can hold a maximum of 1 S3DestinationConfiguration.
14746
+ */
14747
+ S3Destinations?: SnapshotS3DestinationConfigurationList;
14748
+ }
14749
+ export interface SnapshotFile {
14750
+ /**
14751
+ * A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations or 1 configuration for PDF.
14752
+ */
14753
+ SheetSelections: SnapshotFileSheetSelectionList;
14754
+ /**
14755
+ * The format of the snapshot file to be generated. You can choose between CSV and PDF.
14756
+ */
14757
+ FormatType: SnapshotFileFormatType;
14758
+ }
14759
+ export type SnapshotFileFormatType = "CSV"|"PDF"|string;
14760
+ export interface SnapshotFileGroup {
14761
+ /**
14762
+ * A list of SnapshotFile objects that contain the information on the snapshot files that need to be generated. This structure can hold 1 configuration at a time.
14763
+ */
14764
+ Files?: SnapshotFileList;
14765
+ }
14766
+ export type SnapshotFileGroupList = SnapshotFileGroup[];
14767
+ export type SnapshotFileList = SnapshotFile[];
14768
+ export interface SnapshotFileSheetSelection {
14769
+ /**
14770
+ * The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV or PDF format types.
14771
+ */
14772
+ SheetId: ShortRestrictiveResourceId;
14773
+ /**
14774
+ * The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options. ALL_VISUALS - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF. SELECTED_VISUALS - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV.
14775
+ */
14776
+ SelectionScope: SnapshotFileSheetSelectionScope;
14777
+ /**
14778
+ * A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV. This value supports a maximum of 1 visual ID.
14779
+ */
14780
+ VisualIds?: SnapshotFileSheetSelectionVisualIdList;
14781
+ }
14782
+ export type SnapshotFileSheetSelectionList = SnapshotFileSheetSelection[];
14783
+ export type SnapshotFileSheetSelectionScope = "ALL_VISUALS"|"SELECTED_VISUALS"|string;
14784
+ export type SnapshotFileSheetSelectionVisualIdList = ShortRestrictiveResourceId[];
14785
+ export interface SnapshotJobErrorInfo {
14786
+ /**
14787
+ * The error message.
14788
+ */
14789
+ ErrorMessage?: String;
14790
+ /**
14791
+ * The error type.
14792
+ */
14793
+ ErrorType?: String;
14794
+ }
14795
+ export interface SnapshotJobResult {
14796
+ /**
14797
+ * A list of AnonymousUserSnapshotJobResult objects that contain information on anonymous users and their user configurations. This data provided by you when you make a StartDashboardSnapshotJob API call.
14798
+ */
14799
+ AnonymousUsers?: AnonymousUserSnapshotJobResultList;
14800
+ }
14801
+ export interface SnapshotJobResultErrorInfo {
14802
+ /**
14803
+ * The error message.
14804
+ */
14805
+ ErrorMessage?: String;
14806
+ /**
14807
+ * The error type.
14808
+ */
14809
+ ErrorType?: String;
14810
+ }
14811
+ export type SnapshotJobResultErrorInfoList = SnapshotJobResultErrorInfo[];
14812
+ export interface SnapshotJobResultFileGroup {
14813
+ /**
14814
+ * A list of SnapshotFile objects.
14815
+ */
14816
+ Files?: SnapshotFileList;
14817
+ /**
14818
+ * A list of SnapshotJobS3Result objects.
14819
+ */
14820
+ S3Results?: SnapshotJobS3ResultList;
14821
+ }
14822
+ export type SnapshotJobResultFileGroupList = SnapshotJobResultFileGroup[];
14823
+ export interface SnapshotJobS3Result {
14824
+ /**
14825
+ * A list of Amazon S3 bucket configurations that are provided when you make a StartDashboardSnapshotJob API call.
14826
+ */
14827
+ S3DestinationConfiguration?: SnapshotS3DestinationConfiguration;
14828
+ /**
14829
+ * The Amazon S3 Uri.
14830
+ */
14831
+ S3Uri?: SensitiveS3Uri;
14832
+ /**
14833
+ * An array of error records that describe any failures that occur while the dashboard snapshot job runs.
14834
+ */
14835
+ ErrorInfo?: SnapshotJobResultErrorInfoList;
14836
+ }
14837
+ export type SnapshotJobS3ResultList = SnapshotJobS3Result[];
14838
+ export type SnapshotJobStatus = "QUEUED"|"RUNNING"|"COMPLETED"|"FAILED"|string;
14839
+ export interface SnapshotS3DestinationConfiguration {
14840
+ /**
14841
+ * A structure that contains details about the Amazon S3 bucket that the generated dashboard snapshot is saved in.
14842
+ */
14843
+ BucketConfiguration?: S3BucketConfiguration;
14844
+ }
14845
+ export type SnapshotS3DestinationConfigurationList = SnapshotS3DestinationConfiguration[];
14846
+ export interface SnapshotUserConfiguration {
14847
+ /**
14848
+ * An array of records that describe the anonymous users that the dashboard snapshot is generated for.
14849
+ */
14850
+ AnonymousUsers?: SnapshotAnonymousUserList;
14851
+ }
14852
+ export interface SnapshotUserConfigurationRedacted {
14853
+ /**
14854
+ * An array of records that describe anonymous users that the dashboard snapshot is generated for. Sensitive user information is excluded.
14855
+ */
14856
+ AnonymousUsers?: SnapshotAnonymousUserRedactedList;
14857
+ }
14517
14858
  export interface SnowflakeParameters {
14518
14859
  /**
14519
14860
  * Host.
@@ -14664,6 +15005,46 @@ declare namespace QuickSight {
14664
15005
  */
14665
15006
  Status?: StatusCode;
14666
15007
  }
15008
+ export interface StartDashboardSnapshotJobRequest {
15009
+ /**
15010
+ * The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
15011
+ */
15012
+ AwsAccountId: AwsAccountId;
15013
+ /**
15014
+ * The ID of the dashboard that you want to start a snapshot job for.
15015
+ */
15016
+ DashboardId: ShortRestrictiveResourceId;
15017
+ /**
15018
+ * An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a DescribeDashboardSnapshotJob while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.
15019
+ */
15020
+ SnapshotJobId: ShortRestrictiveResourceId;
15021
+ /**
15022
+ * A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered Amazon QuickSight.
15023
+ */
15024
+ UserConfiguration: SnapshotUserConfiguration;
15025
+ /**
15026
+ * A structure that describes the configuration of the dashboard snapshot.
15027
+ */
15028
+ SnapshotConfiguration: SnapshotConfiguration;
15029
+ }
15030
+ export interface StartDashboardSnapshotJobResponse {
15031
+ /**
15032
+ * The Amazon Resource Name (ARN) for the dashboard snapshot job.
15033
+ */
15034
+ Arn?: Arn;
15035
+ /**
15036
+ * The ID of the job. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.
15037
+ */
15038
+ SnapshotJobId?: ShortRestrictiveResourceId;
15039
+ /**
15040
+ * The Amazon Web Services request ID for this operation.
15041
+ */
15042
+ RequestId?: NonEmptyString;
15043
+ /**
15044
+ * The HTTP status of the request
15045
+ */
15046
+ Status?: StatusCode;
15047
+ }
14667
15048
  export interface StatePersistenceConfigurations {
14668
15049
  /**
14669
15050
  * Determines if a Amazon QuickSight dashboard's state persistence settings are turned on or off.
@@ -15401,6 +15782,10 @@ declare namespace QuickSight {
15401
15782
  * The configuration of the placeholder options in a text area control.
15402
15783
  */
15403
15784
  PlaceholderOptions?: TextControlPlaceholderOptions;
15785
+ /**
15786
+ * The configuration of info icon label options.
15787
+ */
15788
+ InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
15404
15789
  }
15405
15790
  export interface TextConditionalFormat {
15406
15791
  /**
@@ -15431,6 +15816,10 @@ declare namespace QuickSight {
15431
15816
  * The configuration of the placeholder options in a text field control.
15432
15817
  */
15433
15818
  PlaceholderOptions?: TextControlPlaceholderOptions;
15819
+ /**
15820
+ * The configuration of info icon label options.
15821
+ */
15822
+ InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
15434
15823
  }
15435
15824
  export type TextQualifier = "DOUBLE_QUOTE"|"SINGLE_QUOTE"|string;
15436
15825
  export type TextWrap = "NONE"|"WRAP"|string;