@aws-sdk/client-quicksight 3.296.0 → 3.297.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.
Files changed (151) hide show
  1. package/dist-types/QuickSight.d.ts +127 -0
  2. package/dist-types/QuickSightClient.d.ts +24 -4
  3. package/dist-types/commands/CancelIngestionCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateAccountCustomizationCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateAccountSubscriptionCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateAnalysisCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateDashboardCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateDataSetCommand.d.ts +16 -0
  9. package/dist-types/commands/CreateDataSourceCommand.d.ts +16 -0
  10. package/dist-types/commands/CreateFolderCommand.d.ts +16 -0
  11. package/dist-types/commands/CreateFolderMembershipCommand.d.ts +16 -0
  12. package/dist-types/commands/CreateGroupCommand.d.ts +16 -0
  13. package/dist-types/commands/CreateGroupMembershipCommand.d.ts +16 -0
  14. package/dist-types/commands/CreateIAMPolicyAssignmentCommand.d.ts +16 -0
  15. package/dist-types/commands/CreateIngestionCommand.d.ts +16 -0
  16. package/dist-types/commands/CreateNamespaceCommand.d.ts +16 -0
  17. package/dist-types/commands/CreateTemplateAliasCommand.d.ts +16 -0
  18. package/dist-types/commands/CreateTemplateCommand.d.ts +16 -0
  19. package/dist-types/commands/CreateThemeAliasCommand.d.ts +16 -0
  20. package/dist-types/commands/CreateThemeCommand.d.ts +16 -0
  21. package/dist-types/commands/DeleteAccountCustomizationCommand.d.ts +16 -0
  22. package/dist-types/commands/DeleteAccountSubscriptionCommand.d.ts +16 -0
  23. package/dist-types/commands/DeleteAnalysisCommand.d.ts +16 -0
  24. package/dist-types/commands/DeleteDashboardCommand.d.ts +16 -0
  25. package/dist-types/commands/DeleteDataSetCommand.d.ts +16 -0
  26. package/dist-types/commands/DeleteDataSourceCommand.d.ts +16 -0
  27. package/dist-types/commands/DeleteFolderCommand.d.ts +16 -0
  28. package/dist-types/commands/DeleteFolderMembershipCommand.d.ts +16 -0
  29. package/dist-types/commands/DeleteGroupCommand.d.ts +16 -0
  30. package/dist-types/commands/DeleteGroupMembershipCommand.d.ts +16 -0
  31. package/dist-types/commands/DeleteIAMPolicyAssignmentCommand.d.ts +16 -0
  32. package/dist-types/commands/DeleteNamespaceCommand.d.ts +16 -0
  33. package/dist-types/commands/DeleteTemplateAliasCommand.d.ts +16 -0
  34. package/dist-types/commands/DeleteTemplateCommand.d.ts +16 -0
  35. package/dist-types/commands/DeleteThemeAliasCommand.d.ts +16 -0
  36. package/dist-types/commands/DeleteThemeCommand.d.ts +16 -0
  37. package/dist-types/commands/DeleteUserByPrincipalIdCommand.d.ts +16 -0
  38. package/dist-types/commands/DeleteUserCommand.d.ts +16 -0
  39. package/dist-types/commands/DescribeAccountCustomizationCommand.d.ts +16 -0
  40. package/dist-types/commands/DescribeAccountSettingsCommand.d.ts +16 -0
  41. package/dist-types/commands/DescribeAccountSubscriptionCommand.d.ts +16 -0
  42. package/dist-types/commands/DescribeAnalysisCommand.d.ts +16 -0
  43. package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +16 -0
  44. package/dist-types/commands/DescribeAnalysisPermissionsCommand.d.ts +16 -0
  45. package/dist-types/commands/DescribeDashboardCommand.d.ts +16 -0
  46. package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +16 -0
  47. package/dist-types/commands/DescribeDashboardPermissionsCommand.d.ts +16 -0
  48. package/dist-types/commands/DescribeDataSetCommand.d.ts +16 -0
  49. package/dist-types/commands/DescribeDataSetPermissionsCommand.d.ts +16 -0
  50. package/dist-types/commands/DescribeDataSourceCommand.d.ts +16 -0
  51. package/dist-types/commands/DescribeDataSourcePermissionsCommand.d.ts +16 -0
  52. package/dist-types/commands/DescribeFolderCommand.d.ts +16 -0
  53. package/dist-types/commands/DescribeFolderPermissionsCommand.d.ts +16 -0
  54. package/dist-types/commands/DescribeFolderResolvedPermissionsCommand.d.ts +16 -0
  55. package/dist-types/commands/DescribeGroupCommand.d.ts +16 -0
  56. package/dist-types/commands/DescribeGroupMembershipCommand.d.ts +16 -0
  57. package/dist-types/commands/DescribeIAMPolicyAssignmentCommand.d.ts +16 -0
  58. package/dist-types/commands/DescribeIngestionCommand.d.ts +16 -0
  59. package/dist-types/commands/DescribeIpRestrictionCommand.d.ts +16 -0
  60. package/dist-types/commands/DescribeNamespaceCommand.d.ts +16 -0
  61. package/dist-types/commands/DescribeTemplateAliasCommand.d.ts +16 -0
  62. package/dist-types/commands/DescribeTemplateCommand.d.ts +16 -0
  63. package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +16 -0
  64. package/dist-types/commands/DescribeTemplatePermissionsCommand.d.ts +16 -0
  65. package/dist-types/commands/DescribeThemeAliasCommand.d.ts +16 -0
  66. package/dist-types/commands/DescribeThemeCommand.d.ts +16 -0
  67. package/dist-types/commands/DescribeThemePermissionsCommand.d.ts +16 -0
  68. package/dist-types/commands/DescribeUserCommand.d.ts +16 -0
  69. package/dist-types/commands/GenerateEmbedUrlForAnonymousUserCommand.d.ts +16 -0
  70. package/dist-types/commands/GenerateEmbedUrlForRegisteredUserCommand.d.ts +16 -0
  71. package/dist-types/commands/GetDashboardEmbedUrlCommand.d.ts +16 -0
  72. package/dist-types/commands/GetSessionEmbedUrlCommand.d.ts +16 -0
  73. package/dist-types/commands/ListAnalysesCommand.d.ts +16 -0
  74. package/dist-types/commands/ListDashboardVersionsCommand.d.ts +16 -0
  75. package/dist-types/commands/ListDashboardsCommand.d.ts +16 -0
  76. package/dist-types/commands/ListDataSetsCommand.d.ts +16 -0
  77. package/dist-types/commands/ListDataSourcesCommand.d.ts +16 -0
  78. package/dist-types/commands/ListFolderMembersCommand.d.ts +16 -0
  79. package/dist-types/commands/ListFoldersCommand.d.ts +16 -0
  80. package/dist-types/commands/ListGroupMembershipsCommand.d.ts +16 -0
  81. package/dist-types/commands/ListGroupsCommand.d.ts +16 -0
  82. package/dist-types/commands/ListIAMPolicyAssignmentsCommand.d.ts +16 -0
  83. package/dist-types/commands/ListIAMPolicyAssignmentsForUserCommand.d.ts +16 -0
  84. package/dist-types/commands/ListIngestionsCommand.d.ts +16 -0
  85. package/dist-types/commands/ListNamespacesCommand.d.ts +16 -0
  86. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  87. package/dist-types/commands/ListTemplateAliasesCommand.d.ts +16 -0
  88. package/dist-types/commands/ListTemplateVersionsCommand.d.ts +16 -0
  89. package/dist-types/commands/ListTemplatesCommand.d.ts +16 -0
  90. package/dist-types/commands/ListThemeAliasesCommand.d.ts +16 -0
  91. package/dist-types/commands/ListThemeVersionsCommand.d.ts +16 -0
  92. package/dist-types/commands/ListThemesCommand.d.ts +16 -0
  93. package/dist-types/commands/ListUserGroupsCommand.d.ts +16 -0
  94. package/dist-types/commands/ListUsersCommand.d.ts +16 -0
  95. package/dist-types/commands/RegisterUserCommand.d.ts +16 -0
  96. package/dist-types/commands/RestoreAnalysisCommand.d.ts +16 -0
  97. package/dist-types/commands/SearchAnalysesCommand.d.ts +16 -0
  98. package/dist-types/commands/SearchDashboardsCommand.d.ts +16 -0
  99. package/dist-types/commands/SearchDataSetsCommand.d.ts +16 -0
  100. package/dist-types/commands/SearchDataSourcesCommand.d.ts +16 -0
  101. package/dist-types/commands/SearchFoldersCommand.d.ts +16 -0
  102. package/dist-types/commands/SearchGroupsCommand.d.ts +16 -0
  103. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  104. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  105. package/dist-types/commands/UpdateAccountCustomizationCommand.d.ts +16 -0
  106. package/dist-types/commands/UpdateAccountSettingsCommand.d.ts +16 -0
  107. package/dist-types/commands/UpdateAnalysisCommand.d.ts +16 -0
  108. package/dist-types/commands/UpdateAnalysisPermissionsCommand.d.ts +16 -0
  109. package/dist-types/commands/UpdateDashboardCommand.d.ts +16 -0
  110. package/dist-types/commands/UpdateDashboardPermissionsCommand.d.ts +16 -0
  111. package/dist-types/commands/UpdateDashboardPublishedVersionCommand.d.ts +16 -0
  112. package/dist-types/commands/UpdateDataSetCommand.d.ts +16 -0
  113. package/dist-types/commands/UpdateDataSetPermissionsCommand.d.ts +16 -0
  114. package/dist-types/commands/UpdateDataSourceCommand.d.ts +16 -0
  115. package/dist-types/commands/UpdateDataSourcePermissionsCommand.d.ts +16 -0
  116. package/dist-types/commands/UpdateFolderCommand.d.ts +16 -0
  117. package/dist-types/commands/UpdateFolderPermissionsCommand.d.ts +16 -0
  118. package/dist-types/commands/UpdateGroupCommand.d.ts +16 -0
  119. package/dist-types/commands/UpdateIAMPolicyAssignmentCommand.d.ts +16 -0
  120. package/dist-types/commands/UpdateIpRestrictionCommand.d.ts +16 -0
  121. package/dist-types/commands/UpdatePublicSharingSettingsCommand.d.ts +16 -0
  122. package/dist-types/commands/UpdateTemplateAliasCommand.d.ts +16 -0
  123. package/dist-types/commands/UpdateTemplateCommand.d.ts +16 -0
  124. package/dist-types/commands/UpdateTemplatePermissionsCommand.d.ts +16 -0
  125. package/dist-types/commands/UpdateThemeAliasCommand.d.ts +16 -0
  126. package/dist-types/commands/UpdateThemeCommand.d.ts +16 -0
  127. package/dist-types/commands/UpdateThemePermissionsCommand.d.ts +16 -0
  128. package/dist-types/commands/UpdateUserCommand.d.ts +16 -0
  129. package/dist-types/models/QuickSightServiceException.d.ts +2 -0
  130. package/dist-types/models/models_0.d.ts +422 -0
  131. package/dist-types/models/models_1.d.ts +416 -4
  132. package/dist-types/models/models_2.d.ts +629 -0
  133. package/dist-types/models/models_3.d.ts +360 -3
  134. package/dist-types/pagination/Interfaces.d.ts +3 -0
  135. package/dist-types/pagination/ListAnalysesPaginator.d.ts +3 -0
  136. package/dist-types/pagination/ListDashboardVersionsPaginator.d.ts +3 -0
  137. package/dist-types/pagination/ListDashboardsPaginator.d.ts +3 -0
  138. package/dist-types/pagination/ListDataSetsPaginator.d.ts +3 -0
  139. package/dist-types/pagination/ListDataSourcesPaginator.d.ts +3 -0
  140. package/dist-types/pagination/ListIngestionsPaginator.d.ts +3 -0
  141. package/dist-types/pagination/ListNamespacesPaginator.d.ts +3 -0
  142. package/dist-types/pagination/ListTemplateAliasesPaginator.d.ts +3 -0
  143. package/dist-types/pagination/ListTemplateVersionsPaginator.d.ts +3 -0
  144. package/dist-types/pagination/ListTemplatesPaginator.d.ts +3 -0
  145. package/dist-types/pagination/ListThemeVersionsPaginator.d.ts +3 -0
  146. package/dist-types/pagination/ListThemesPaginator.d.ts +3 -0
  147. package/dist-types/pagination/SearchAnalysesPaginator.d.ts +3 -0
  148. package/dist-types/pagination/SearchDashboardsPaginator.d.ts +3 -0
  149. package/dist-types/pagination/SearchDataSetsPaginator.d.ts +3 -0
  150. package/dist-types/pagination/SearchDataSourcesPaginator.d.ts +3 -0
  151. package/package.json +3 -3
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p>You don't have access to this item. The provided credentials couldn't be
5
6
  * validated. You might not be authorized to carry out the request. Make sure that your
6
7
  * account is authorized to use the Amazon QuickSight service, that your policies have the
@@ -20,6 +21,7 @@ export declare class AccessDeniedException extends __BaseException {
20
21
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
21
22
  }
22
23
  /**
24
+ * @public
23
25
  * <p>The Amazon QuickSight customizations associated with your Amazon Web Services account or a QuickSight namespace in a specific Amazon Web Services Region.</p>
24
26
  */
25
27
  export interface AccountCustomization {
@@ -32,12 +34,16 @@ export interface AccountCustomization {
32
34
  */
33
35
  DefaultEmailCustomizationTemplate?: string;
34
36
  }
37
+ /**
38
+ * @public
39
+ */
35
40
  export declare enum Edition {
36
41
  ENTERPRISE = "ENTERPRISE",
37
42
  ENTERPRISE_AND_Q = "ENTERPRISE_AND_Q",
38
43
  STANDARD = "STANDARD"
39
44
  }
40
45
  /**
46
+ * @public
41
47
  * <p>A structure that contains the following account information
42
48
  * elements:</p>
43
49
  * <ul>
@@ -84,6 +90,7 @@ export interface AccountInfo {
84
90
  AccountSubscriptionStatus?: string;
85
91
  }
86
92
  /**
93
+ * @public
87
94
  * <p>The Amazon QuickSight settings associated with your Amazon Web Services account.</p>
88
95
  */
89
96
  export interface AccountSettings {
@@ -116,6 +123,7 @@ export interface AccountSettings {
116
123
  TerminationProtectionEnabled?: boolean;
117
124
  }
118
125
  /**
126
+ * @public
119
127
  * <p>The active Identity and Access Management (IAM) policy assignment.</p>
120
128
  */
121
129
  export interface ActiveIAMPolicyAssignment {
@@ -128,11 +136,15 @@ export interface ActiveIAMPolicyAssignment {
128
136
  */
129
137
  PolicyArn?: string;
130
138
  }
139
+ /**
140
+ * @public
141
+ */
131
142
  export declare enum DashboardBehavior {
132
143
  DISABLED = "DISABLED",
133
144
  ENABLED = "ENABLED"
134
145
  }
135
146
  /**
147
+ * @public
136
148
  * <p>An ad hoc (one-time) filtering option.</p>
137
149
  */
138
150
  export interface AdHocFilteringOption {
@@ -141,10 +153,16 @@ export interface AdHocFilteringOption {
141
153
  */
142
154
  AvailabilityStatus?: DashboardBehavior | string;
143
155
  }
156
+ /**
157
+ * @public
158
+ */
144
159
  export declare enum CategoricalAggregationFunction {
145
160
  COUNT = "COUNT",
146
161
  DISTINCT_COUNT = "DISTINCT_COUNT"
147
162
  }
163
+ /**
164
+ * @public
165
+ */
148
166
  export declare enum DateAggregationFunction {
149
167
  COUNT = "COUNT",
150
168
  DISTINCT_COUNT = "DISTINCT_COUNT",
@@ -152,6 +170,7 @@ export declare enum DateAggregationFunction {
152
170
  MIN = "MIN"
153
171
  }
154
172
  /**
173
+ * @public
155
174
  * <p>An aggregation based on the percentile of values in a dimension or measure.</p>
156
175
  */
157
176
  export interface PercentileAggregation {
@@ -160,6 +179,9 @@ export interface PercentileAggregation {
160
179
  */
161
180
  PercentileValue?: number;
162
181
  }
182
+ /**
183
+ * @public
184
+ */
163
185
  export declare enum SimpleNumericalAggregationFunction {
164
186
  AVERAGE = "AVERAGE",
165
187
  COUNT = "COUNT",
@@ -174,6 +196,7 @@ export declare enum SimpleNumericalAggregationFunction {
174
196
  VARP = "VARP"
175
197
  }
176
198
  /**
199
+ * @public
177
200
  * <p>Aggregation for numerical values.</p>
178
201
  */
179
202
  export interface NumericalAggregationFunction {
@@ -233,6 +256,7 @@ export interface NumericalAggregationFunction {
233
256
  PercentileAggregation?: PercentileAggregation;
234
257
  }
235
258
  /**
259
+ * @public
236
260
  * <p>An aggregation function aggregates values from a dimension or measure.</p>
237
261
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
238
262
  */
@@ -279,6 +303,7 @@ export interface AggregationFunction {
279
303
  DateAggregationFunction?: DateAggregationFunction | string;
280
304
  }
281
305
  /**
306
+ * @public
282
307
  * <p>A column of a data set.</p>
283
308
  */
284
309
  export interface ColumnIdentifier {
@@ -291,11 +316,15 @@ export interface ColumnIdentifier {
291
316
  */
292
317
  ColumnName: string | undefined;
293
318
  }
319
+ /**
320
+ * @public
321
+ */
294
322
  export declare enum SortDirection {
295
323
  ASC = "ASC",
296
324
  DESC = "DESC"
297
325
  }
298
326
  /**
327
+ * @public
299
328
  * <p>The configuration options to sort aggregated values.</p>
300
329
  */
301
330
  export interface AggregationSortConfiguration {
@@ -323,6 +352,7 @@ export interface AggregationSortConfiguration {
323
352
  AggregationFunction: AggregationFunction | undefined;
324
353
  }
325
354
  /**
355
+ * @public
326
356
  * <p>The parameters for OpenSearch.</p>
327
357
  */
328
358
  export interface AmazonElasticsearchParameters {
@@ -332,6 +362,7 @@ export interface AmazonElasticsearchParameters {
332
362
  Domain: string | undefined;
333
363
  }
334
364
  /**
365
+ * @public
335
366
  * <p>The parameters for OpenSearch.</p>
336
367
  */
337
368
  export interface AmazonOpenSearchParameters {
@@ -340,6 +371,9 @@ export interface AmazonOpenSearchParameters {
340
371
  */
341
372
  Domain: string | undefined;
342
373
  }
374
+ /**
375
+ * @public
376
+ */
343
377
  export declare enum AnalysisErrorType {
344
378
  ACCESS_DENIED = "ACCESS_DENIED",
345
379
  COLUMN_GEOGRAPHIC_ROLE_MISMATCH = "COLUMN_GEOGRAPHIC_ROLE_MISMATCH",
@@ -353,6 +387,7 @@ export declare enum AnalysisErrorType {
353
387
  SOURCE_NOT_FOUND = "SOURCE_NOT_FOUND"
354
388
  }
355
389
  /**
390
+ * @public
356
391
  * <p>An object, structure, or sub-structure of an analysis, template, or dashboard.</p>
357
392
  */
358
393
  export interface Entity {
@@ -362,6 +397,7 @@ export interface Entity {
362
397
  Path?: string;
363
398
  }
364
399
  /**
400
+ * @public
365
401
  * <p>Analysis error.</p>
366
402
  */
367
403
  export interface AnalysisError {
@@ -379,6 +415,7 @@ export interface AnalysisError {
379
415
  ViolatedEntities?: Entity[];
380
416
  }
381
417
  /**
418
+ * @public
382
419
  * <p>A <i>sheet</i>, which is an object that contains a set of visuals that
383
420
  * are viewed together on one page in Amazon QuickSight. Every analysis and dashboard
384
421
  * contains at least one sheet. Each sheet contains at least one visualization widget, for
@@ -396,6 +433,9 @@ export interface Sheet {
396
433
  */
397
434
  Name?: string;
398
435
  }
436
+ /**
437
+ * @public
438
+ */
399
439
  export declare enum ResourceStatus {
400
440
  CREATION_FAILED = "CREATION_FAILED",
401
441
  CREATION_IN_PROGRESS = "CREATION_IN_PROGRESS",
@@ -406,6 +446,7 @@ export declare enum ResourceStatus {
406
446
  UPDATE_SUCCESSFUL = "UPDATE_SUCCESSFUL"
407
447
  }
408
448
  /**
449
+ * @public
409
450
  * <p>Metadata structure for an analysis in Amazon QuickSight</p>
410
451
  */
411
452
  export interface Analysis {
@@ -451,6 +492,7 @@ export interface Analysis {
451
492
  Sheets?: Sheet[];
452
493
  }
453
494
  /**
495
+ * @public
454
496
  * <p>The options that determine the sizing of the canvas used in a free-form layout.</p>
455
497
  */
456
498
  export interface FreeFormLayoutScreenCanvasSizeOptions {
@@ -460,6 +502,7 @@ export interface FreeFormLayoutScreenCanvasSizeOptions {
460
502
  OptimizedViewPortWidth: string | undefined;
461
503
  }
462
504
  /**
505
+ * @public
463
506
  * <p>Configuration options for the canvas of a free-form layout.</p>
464
507
  */
465
508
  export interface FreeFormLayoutCanvasSizeOptions {
@@ -469,6 +512,7 @@ export interface FreeFormLayoutCanvasSizeOptions {
469
512
  ScreenCanvasSizeOptions?: FreeFormLayoutScreenCanvasSizeOptions;
470
513
  }
471
514
  /**
515
+ * @public
472
516
  * <p>The options that determine the default settings of a free-form layout configuration.</p>
473
517
  */
474
518
  export interface DefaultFreeFormLayoutConfiguration {
@@ -477,11 +521,15 @@ export interface DefaultFreeFormLayoutConfiguration {
477
521
  */
478
522
  CanvasSizeOptions: FreeFormLayoutCanvasSizeOptions | undefined;
479
523
  }
524
+ /**
525
+ * @public
526
+ */
480
527
  export declare enum ResizeOption {
481
528
  FIXED = "FIXED",
482
529
  RESPONSIVE = "RESPONSIVE"
483
530
  }
484
531
  /**
532
+ * @public
485
533
  * <p>The options that determine the sizing of the canvas used in a grid layout.</p>
486
534
  */
487
535
  export interface GridLayoutScreenCanvasSizeOptions {
@@ -507,6 +555,7 @@ export interface GridLayoutScreenCanvasSizeOptions {
507
555
  OptimizedViewPortWidth?: string;
508
556
  }
509
557
  /**
558
+ * @public
510
559
  * <p>Configuration options for the canvas of a grid layout.</p>
511
560
  */
512
561
  export interface GridLayoutCanvasSizeOptions {
@@ -516,6 +565,7 @@ export interface GridLayoutCanvasSizeOptions {
516
565
  ScreenCanvasSizeOptions?: GridLayoutScreenCanvasSizeOptions;
517
566
  }
518
567
  /**
568
+ * @public
519
569
  * <p>The options that determine the default settings for a grid layout configuration.</p>
520
570
  */
521
571
  export interface DefaultGridLayoutConfiguration {
@@ -525,6 +575,7 @@ export interface DefaultGridLayoutConfiguration {
525
575
  CanvasSizeOptions: GridLayoutCanvasSizeOptions | undefined;
526
576
  }
527
577
  /**
578
+ * @public
528
579
  * <p>The options that determine the default settings for interactive layout configuration.</p>
529
580
  */
530
581
  export interface DefaultInteractiveLayoutConfiguration {
@@ -538,6 +589,7 @@ export interface DefaultInteractiveLayoutConfiguration {
538
589
  FreeForm?: DefaultFreeFormLayoutConfiguration;
539
590
  }
540
591
  /**
592
+ * @public
541
593
  * <p>The configuration of spacing (often a margin or padding).</p>
542
594
  */
543
595
  export interface Spacing {
@@ -558,10 +610,16 @@ export interface Spacing {
558
610
  */
559
611
  Right?: string;
560
612
  }
613
+ /**
614
+ * @public
615
+ */
561
616
  export declare enum PaperOrientation {
562
617
  LANDSCAPE = "LANDSCAPE",
563
618
  PORTRAIT = "PORTRAIT"
564
619
  }
620
+ /**
621
+ * @public
622
+ */
565
623
  export declare enum PaperSize {
566
624
  A0 = "A0",
567
625
  A1 = "A1",
@@ -576,6 +634,7 @@ export declare enum PaperSize {
576
634
  US_TABLOID_LEDGER = "US_TABLOID_LEDGER"
577
635
  }
578
636
  /**
637
+ * @public
579
638
  * <p>The options for a paper canvas of a section-based layout.</p>
580
639
  */
581
640
  export interface SectionBasedLayoutPaperCanvasSizeOptions {
@@ -603,6 +662,7 @@ export interface SectionBasedLayoutPaperCanvasSizeOptions {
603
662
  PaperMargin?: Spacing;
604
663
  }
605
664
  /**
665
+ * @public
606
666
  * <p>The options for the canvas of a section-based layout.</p>
607
667
  */
608
668
  export interface SectionBasedLayoutCanvasSizeOptions {
@@ -612,6 +672,7 @@ export interface SectionBasedLayoutCanvasSizeOptions {
612
672
  PaperCanvasSizeOptions?: SectionBasedLayoutPaperCanvasSizeOptions;
613
673
  }
614
674
  /**
675
+ * @public
615
676
  * <p>The options that determine the default settings for a section-based layout configuration.</p>
616
677
  */
617
678
  export interface DefaultSectionBasedLayoutConfiguration {
@@ -621,6 +682,7 @@ export interface DefaultSectionBasedLayoutConfiguration {
621
682
  CanvasSizeOptions: SectionBasedLayoutCanvasSizeOptions | undefined;
622
683
  }
623
684
  /**
685
+ * @public
624
686
  * <p>The options that determine the default settings for a paginated layout configuration.</p>
625
687
  */
626
688
  export interface DefaultPaginatedLayoutConfiguration {
@@ -629,11 +691,15 @@ export interface DefaultPaginatedLayoutConfiguration {
629
691
  */
630
692
  SectionBased?: DefaultSectionBasedLayoutConfiguration;
631
693
  }
694
+ /**
695
+ * @public
696
+ */
632
697
  export declare enum SheetContentType {
633
698
  INTERACTIVE = "INTERACTIVE",
634
699
  PAGINATED = "PAGINATED"
635
700
  }
636
701
  /**
702
+ * @public
637
703
  * <p>The configuration for default new sheet settings.</p>
638
704
  */
639
705
  export interface DefaultNewSheetConfiguration {
@@ -651,6 +717,7 @@ export interface DefaultNewSheetConfiguration {
651
717
  SheetContentType?: SheetContentType | string;
652
718
  }
653
719
  /**
720
+ * @public
654
721
  * <p>The configuration for default analysis settings.</p>
655
722
  */
656
723
  export interface AnalysisDefaults {
@@ -660,6 +727,7 @@ export interface AnalysisDefaults {
660
727
  DefaultNewSheetConfiguration: DefaultNewSheetConfiguration | undefined;
661
728
  }
662
729
  /**
730
+ * @public
663
731
  * <p>The calculated field of an analysis.</p>
664
732
  */
665
733
  export interface CalculatedField {
@@ -677,6 +745,7 @@ export interface CalculatedField {
677
745
  Expression: string | undefined;
678
746
  }
679
747
  /**
748
+ * @public
680
749
  * <p>The options that determine the null value format configuration.</p>
681
750
  */
682
751
  export interface NullValueFormatConfiguration {
@@ -686,6 +755,7 @@ export interface NullValueFormatConfiguration {
686
755
  NullString: string | undefined;
687
756
  }
688
757
  /**
758
+ * @public
689
759
  * <p>The option that determines the decimal places configuration.</p>
690
760
  */
691
761
  export interface DecimalPlacesConfiguration {
@@ -694,11 +764,15 @@ export interface DecimalPlacesConfiguration {
694
764
  */
695
765
  DecimalPlaces: number | undefined;
696
766
  }
767
+ /**
768
+ * @public
769
+ */
697
770
  export declare enum NegativeValueDisplayMode {
698
771
  NEGATIVE = "NEGATIVE",
699
772
  POSITIVE = "POSITIVE"
700
773
  }
701
774
  /**
775
+ * @public
702
776
  * <p>The options that determine the negative value configuration.</p>
703
777
  */
704
778
  export interface NegativeValueConfiguration {
@@ -707,6 +781,9 @@ export interface NegativeValueConfiguration {
707
781
  */
708
782
  DisplayMode: NegativeValueDisplayMode | string | undefined;
709
783
  }
784
+ /**
785
+ * @public
786
+ */
710
787
  export declare enum NumberScale {
711
788
  AUTO = "AUTO",
712
789
  BILLIONS = "BILLIONS",
@@ -715,16 +792,23 @@ export declare enum NumberScale {
715
792
  THOUSANDS = "THOUSANDS",
716
793
  TRILLIONS = "TRILLIONS"
717
794
  }
795
+ /**
796
+ * @public
797
+ */
718
798
  export declare enum NumericSeparatorSymbol {
719
799
  COMMA = "COMMA",
720
800
  DOT = "DOT",
721
801
  SPACE = "SPACE"
722
802
  }
803
+ /**
804
+ * @public
805
+ */
723
806
  export declare enum Visibility {
724
807
  HIDDEN = "HIDDEN",
725
808
  VISIBLE = "VISIBLE"
726
809
  }
727
810
  /**
811
+ * @public
728
812
  * <p>The options that determine the thousands separator configuration.</p>
729
813
  */
730
814
  export interface ThousandSeparatorOptions {
@@ -738,6 +822,7 @@ export interface ThousandSeparatorOptions {
738
822
  Visibility?: Visibility | string;
739
823
  }
740
824
  /**
825
+ * @public
741
826
  * <p>The options that determine the numeric separator configuration.</p>
742
827
  */
743
828
  export interface NumericSeparatorConfiguration {
@@ -751,6 +836,7 @@ export interface NumericSeparatorConfiguration {
751
836
  ThousandsSeparator?: ThousandSeparatorOptions;
752
837
  }
753
838
  /**
839
+ * @public
754
840
  * <p>The options that determine the currency display format configuration.</p>
755
841
  */
756
842
  export interface CurrencyDisplayFormatConfiguration {
@@ -788,6 +874,7 @@ export interface CurrencyDisplayFormatConfiguration {
788
874
  NullValueFormatConfiguration?: NullValueFormatConfiguration;
789
875
  }
790
876
  /**
877
+ * @public
791
878
  * <p>The options that determine the number display format configuration.</p>
792
879
  */
793
880
  export interface NumberDisplayFormatConfiguration {
@@ -821,6 +908,7 @@ export interface NumberDisplayFormatConfiguration {
821
908
  NullValueFormatConfiguration?: NullValueFormatConfiguration;
822
909
  }
823
910
  /**
911
+ * @public
824
912
  * <p>The options that determine the percentage display format configuration.</p>
825
913
  */
826
914
  export interface PercentageDisplayFormatConfiguration {
@@ -850,6 +938,7 @@ export interface PercentageDisplayFormatConfiguration {
850
938
  NullValueFormatConfiguration?: NullValueFormatConfiguration;
851
939
  }
852
940
  /**
941
+ * @public
853
942
  * <p>The options that determine the numeric format configuration.</p>
854
943
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
855
944
  */
@@ -868,6 +957,7 @@ export interface NumericFormatConfiguration {
868
957
  PercentageDisplayFormatConfiguration?: PercentageDisplayFormatConfiguration;
869
958
  }
870
959
  /**
960
+ * @public
871
961
  * <p>Formatting configuration for <code>DateTime</code> fields.</p>
872
962
  */
873
963
  export interface DateTimeFormatConfiguration {
@@ -885,6 +975,7 @@ export interface DateTimeFormatConfiguration {
885
975
  NumericFormatConfiguration?: NumericFormatConfiguration;
886
976
  }
887
977
  /**
978
+ * @public
888
979
  * <p>Formatting configuration for number fields.</p>
889
980
  */
890
981
  export interface NumberFormatConfiguration {
@@ -894,6 +985,7 @@ export interface NumberFormatConfiguration {
894
985
  FormatConfiguration?: NumericFormatConfiguration;
895
986
  }
896
987
  /**
988
+ * @public
897
989
  * <p>Formatting configuration for string fields.</p>
898
990
  */
899
991
  export interface StringFormatConfiguration {
@@ -907,6 +999,7 @@ export interface StringFormatConfiguration {
907
999
  NumericFormatConfiguration?: NumericFormatConfiguration;
908
1000
  }
909
1001
  /**
1002
+ * @public
910
1003
  * <p>The formatting configuration for all types of field.</p>
911
1004
  */
912
1005
  export interface FormatConfiguration {
@@ -923,11 +1016,15 @@ export interface FormatConfiguration {
923
1016
  */
924
1017
  DateTimeFormatConfiguration?: DateTimeFormatConfiguration;
925
1018
  }
1019
+ /**
1020
+ * @public
1021
+ */
926
1022
  export declare enum ColumnRole {
927
1023
  DIMENSION = "DIMENSION",
928
1024
  MEASURE = "MEASURE"
929
1025
  }
930
1026
  /**
1027
+ * @public
931
1028
  * <p>The general configuration of a column.</p>
932
1029
  */
933
1030
  export interface ColumnConfiguration {
@@ -945,6 +1042,7 @@ export interface ColumnConfiguration {
945
1042
  Role?: ColumnRole | string;
946
1043
  }
947
1044
  /**
1045
+ * @public
948
1046
  * <p>A data set.</p>
949
1047
  */
950
1048
  export interface DataSetIdentifierDeclaration {
@@ -957,10 +1055,16 @@ export interface DataSetIdentifierDeclaration {
957
1055
  */
958
1056
  DataSetArn: string | undefined;
959
1057
  }
1058
+ /**
1059
+ * @public
1060
+ */
960
1061
  export declare enum CrossDatasetTypes {
961
1062
  ALL_DATASETS = "ALL_DATASETS",
962
1063
  SINGLE_DATASET = "SINGLE_DATASET"
963
1064
  }
1065
+ /**
1066
+ * @public
1067
+ */
964
1068
  export declare enum CategoryFilterMatchOperator {
965
1069
  CONTAINS = "CONTAINS",
966
1070
  DOES_NOT_CONTAIN = "DOES_NOT_CONTAIN",
@@ -969,15 +1073,22 @@ export declare enum CategoryFilterMatchOperator {
969
1073
  EQUALS = "EQUALS",
970
1074
  STARTS_WITH = "STARTS_WITH"
971
1075
  }
1076
+ /**
1077
+ * @public
1078
+ */
972
1079
  export declare enum FilterNullOption {
973
1080
  ALL_VALUES = "ALL_VALUES",
974
1081
  NON_NULLS_ONLY = "NON_NULLS_ONLY",
975
1082
  NULLS_ONLY = "NULLS_ONLY"
976
1083
  }
1084
+ /**
1085
+ * @public
1086
+ */
977
1087
  export declare enum CategoryFilterSelectAllOptions {
978
1088
  FILTER_ALL_VALUES = "FILTER_ALL_VALUES"
979
1089
  }
980
1090
  /**
1091
+ * @public
981
1092
  * <p>A custom filter that filters based on a single value. This filter can be partially matched.</p>
982
1093
  */
983
1094
  export interface CustomFilterConfiguration {
@@ -1026,6 +1137,7 @@ export interface CustomFilterConfiguration {
1026
1137
  NullOption: FilterNullOption | string | undefined;
1027
1138
  }
1028
1139
  /**
1140
+ * @public
1029
1141
  * <p>A list of custom filter values.</p>
1030
1142
  */
1031
1143
  export interface CustomFilterListConfiguration {
@@ -1068,6 +1180,7 @@ export interface CustomFilterListConfiguration {
1068
1180
  NullOption: FilterNullOption | string | undefined;
1069
1181
  }
1070
1182
  /**
1183
+ * @public
1071
1184
  * <p>A list of filter configurations.</p>
1072
1185
  */
1073
1186
  export interface FilterListConfiguration {
@@ -1092,6 +1205,7 @@ export interface FilterListConfiguration {
1092
1205
  SelectAllOptions?: CategoryFilterSelectAllOptions | string;
1093
1206
  }
1094
1207
  /**
1208
+ * @public
1095
1209
  * <p>The configuration for a <code>CategoryFilter</code>.</p>
1096
1210
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
1097
1211
  */
@@ -1110,6 +1224,7 @@ export interface CategoryFilterConfiguration {
1110
1224
  CustomFilterConfiguration?: CustomFilterConfiguration;
1111
1225
  }
1112
1226
  /**
1227
+ * @public
1113
1228
  * <p>A <code>CategoryFilter</code> filters text values.</p>
1114
1229
  * <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html">Adding text filters</a> in the <i>Amazon QuickSight User Guide</i>.</p>
1115
1230
  */
@@ -1127,14 +1242,21 @@ export interface CategoryFilter {
1127
1242
  */
1128
1243
  Configuration: CategoryFilterConfiguration | undefined;
1129
1244
  }
1245
+ /**
1246
+ * @public
1247
+ */
1130
1248
  export declare enum NumericEqualityMatchOperator {
1131
1249
  DOES_NOT_EQUAL = "DOES_NOT_EQUAL",
1132
1250
  EQUALS = "EQUALS"
1133
1251
  }
1252
+ /**
1253
+ * @public
1254
+ */
1134
1255
  export declare enum NumericFilterSelectAllOptions {
1135
1256
  FILTER_ALL_VALUES = "FILTER_ALL_VALUES"
1136
1257
  }
1137
1258
  /**
1259
+ * @public
1138
1260
  * <p>A <code>NumericEqualityFilter</code> filters values that are equal to the specified value.</p>
1139
1261
  */
1140
1262
  export interface NumericEqualityFilter {
@@ -1193,6 +1315,7 @@ export interface NumericEqualityFilter {
1193
1315
  NullOption: FilterNullOption | string | undefined;
1194
1316
  }
1195
1317
  /**
1318
+ * @public
1196
1319
  * <p>The value input pf the numeric range filter.</p>
1197
1320
  */
1198
1321
  export interface NumericRangeFilterValue {
@@ -1206,6 +1329,7 @@ export interface NumericRangeFilterValue {
1206
1329
  Parameter?: string;
1207
1330
  }
1208
1331
  /**
1332
+ * @public
1209
1333
  * <p>A <code>NumericRangeFilter</code> filters values that are within the value range.</p>
1210
1334
  */
1211
1335
  export interface NumericRangeFilter {
@@ -1267,10 +1391,14 @@ export interface NumericRangeFilter {
1267
1391
  */
1268
1392
  NullOption: FilterNullOption | string | undefined;
1269
1393
  }
1394
+ /**
1395
+ * @public
1396
+ */
1270
1397
  export declare enum AnchorOption {
1271
1398
  NOW = "NOW"
1272
1399
  }
1273
1400
  /**
1401
+ * @public
1274
1402
  * <p>The date configuration of the filter.</p>
1275
1403
  */
1276
1404
  export interface AnchorDateConfiguration {
@@ -1290,6 +1418,9 @@ export interface AnchorDateConfiguration {
1290
1418
  */
1291
1419
  ParameterName?: string;
1292
1420
  }
1421
+ /**
1422
+ * @public
1423
+ */
1293
1424
  export declare enum TimeGranularity {
1294
1425
  DAY = "DAY",
1295
1426
  HOUR = "HOUR",
@@ -1301,11 +1432,15 @@ export declare enum TimeGranularity {
1301
1432
  WEEK = "WEEK",
1302
1433
  YEAR = "YEAR"
1303
1434
  }
1435
+ /**
1436
+ * @public
1437
+ */
1304
1438
  export declare enum WidgetStatus {
1305
1439
  DISABLED = "DISABLED",
1306
1440
  ENABLED = "ENABLED"
1307
1441
  }
1308
1442
  /**
1443
+ * @public
1309
1444
  * <p>The exclude period of <code>TimeRangeFilter</code> or <code>RelativeDatesFilter</code>.</p>
1310
1445
  */
1311
1446
  export interface ExcludePeriodConfiguration {
@@ -1334,6 +1469,9 @@ export interface ExcludePeriodConfiguration {
1334
1469
  */
1335
1470
  Status?: WidgetStatus | string;
1336
1471
  }
1472
+ /**
1473
+ * @public
1474
+ */
1337
1475
  export declare enum RelativeDateType {
1338
1476
  LAST = "LAST",
1339
1477
  NEXT = "NEXT",
@@ -1342,6 +1480,7 @@ export declare enum RelativeDateType {
1342
1480
  THIS = "THIS"
1343
1481
  }
1344
1482
  /**
1483
+ * @public
1345
1484
  * <p>A <code>RelativeDatesFilter</code> filters relative dates values.</p>
1346
1485
  */
1347
1486
  export interface RelativeDatesFilter {
@@ -1428,6 +1567,7 @@ export interface RelativeDatesFilter {
1428
1567
  ExcludePeriodConfiguration?: ExcludePeriodConfiguration;
1429
1568
  }
1430
1569
  /**
1570
+ * @public
1431
1571
  * <p>A <code>TimeEqualityFilter</code> filters values that are equal to a given value.</p>
1432
1572
  */
1433
1573
  export interface TimeEqualityFilter {
@@ -1455,6 +1595,7 @@ export interface TimeEqualityFilter {
1455
1595
  TimeGranularity?: TimeGranularity | string;
1456
1596
  }
1457
1597
  /**
1598
+ * @public
1458
1599
  * <p>The rolling date configuration of a date time filter.</p>
1459
1600
  */
1460
1601
  export interface RollingDateConfiguration {
@@ -1468,6 +1609,7 @@ export interface RollingDateConfiguration {
1468
1609
  Expression: string | undefined;
1469
1610
  }
1470
1611
  /**
1612
+ * @public
1471
1613
  * <p>The value of a time range filter.</p>
1472
1614
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
1473
1615
  */
@@ -1486,6 +1628,7 @@ export interface TimeRangeFilterValue {
1486
1628
  Parameter?: string;
1487
1629
  }
1488
1630
  /**
1631
+ * @public
1489
1632
  * <p>A <code>TimeRangeFilter</code> filters values that are between two specified values.</p>
1490
1633
  */
1491
1634
  export interface TimeRangeFilter {
@@ -1541,6 +1684,7 @@ export interface TimeRangeFilter {
1541
1684
  TimeGranularity?: TimeGranularity | string;
1542
1685
  }
1543
1686
  /**
1687
+ * @public
1544
1688
  * <p>A <code>TopBottomFilter</code> filters values that are at the top or the bottom.</p>
1545
1689
  */
1546
1690
  export interface TopBottomFilter {
@@ -1570,6 +1714,7 @@ export interface TopBottomFilter {
1570
1714
  ParameterName?: string;
1571
1715
  }
1572
1716
  /**
1717
+ * @public
1573
1718
  * <p>With a <code>Filter</code>, you can remove portions of data from a particular visual or view.</p>
1574
1719
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
1575
1720
  */
@@ -1605,11 +1750,15 @@ export interface Filter {
1605
1750
  */
1606
1751
  TopBottomFilter?: TopBottomFilter;
1607
1752
  }
1753
+ /**
1754
+ * @public
1755
+ */
1608
1756
  export declare enum FilterVisualScope {
1609
1757
  ALL_VISUALS = "ALL_VISUALS",
1610
1758
  SELECTED_VISUALS = "SELECTED_VISUALS"
1611
1759
  }
1612
1760
  /**
1761
+ * @public
1613
1762
  * <p>The filter that is applied to the options.</p>
1614
1763
  */
1615
1764
  export interface SheetVisualScopingConfiguration {
@@ -1639,6 +1788,7 @@ export interface SheetVisualScopingConfiguration {
1639
1788
  VisualIds?: string[];
1640
1789
  }
1641
1790
  /**
1791
+ * @public
1642
1792
  * <p>The configuration for applying a filter to specific sheets or visuals. You can apply this filter to multiple visuals that are on one sheet or to all visuals on a sheet.</p>
1643
1793
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
1644
1794
  */
@@ -1649,6 +1799,7 @@ export interface SelectedSheetsFilterScopeConfiguration {
1649
1799
  SheetVisualScopingConfigurations?: SheetVisualScopingConfiguration[];
1650
1800
  }
1651
1801
  /**
1802
+ * @public
1652
1803
  * <p>The scope configuration for a <code>FilterGroup</code>.</p>
1653
1804
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
1654
1805
  */
@@ -1659,6 +1810,7 @@ export interface FilterScopeConfiguration {
1659
1810
  SelectedSheets?: SelectedSheetsFilterScopeConfiguration;
1660
1811
  }
1661
1812
  /**
1813
+ * @public
1662
1814
  * <p>A grouping of individual filters. Filter groups are applied to the same group of visuals.</p>
1663
1815
  * <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/add-a-compound-filter.html">Adding filter conditions (group filters) with AND and OR operators</a> in the <i>Amazon QuickSight User Guide</i>.</p>
1664
1816
  */
@@ -1698,6 +1850,7 @@ export interface FilterGroup {
1698
1850
  CrossDataset: CrossDatasetTypes | string | undefined;
1699
1851
  }
1700
1852
  /**
1853
+ * @public
1701
1854
  * <p>Defines different defaults to the users or groups based on mapping.</p>
1702
1855
  */
1703
1856
  export interface DynamicDefaultValue {
@@ -1715,6 +1868,7 @@ export interface DynamicDefaultValue {
1715
1868
  DefaultValueColumn: ColumnIdentifier | undefined;
1716
1869
  }
1717
1870
  /**
1871
+ * @public
1718
1872
  * <p>The default values of the <code>DateTimeParameterDeclaration</code>.</p>
1719
1873
  */
1720
1874
  export interface DateTimeDefaultValues {
@@ -1731,11 +1885,15 @@ export interface DateTimeDefaultValues {
1731
1885
  */
1732
1886
  RollingDate?: RollingDateConfiguration;
1733
1887
  }
1888
+ /**
1889
+ * @public
1890
+ */
1734
1891
  export declare enum ValueWhenUnsetOption {
1735
1892
  NULL = "NULL",
1736
1893
  RECOMMENDED_VALUE = "RECOMMENDED_VALUE"
1737
1894
  }
1738
1895
  /**
1896
+ * @public
1739
1897
  * <p>The configuration that defines the default value of a <code>DateTime</code> parameter when a value has not been set.</p>
1740
1898
  */
1741
1899
  export interface DateTimeValueWhenUnsetConfiguration {
@@ -1759,6 +1917,7 @@ export interface DateTimeValueWhenUnsetConfiguration {
1759
1917
  CustomValue?: Date;
1760
1918
  }
1761
1919
  /**
1920
+ * @public
1762
1921
  * <p>A parameter declaration for the <code>DateTime</code> data type.</p>
1763
1922
  */
1764
1923
  export interface DateTimeParameterDeclaration {
@@ -1780,6 +1939,7 @@ export interface DateTimeParameterDeclaration {
1780
1939
  ValueWhenUnset?: DateTimeValueWhenUnsetConfiguration;
1781
1940
  }
1782
1941
  /**
1942
+ * @public
1783
1943
  * <p>The default values of the <code>DecimalParameterDeclaration</code>.</p>
1784
1944
  */
1785
1945
  export interface DecimalDefaultValues {
@@ -1792,11 +1952,15 @@ export interface DecimalDefaultValues {
1792
1952
  */
1793
1953
  StaticValues?: number[];
1794
1954
  }
1955
+ /**
1956
+ * @public
1957
+ */
1795
1958
  export declare enum ParameterValueType {
1796
1959
  MULTI_VALUED = "MULTI_VALUED",
1797
1960
  SINGLE_VALUED = "SINGLE_VALUED"
1798
1961
  }
1799
1962
  /**
1963
+ * @public
1800
1964
  * <p>The configuration that defines the default value of a <code>Decimal</code> parameter when a value has not been set.</p>
1801
1965
  */
1802
1966
  export interface DecimalValueWhenUnsetConfiguration {
@@ -1820,6 +1984,7 @@ export interface DecimalValueWhenUnsetConfiguration {
1820
1984
  CustomValue?: number;
1821
1985
  }
1822
1986
  /**
1987
+ * @public
1823
1988
  * <p>A parameter declaration for the <code>Decimal</code> data type.</p>
1824
1989
  */
1825
1990
  export interface DecimalParameterDeclaration {
@@ -1841,6 +2006,7 @@ export interface DecimalParameterDeclaration {
1841
2006
  ValueWhenUnset?: DecimalValueWhenUnsetConfiguration;
1842
2007
  }
1843
2008
  /**
2009
+ * @public
1844
2010
  * <p>The default values of the <code>IntegerParameterDeclaration</code>.</p>
1845
2011
  */
1846
2012
  export interface IntegerDefaultValues {
@@ -1854,6 +2020,7 @@ export interface IntegerDefaultValues {
1854
2020
  StaticValues?: number[];
1855
2021
  }
1856
2022
  /**
2023
+ * @public
1857
2024
  * <p>A parameter declaration for the <code>Integer</code> data type.</p>
1858
2025
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
1859
2026
  */
@@ -1878,6 +2045,7 @@ export interface IntegerValueWhenUnsetConfiguration {
1878
2045
  CustomValue?: number;
1879
2046
  }
1880
2047
  /**
2048
+ * @public
1881
2049
  * <p>A parameter declaration for the <code>Integer</code> data type.</p>
1882
2050
  */
1883
2051
  export interface IntegerParameterDeclaration {
@@ -1899,6 +2067,7 @@ export interface IntegerParameterDeclaration {
1899
2067
  ValueWhenUnset?: IntegerValueWhenUnsetConfiguration;
1900
2068
  }
1901
2069
  /**
2070
+ * @public
1902
2071
  * <p>The default values of the <code>StringParameterDeclaration</code>.</p>
1903
2072
  */
1904
2073
  export interface StringDefaultValues {
@@ -1912,6 +2081,7 @@ export interface StringDefaultValues {
1912
2081
  StaticValues?: string[];
1913
2082
  }
1914
2083
  /**
2084
+ * @public
1915
2085
  * <p>The configuration that defines the default value of a <code>String</code> parameter when a value has not been set.</p>
1916
2086
  */
1917
2087
  export interface StringValueWhenUnsetConfiguration {
@@ -1935,6 +2105,7 @@ export interface StringValueWhenUnsetConfiguration {
1935
2105
  CustomValue?: string;
1936
2106
  }
1937
2107
  /**
2108
+ * @public
1938
2109
  * <p>A parameter declaration for the <code>String</code> data type.</p>
1939
2110
  */
1940
2111
  export interface StringParameterDeclaration {
@@ -1956,6 +2127,7 @@ export interface StringParameterDeclaration {
1956
2127
  ValueWhenUnset?: StringValueWhenUnsetConfiguration;
1957
2128
  }
1958
2129
  /**
2130
+ * @public
1959
2131
  * <p>The declaration definition of a parameter.</p>
1960
2132
  * <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html">Parameters in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</p>
1961
2133
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
@@ -1978,10 +2150,16 @@ export interface ParameterDeclaration {
1978
2150
  */
1979
2151
  DateTimeParameterDeclaration?: DateTimeParameterDeclaration;
1980
2152
  }
2153
+ /**
2154
+ * @public
2155
+ */
1981
2156
  export declare enum FontDecoration {
1982
2157
  NONE = "NONE",
1983
2158
  UNDERLINE = "UNDERLINE"
1984
2159
  }
2160
+ /**
2161
+ * @public
2162
+ */
1985
2163
  export declare enum RelativeFontSize {
1986
2164
  EXTRA_LARGE = "EXTRA_LARGE",
1987
2165
  EXTRA_SMALL = "EXTRA_SMALL",
@@ -1990,6 +2168,7 @@ export declare enum RelativeFontSize {
1990
2168
  SMALL = "SMALL"
1991
2169
  }
1992
2170
  /**
2171
+ * @public
1993
2172
  * <p>The option that determines the text display size.</p>
1994
2173
  */
1995
2174
  export interface FontSize {
@@ -1998,15 +2177,22 @@ export interface FontSize {
1998
2177
  */
1999
2178
  Relative?: RelativeFontSize | string;
2000
2179
  }
2180
+ /**
2181
+ * @public
2182
+ */
2001
2183
  export declare enum FontStyle {
2002
2184
  ITALIC = "ITALIC",
2003
2185
  NORMAL = "NORMAL"
2004
2186
  }
2187
+ /**
2188
+ * @public
2189
+ */
2005
2190
  export declare enum FontWeightName {
2006
2191
  BOLD = "BOLD",
2007
2192
  NORMAL = "NORMAL"
2008
2193
  }
2009
2194
  /**
2195
+ * @public
2010
2196
  * <p>The option that determines the text display weight, or boldness.</p>
2011
2197
  */
2012
2198
  export interface FontWeight {
@@ -2016,6 +2202,7 @@ export interface FontWeight {
2016
2202
  Name?: FontWeightName | string;
2017
2203
  }
2018
2204
  /**
2205
+ * @public
2019
2206
  * <p>Configures the display properties of the given text.</p>
2020
2207
  */
2021
2208
  export interface FontConfiguration {
@@ -2041,6 +2228,7 @@ export interface FontConfiguration {
2041
2228
  FontStyle?: FontStyle | string;
2042
2229
  }
2043
2230
  /**
2231
+ * @public
2044
2232
  * <p>The share label options for the labels.</p>
2045
2233
  */
2046
2234
  export interface LabelOptions {
@@ -2058,6 +2246,7 @@ export interface LabelOptions {
2058
2246
  CustomLabel?: string;
2059
2247
  }
2060
2248
  /**
2249
+ * @public
2061
2250
  * <p>The display options of a control.</p>
2062
2251
  */
2063
2252
  export interface DateTimePickerControlDisplayOptions {
@@ -2070,11 +2259,15 @@ export interface DateTimePickerControlDisplayOptions {
2070
2259
  */
2071
2260
  DateTimeFormat?: string;
2072
2261
  }
2262
+ /**
2263
+ * @public
2264
+ */
2073
2265
  export declare enum SheetControlDateTimePickerType {
2074
2266
  DATE_RANGE = "DATE_RANGE",
2075
2267
  SINGLE_VALUED = "SINGLE_VALUED"
2076
2268
  }
2077
2269
  /**
2270
+ * @public
2078
2271
  * <p>A control from a date filter that is used to specify date and time.</p>
2079
2272
  */
2080
2273
  export interface FilterDateTimePickerControl {
@@ -2110,6 +2303,7 @@ export interface FilterDateTimePickerControl {
2110
2303
  Type?: SheetControlDateTimePickerType | string;
2111
2304
  }
2112
2305
  /**
2306
+ * @public
2113
2307
  * <p>The source controls that are used in a <code>CascadingControlConfiguration</code>.</p>
2114
2308
  */
2115
2309
  export interface CascadingControlSource {
@@ -2123,6 +2317,7 @@ export interface CascadingControlSource {
2123
2317
  ColumnToMatch?: ColumnIdentifier;
2124
2318
  }
2125
2319
  /**
2320
+ * @public
2126
2321
  * <p>The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.</p>
2127
2322
  */
2128
2323
  export interface CascadingControlConfiguration {
@@ -2132,6 +2327,7 @@ export interface CascadingControlConfiguration {
2132
2327
  SourceControls?: CascadingControlSource[];
2133
2328
  }
2134
2329
  /**
2330
+ * @public
2135
2331
  * <p>The configuration of the <code>Select all</code> options in a list control.</p>
2136
2332
  */
2137
2333
  export interface ListControlSelectAllOptions {
@@ -2141,6 +2337,7 @@ export interface ListControlSelectAllOptions {
2141
2337
  Visibility?: Visibility | string;
2142
2338
  }
2143
2339
  /**
2340
+ * @public
2144
2341
  * <p>The display options of a control.</p>
2145
2342
  */
2146
2343
  export interface DropDownControlDisplayOptions {
@@ -2155,6 +2352,7 @@ export interface DropDownControlDisplayOptions {
2155
2352
  TitleOptions?: LabelOptions;
2156
2353
  }
2157
2354
  /**
2355
+ * @public
2158
2356
  * <p>A list of selectable values that are used in a control.</p>
2159
2357
  */
2160
2358
  export interface FilterSelectableValues {
@@ -2163,11 +2361,15 @@ export interface FilterSelectableValues {
2163
2361
  */
2164
2362
  Values?: string[];
2165
2363
  }
2364
+ /**
2365
+ * @public
2366
+ */
2166
2367
  export declare enum SheetControlListType {
2167
2368
  MULTI_SELECT = "MULTI_SELECT",
2168
2369
  SINGLE_SELECT = "SINGLE_SELECT"
2169
2370
  }
2170
2371
  /**
2372
+ * @public
2171
2373
  * <p>A control to display a dropdown list with buttons that are used to select a single value.</p>
2172
2374
  */
2173
2375
  export interface FilterDropDownControl {
@@ -2211,6 +2413,7 @@ export interface FilterDropDownControl {
2211
2413
  CascadingControlConfiguration?: CascadingControlConfiguration;
2212
2414
  }
2213
2415
  /**
2416
+ * @public
2214
2417
  * <p>The configuration of the search options in a list control.</p>
2215
2418
  */
2216
2419
  export interface ListControlSearchOptions {
@@ -2220,6 +2423,7 @@ export interface ListControlSearchOptions {
2220
2423
  Visibility?: Visibility | string;
2221
2424
  }
2222
2425
  /**
2426
+ * @public
2223
2427
  * <p>The display options of a control.</p>
2224
2428
  */
2225
2429
  export interface ListControlDisplayOptions {
@@ -2237,6 +2441,7 @@ export interface ListControlDisplayOptions {
2237
2441
  TitleOptions?: LabelOptions;
2238
2442
  }
2239
2443
  /**
2444
+ * @public
2240
2445
  * <p>A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.</p>
2241
2446
  */
2242
2447
  export interface FilterListControl {
@@ -2280,6 +2485,7 @@ export interface FilterListControl {
2280
2485
  CascadingControlConfiguration?: CascadingControlConfiguration;
2281
2486
  }
2282
2487
  /**
2488
+ * @public
2283
2489
  * <p>The display options of a control.</p>
2284
2490
  */
2285
2491
  export interface RelativeDateTimeControlDisplayOptions {
@@ -2293,6 +2499,7 @@ export interface RelativeDateTimeControlDisplayOptions {
2293
2499
  DateTimeFormat?: string;
2294
2500
  }
2295
2501
  /**
2502
+ * @public
2296
2503
  * <p>A control from a date filter that is used to specify the relative date.</p>
2297
2504
  */
2298
2505
  export interface FilterRelativeDateTimeControl {
@@ -2314,6 +2521,7 @@ export interface FilterRelativeDateTimeControl {
2314
2521
  DisplayOptions?: RelativeDateTimeControlDisplayOptions;
2315
2522
  }
2316
2523
  /**
2524
+ * @public
2317
2525
  * <p>The display options of a control.</p>
2318
2526
  */
2319
2527
  export interface SliderControlDisplayOptions {
@@ -2322,11 +2530,15 @@ export interface SliderControlDisplayOptions {
2322
2530
  */
2323
2531
  TitleOptions?: LabelOptions;
2324
2532
  }
2533
+ /**
2534
+ * @public
2535
+ */
2325
2536
  export declare enum SheetControlSliderType {
2326
2537
  RANGE = "RANGE",
2327
2538
  SINGLE_POINT = "SINGLE_POINT"
2328
2539
  }
2329
2540
  /**
2541
+ * @public
2330
2542
  * <p>A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.</p>
2331
2543
  */
2332
2544
  export interface FilterSliderControl {
@@ -2374,6 +2586,7 @@ export interface FilterSliderControl {
2374
2586
  StepSize: number | undefined;
2375
2587
  }
2376
2588
  /**
2589
+ * @public
2377
2590
  * <p>The configuration of the placeholder options in a text control.</p>
2378
2591
  */
2379
2592
  export interface TextControlPlaceholderOptions {
@@ -2383,6 +2596,7 @@ export interface TextControlPlaceholderOptions {
2383
2596
  Visibility?: Visibility | string;
2384
2597
  }
2385
2598
  /**
2599
+ * @public
2386
2600
  * <p>The display options of a control.</p>
2387
2601
  */
2388
2602
  export interface TextAreaControlDisplayOptions {
@@ -2396,6 +2610,7 @@ export interface TextAreaControlDisplayOptions {
2396
2610
  PlaceholderOptions?: TextControlPlaceholderOptions;
2397
2611
  }
2398
2612
  /**
2613
+ * @public
2399
2614
  * <p>A control to display a text box that is used to enter multiple entries.</p>
2400
2615
  */
2401
2616
  export interface FilterTextAreaControl {
@@ -2421,6 +2636,7 @@ export interface FilterTextAreaControl {
2421
2636
  DisplayOptions?: TextAreaControlDisplayOptions;
2422
2637
  }
2423
2638
  /**
2639
+ * @public
2424
2640
  * <p>The display options of a control.</p>
2425
2641
  */
2426
2642
  export interface TextFieldControlDisplayOptions {
@@ -2434,6 +2650,7 @@ export interface TextFieldControlDisplayOptions {
2434
2650
  PlaceholderOptions?: TextControlPlaceholderOptions;
2435
2651
  }
2436
2652
  /**
2653
+ * @public
2437
2654
  * <p>A control to display a text box that is used to enter a single entry.</p>
2438
2655
  */
2439
2656
  export interface FilterTextFieldControl {
@@ -2455,6 +2672,7 @@ export interface FilterTextFieldControl {
2455
2672
  DisplayOptions?: TextFieldControlDisplayOptions;
2456
2673
  }
2457
2674
  /**
2675
+ * @public
2458
2676
  * <p>The control of a filter that is used to interact with a dashboard or an analysis.</p>
2459
2677
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
2460
2678
  */
@@ -2489,6 +2707,7 @@ export interface FilterControl {
2489
2707
  RelativeDateTime?: FilterRelativeDateTimeControl;
2490
2708
  }
2491
2709
  /**
2710
+ * @public
2492
2711
  * <p>The background style configuration of a free-form layout element.</p>
2493
2712
  */
2494
2713
  export interface FreeFormLayoutElementBackgroundStyle {
@@ -2502,6 +2721,7 @@ export interface FreeFormLayoutElementBackgroundStyle {
2502
2721
  Color?: string;
2503
2722
  }
2504
2723
  /**
2724
+ * @public
2505
2725
  * <p>The background style configuration of a free-form layout element.</p>
2506
2726
  */
2507
2727
  export interface FreeFormLayoutElementBorderStyle {
@@ -2514,6 +2734,9 @@ export interface FreeFormLayoutElementBorderStyle {
2514
2734
  */
2515
2735
  Color?: string;
2516
2736
  }
2737
+ /**
2738
+ * @public
2739
+ */
2517
2740
  export declare enum LayoutElementType {
2518
2741
  FILTER_CONTROL = "FILTER_CONTROL",
2519
2742
  PARAMETER_CONTROL = "PARAMETER_CONTROL",
@@ -2521,6 +2744,7 @@ export declare enum LayoutElementType {
2521
2744
  VISUAL = "VISUAL"
2522
2745
  }
2523
2746
  /**
2747
+ * @public
2524
2748
  * <p>The configuration of loading animation in free-form layout. </p>
2525
2749
  */
2526
2750
  export interface LoadingAnimation {
@@ -2530,6 +2754,7 @@ export interface LoadingAnimation {
2530
2754
  Visibility?: Visibility | string;
2531
2755
  }
2532
2756
  /**
2757
+ * @public
2533
2758
  * <p>The override configuration of the rendering rules of a sheet.</p>
2534
2759
  */
2535
2760
  export interface SheetElementConfigurationOverrides {
@@ -2551,6 +2776,7 @@ export interface SheetElementConfigurationOverrides {
2551
2776
  Visibility?: Visibility | string;
2552
2777
  }
2553
2778
  /**
2779
+ * @public
2554
2780
  * <p>The rendering rules of a sheet that uses a free-form layout.</p>
2555
2781
  */
2556
2782
  export interface SheetElementRenderingRule {
@@ -2564,6 +2790,7 @@ export interface SheetElementRenderingRule {
2564
2790
  ConfigurationOverrides: SheetElementConfigurationOverrides | undefined;
2565
2791
  }
2566
2792
  /**
2793
+ * @public
2567
2794
  * <p>An element within a free-form layout.</p>
2568
2795
  */
2569
2796
  export interface FreeFormLayoutElement {
@@ -2617,6 +2844,7 @@ export interface FreeFormLayoutElement {
2617
2844
  LoadingAnimation?: LoadingAnimation;
2618
2845
  }
2619
2846
  /**
2847
+ * @public
2620
2848
  * <p>The configuration of a free-form layout.</p>
2621
2849
  */
2622
2850
  export interface FreeFormLayoutConfiguration {
@@ -2630,6 +2858,7 @@ export interface FreeFormLayoutConfiguration {
2630
2858
  CanvasSizeOptions?: FreeFormLayoutCanvasSizeOptions;
2631
2859
  }
2632
2860
  /**
2861
+ * @public
2633
2862
  * <p>An element within a grid layout.</p>
2634
2863
  */
2635
2864
  export interface GridLayoutElement {
@@ -2659,6 +2888,7 @@ export interface GridLayoutElement {
2659
2888
  RowSpan: number | undefined;
2660
2889
  }
2661
2890
  /**
2891
+ * @public
2662
2892
  * <p>The configuration for a grid layout. Also called a tiled layout.</p>
2663
2893
  * <p>Visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size.</p>
2664
2894
  */
@@ -2673,6 +2903,7 @@ export interface GridLayoutConfiguration {
2673
2903
  CanvasSizeOptions?: GridLayoutCanvasSizeOptions;
2674
2904
  }
2675
2905
  /**
2906
+ * @public
2676
2907
  * <p>The free-form layout configuration of a section.</p>
2677
2908
  */
2678
2909
  export interface FreeFormSectionLayoutConfiguration {
@@ -2682,6 +2913,7 @@ export interface FreeFormSectionLayoutConfiguration {
2682
2913
  Elements: FreeFormLayoutElement[] | undefined;
2683
2914
  }
2684
2915
  /**
2916
+ * @public
2685
2917
  * <p>The layout configuration of a section.</p>
2686
2918
  */
2687
2919
  export interface SectionLayoutConfiguration {
@@ -2691,6 +2923,7 @@ export interface SectionLayoutConfiguration {
2691
2923
  FreeFormLayout: FreeFormSectionLayoutConfiguration | undefined;
2692
2924
  }
2693
2925
  /**
2926
+ * @public
2694
2927
  * <p>The configuration of content in a body section.</p>
2695
2928
  */
2696
2929
  export interface BodySectionContent {
@@ -2699,11 +2932,15 @@ export interface BodySectionContent {
2699
2932
  */
2700
2933
  Layout?: SectionLayoutConfiguration;
2701
2934
  }
2935
+ /**
2936
+ * @public
2937
+ */
2702
2938
  export declare enum SectionPageBreakStatus {
2703
2939
  DISABLED = "DISABLED",
2704
2940
  ENABLED = "ENABLED"
2705
2941
  }
2706
2942
  /**
2943
+ * @public
2707
2944
  * <p>The configuration of a page break after a section.</p>
2708
2945
  */
2709
2946
  export interface SectionAfterPageBreak {
@@ -2713,6 +2950,7 @@ export interface SectionAfterPageBreak {
2713
2950
  Status?: SectionPageBreakStatus | string;
2714
2951
  }
2715
2952
  /**
2953
+ * @public
2716
2954
  * <p>The configuration of a page break for a section.</p>
2717
2955
  */
2718
2956
  export interface SectionPageBreakConfiguration {
@@ -2722,6 +2960,7 @@ export interface SectionPageBreakConfiguration {
2722
2960
  After?: SectionAfterPageBreak;
2723
2961
  }
2724
2962
  /**
2963
+ * @public
2725
2964
  * <p>The options that style a section.</p>
2726
2965
  */
2727
2966
  export interface SectionStyle {
@@ -2737,6 +2976,7 @@ export interface SectionStyle {
2737
2976
  Padding?: Spacing;
2738
2977
  }
2739
2978
  /**
2979
+ * @public
2740
2980
  * <p>The configuration of a body section.</p>
2741
2981
  */
2742
2982
  export interface BodySectionConfiguration {
@@ -2758,6 +2998,7 @@ export interface BodySectionConfiguration {
2758
2998
  PageBreakConfiguration?: SectionPageBreakConfiguration;
2759
2999
  }
2760
3000
  /**
3001
+ * @public
2761
3002
  * <p>The configuration of a header or footer section.</p>
2762
3003
  */
2763
3004
  export interface HeaderFooterSectionConfiguration {
@@ -2775,6 +3016,7 @@ export interface HeaderFooterSectionConfiguration {
2775
3016
  Style?: SectionStyle;
2776
3017
  }
2777
3018
  /**
3019
+ * @public
2778
3020
  * <p>The configuration for a
2779
3021
  * section-based layout.</p>
2780
3022
  */
@@ -2797,6 +3039,7 @@ export interface SectionBasedLayoutConfiguration {
2797
3039
  CanvasSizeOptions: SectionBasedLayoutCanvasSizeOptions | undefined;
2798
3040
  }
2799
3041
  /**
3042
+ * @public
2800
3043
  * <p>The configuration that determines what the type of layout will be used on a sheet.</p>
2801
3044
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
2802
3045
  */
@@ -2815,6 +3058,7 @@ export interface LayoutConfiguration {
2815
3058
  SectionBasedLayout?: SectionBasedLayoutConfiguration;
2816
3059
  }
2817
3060
  /**
3061
+ * @public
2818
3062
  * <p>A <code>Layout</code> defines the placement of elements within a sheet.</p>
2819
3063
  * <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html">Types of layout</a> in the <i>Amazon QuickSight User Guide</i>.</p>
2820
3064
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
@@ -2826,6 +3070,7 @@ export interface Layout {
2826
3070
  Configuration: LayoutConfiguration | undefined;
2827
3071
  }
2828
3072
  /**
3073
+ * @public
2829
3074
  * <p>A control from a date parameter that specifies date and time.</p>
2830
3075
  */
2831
3076
  export interface ParameterDateTimePickerControl {
@@ -2847,6 +3092,7 @@ export interface ParameterDateTimePickerControl {
2847
3092
  DisplayOptions?: DateTimePickerControlDisplayOptions;
2848
3093
  }
2849
3094
  /**
3095
+ * @public
2850
3096
  * <p>A list of selectable values that are used in a control.</p>
2851
3097
  */
2852
3098
  export interface ParameterSelectableValues {
@@ -2860,6 +3106,7 @@ export interface ParameterSelectableValues {
2860
3106
  LinkToDataSetColumn?: ColumnIdentifier;
2861
3107
  }
2862
3108
  /**
3109
+ * @public
2863
3110
  * <p>A control to display a dropdown list with buttons that are used to select a single value.</p>
2864
3111
  */
2865
3112
  export interface ParameterDropDownControl {
@@ -2893,6 +3140,7 @@ export interface ParameterDropDownControl {
2893
3140
  CascadingControlConfiguration?: CascadingControlConfiguration;
2894
3141
  }
2895
3142
  /**
3143
+ * @public
2896
3144
  * <p>A control to display a list with buttons or boxes that are used to select either a single value or multiple values.</p>
2897
3145
  */
2898
3146
  export interface ParameterListControl {
@@ -2926,6 +3174,7 @@ export interface ParameterListControl {
2926
3174
  CascadingControlConfiguration?: CascadingControlConfiguration;
2927
3175
  }
2928
3176
  /**
3177
+ * @public
2929
3178
  * <p>A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.</p>
2930
3179
  */
2931
3180
  export interface ParameterSliderControl {
@@ -2959,6 +3208,7 @@ export interface ParameterSliderControl {
2959
3208
  StepSize: number | undefined;
2960
3209
  }
2961
3210
  /**
3211
+ * @public
2962
3212
  * <p>A control to display a text box that is used to enter multiple entries.</p>
2963
3213
  */
2964
3214
  export interface ParameterTextAreaControl {
@@ -2984,6 +3234,7 @@ export interface ParameterTextAreaControl {
2984
3234
  DisplayOptions?: TextAreaControlDisplayOptions;
2985
3235
  }
2986
3236
  /**
3237
+ * @public
2987
3238
  * <p>A control to display a text box that is used to enter a single entry.</p>
2988
3239
  */
2989
3240
  export interface ParameterTextFieldControl {
@@ -3005,6 +3256,7 @@ export interface ParameterTextFieldControl {
3005
3256
  DisplayOptions?: TextFieldControlDisplayOptions;
3006
3257
  }
3007
3258
  /**
3259
+ * @public
3008
3260
  * <p>The control of a parameter that users can interact with in a dashboard or an analysis.</p>
3009
3261
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
3010
3262
  */
@@ -3035,6 +3287,7 @@ export interface ParameterControl {
3035
3287
  Slider?: ParameterSliderControl;
3036
3288
  }
3037
3289
  /**
3290
+ * @public
3038
3291
  * <p>The configuration that determines the elements and canvas size options of sheet control.</p>
3039
3292
  */
3040
3293
  export interface SheetControlLayoutConfiguration {
@@ -3044,6 +3297,7 @@ export interface SheetControlLayoutConfiguration {
3044
3297
  GridLayout?: GridLayoutConfiguration;
3045
3298
  }
3046
3299
  /**
3300
+ * @public
3047
3301
  * <p>A grid layout to define the placement of sheet control.</p>
3048
3302
  */
3049
3303
  export interface SheetControlLayout {
@@ -3053,6 +3307,7 @@ export interface SheetControlLayout {
3053
3307
  Configuration: SheetControlLayoutConfiguration | undefined;
3054
3308
  }
3055
3309
  /**
3310
+ * @public
3056
3311
  * <p>A text box.</p>
3057
3312
  */
3058
3313
  export interface SheetTextBox {
@@ -3065,10 +3320,14 @@ export interface SheetTextBox {
3065
3320
  */
3066
3321
  Content?: string;
3067
3322
  }
3323
+ /**
3324
+ * @public
3325
+ */
3068
3326
  export declare enum SelectedFieldOptions {
3069
3327
  ALL_FIELDS = "ALL_FIELDS"
3070
3328
  }
3071
3329
  /**
3330
+ * @public
3072
3331
  * <p>The configuration of selected fields in the<code>CustomActionFilterOperation</code>.</p>
3073
3332
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
3074
3333
  */
@@ -3089,10 +3348,14 @@ export interface FilterOperationSelectedFieldsConfiguration {
3089
3348
  */
3090
3349
  SelectedFieldOptions?: SelectedFieldOptions | string;
3091
3350
  }
3351
+ /**
3352
+ * @public
3353
+ */
3092
3354
  export declare enum TargetVisualOptions {
3093
3355
  ALL_VISUALS = "ALL_VISUALS"
3094
3356
  }
3095
3357
  /**
3358
+ * @public
3096
3359
  * <p>The configuration of the same-sheet target visuals that you want to be filtered.</p>
3097
3360
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
3098
3361
  */
@@ -3114,6 +3377,7 @@ export interface SameSheetTargetVisualConfiguration {
3114
3377
  TargetVisualOptions?: TargetVisualOptions | string;
3115
3378
  }
3116
3379
  /**
3380
+ * @public
3117
3381
  * <p>The configuration of target visuals that you want to be filtered.</p>
3118
3382
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
3119
3383
  */
@@ -3124,6 +3388,7 @@ export interface FilterOperationTargetVisualsConfiguration {
3124
3388
  SameSheetTargetVisualConfiguration?: SameSheetTargetVisualConfiguration;
3125
3389
  }
3126
3390
  /**
3391
+ * @public
3127
3392
  * <p>The filter operation that filters data included in a visual or in an entire sheet.</p>
3128
3393
  */
3129
3394
  export interface CustomActionFilterOperation {
@@ -3137,6 +3402,7 @@ export interface CustomActionFilterOperation {
3137
3402
  TargetVisualsConfiguration: FilterOperationTargetVisualsConfiguration | undefined;
3138
3403
  }
3139
3404
  /**
3405
+ * @public
3140
3406
  * <p>The navigation configuration for <code>CustomActionNavigationOperation</code>.</p>
3141
3407
  */
3142
3408
  export interface LocalNavigationConfiguration {
@@ -3146,6 +3412,7 @@ export interface LocalNavigationConfiguration {
3146
3412
  TargetSheetId: string | undefined;
3147
3413
  }
3148
3414
  /**
3415
+ * @public
3149
3416
  * <p>The navigation operation that navigates between different sheets in the same analysis.</p>
3150
3417
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
3151
3418
  */
@@ -3156,6 +3423,7 @@ export interface CustomActionNavigationOperation {
3156
3423
  LocalNavigationConfiguration?: LocalNavigationConfiguration;
3157
3424
  }
3158
3425
  /**
3426
+ * @public
3159
3427
  * <p>The customized parameter values.</p>
3160
3428
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
3161
3429
  */
@@ -3178,6 +3446,7 @@ export interface CustomParameterValues {
3178
3446
  DateTimeValues?: Date[];
3179
3447
  }
3180
3448
  /**
3449
+ * @public
3181
3450
  * <p>The configuration of custom values for the destination parameter in <code>DestinationParameterValueConfiguration</code>.</p>
3182
3451
  */
3183
3452
  export interface CustomValuesConfiguration {
@@ -3191,10 +3460,14 @@ export interface CustomValuesConfiguration {
3191
3460
  */
3192
3461
  CustomValues: CustomParameterValues | undefined;
3193
3462
  }
3463
+ /**
3464
+ * @public
3465
+ */
3194
3466
  export declare enum SelectAllValueOptions {
3195
3467
  ALL_VALUES = "ALL_VALUES"
3196
3468
  }
3197
3469
  /**
3470
+ * @public
3198
3471
  * <p>The configuration of destination parameter values.</p>
3199
3472
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
3200
3473
  */
@@ -3217,6 +3490,7 @@ export interface DestinationParameterValueConfiguration {
3217
3490
  SourceField?: string;
3218
3491
  }
3219
3492
  /**
3493
+ * @public
3220
3494
  * <p>The configuration of adding parameters in action.</p>
3221
3495
  */
3222
3496
  export interface SetParameterValueConfiguration {
@@ -3231,6 +3505,7 @@ export interface SetParameterValueConfiguration {
3231
3505
  Value: DestinationParameterValueConfiguration | undefined;
3232
3506
  }
3233
3507
  /**
3508
+ * @public
3234
3509
  * <p>The set parameter operation that sets parameters in custom action.</p>
3235
3510
  */
3236
3511
  export interface CustomActionSetParametersOperation {
@@ -3239,12 +3514,16 @@ export interface CustomActionSetParametersOperation {
3239
3514
  */
3240
3515
  ParameterValueConfigurations: SetParameterValueConfiguration[] | undefined;
3241
3516
  }
3517
+ /**
3518
+ * @public
3519
+ */
3242
3520
  export declare enum URLTargetConfiguration {
3243
3521
  NEW_TAB = "NEW_TAB",
3244
3522
  NEW_WINDOW = "NEW_WINDOW",
3245
3523
  SAME_TAB = "SAME_TAB"
3246
3524
  }
3247
3525
  /**
3526
+ * @public
3248
3527
  * <p>The URL operation that opens a link to another webpage.</p>
3249
3528
  */
3250
3529
  export interface CustomActionURLOperation {
@@ -3273,6 +3552,7 @@ export interface CustomActionURLOperation {
3273
3552
  URLTarget: URLTargetConfiguration | string | undefined;
3274
3553
  }
3275
3554
  /**
3555
+ * @public
3276
3556
  * <p>The operation that is defined by the custom action.</p>
3277
3557
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
3278
3558
  */
@@ -3294,11 +3574,15 @@ export interface VisualCustomActionOperation {
3294
3574
  */
3295
3575
  SetParametersOperation?: CustomActionSetParametersOperation;
3296
3576
  }
3577
+ /**
3578
+ * @public
3579
+ */
3297
3580
  export declare enum VisualCustomActionTrigger {
3298
3581
  DATA_POINT_CLICK = "DATA_POINT_CLICK",
3299
3582
  DATA_POINT_MENU = "DATA_POINT_MENU"
3300
3583
  }
3301
3584
  /**
3585
+ * @public
3302
3586
  * <p>A custom action defined on a visual.</p>
3303
3587
  */
3304
3588
  export interface VisualCustomAction {
@@ -3335,12 +3619,16 @@ export interface VisualCustomAction {
3335
3619
  */
3336
3620
  ActionOperations: VisualCustomActionOperation[] | undefined;
3337
3621
  }
3622
+ /**
3623
+ * @public
3624
+ */
3338
3625
  export declare enum BarsArrangement {
3339
3626
  CLUSTERED = "CLUSTERED",
3340
3627
  STACKED = "STACKED",
3341
3628
  STACKED_PERCENT = "STACKED_PERCENT"
3342
3629
  }
3343
3630
  /**
3631
+ * @public
3344
3632
  * <p>The options that determine how a date axis is displayed.</p>
3345
3633
  */
3346
3634
  export interface DateAxisOptions {
@@ -3350,11 +3638,13 @@ export interface DateAxisOptions {
3350
3638
  MissingDateVisibility?: Visibility | string;
3351
3639
  }
3352
3640
  /**
3641
+ * @public
3353
3642
  * <p>The options that are saved for future extension.</p>
3354
3643
  */
3355
3644
  export interface AxisDisplayDataDrivenRange {
3356
3645
  }
3357
3646
  /**
3647
+ * @public
3358
3648
  * <p>The minimum and maximum setup for an axis display range.</p>
3359
3649
  */
3360
3650
  export interface AxisDisplayMinMaxRange {
@@ -3368,6 +3658,7 @@ export interface AxisDisplayMinMaxRange {
3368
3658
  Maximum?: number;
3369
3659
  }
3370
3660
  /**
3661
+ * @public
3371
3662
  * <p>The range setup of a numeric axis display range.</p>
3372
3663
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
3373
3664
  */
@@ -3382,6 +3673,7 @@ export interface AxisDisplayRange {
3382
3673
  DataDriven?: AxisDisplayDataDrivenRange;
3383
3674
  }
3384
3675
  /**
3676
+ * @public
3385
3677
  * <p>The liner axis scale setup.</p>
3386
3678
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
3387
3679
  */
@@ -3396,6 +3688,7 @@ export interface AxisLinearScale {
3396
3688
  StepSize?: number;
3397
3689
  }
3398
3690
  /**
3691
+ * @public
3399
3692
  * <p>The logarithmic axis scale setup.</p>
3400
3693
  */
3401
3694
  export interface AxisLogarithmicScale {
@@ -3405,6 +3698,7 @@ export interface AxisLogarithmicScale {
3405
3698
  Base?: number;
3406
3699
  }
3407
3700
  /**
3701
+ * @public
3408
3702
  * <p>The scale setup
3409
3703
  * options for a numeric axis display.</p>
3410
3704
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
@@ -3420,6 +3714,7 @@ export interface AxisScale {
3420
3714
  Logarithmic?: AxisLogarithmicScale;
3421
3715
  }
3422
3716
  /**
3717
+ * @public
3423
3718
  * <p>The options for an axis with a numeric field.</p>
3424
3719
  */
3425
3720
  export interface NumericAxisOptions {
@@ -3433,6 +3728,7 @@ export interface NumericAxisOptions {
3433
3728
  Range?: AxisDisplayRange;
3434
3729
  }
3435
3730
  /**
3731
+ * @public
3436
3732
  * <p>The data options for an axis.</p>
3437
3733
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
3438
3734
  */
@@ -3447,6 +3743,7 @@ export interface AxisDataOptions {
3447
3743
  DateAxisOptions?: DateAxisOptions;
3448
3744
  }
3449
3745
  /**
3746
+ * @public
3450
3747
  * <p>The percent range in the visible range.</p>
3451
3748
  */
3452
3749
  export interface PercentVisibleRange {
@@ -3460,6 +3757,7 @@ export interface PercentVisibleRange {
3460
3757
  To?: number;
3461
3758
  }
3462
3759
  /**
3760
+ * @public
3463
3761
  * <p>The range options for the data zoom scroll bar.</p>
3464
3762
  */
3465
3763
  export interface VisibleRangeOptions {
@@ -3469,6 +3767,7 @@ export interface VisibleRangeOptions {
3469
3767
  PercentRange?: PercentVisibleRange;
3470
3768
  }
3471
3769
  /**
3770
+ * @public
3472
3771
  * <p>The visual display options for a data zoom scroll bar.</p>
3473
3772
  */
3474
3773
  export interface ScrollBarOptions {
@@ -3482,6 +3781,7 @@ export interface ScrollBarOptions {
3482
3781
  VisibleRange?: VisibleRangeOptions;
3483
3782
  }
3484
3783
  /**
3784
+ * @public
3485
3785
  * <p>The tick label options of an axis.</p>
3486
3786
  */
3487
3787
  export interface AxisTickLabelOptions {
@@ -3495,6 +3795,7 @@ export interface AxisTickLabelOptions {
3495
3795
  RotationAngle?: number;
3496
3796
  }
3497
3797
  /**
3798
+ * @public
3498
3799
  * <p>The display options for the axis label.</p>
3499
3800
  */
3500
3801
  export interface AxisDisplayOptions {
@@ -3524,6 +3825,7 @@ export interface AxisDisplayOptions {
3524
3825
  AxisOffset?: string;
3525
3826
  }
3526
3827
  /**
3828
+ * @public
3527
3829
  * <p>The reference that specifies where the axis label is applied to.</p>
3528
3830
  */
3529
3831
  export interface AxisLabelReferenceOptions {
@@ -3537,6 +3839,7 @@ export interface AxisLabelReferenceOptions {
3537
3839
  Column: ColumnIdentifier | undefined;
3538
3840
  }
3539
3841
  /**
3842
+ * @public
3540
3843
  * <p>The label options for a chart axis. You must specify the field that the label is targeted to.</p>
3541
3844
  */
3542
3845
  export interface AxisLabelOptions {
@@ -3554,6 +3857,7 @@ export interface AxisLabelOptions {
3554
3857
  ApplyTo?: AxisLabelReferenceOptions;
3555
3858
  }
3556
3859
  /**
3860
+ * @public
3557
3861
  * <p>The label options for an axis on a chart.</p>
3558
3862
  */
3559
3863
  export interface ChartAxisLabelOptions {
@@ -3581,6 +3885,7 @@ export interface ChartAxisLabelOptions {
3581
3885
  AxisLabelOptions?: AxisLabelOptions[];
3582
3886
  }
3583
3887
  /**
3888
+ * @public
3584
3889
  * <p>The contribution analysis visual display for a line, pie, or bar chart.</p>
3585
3890
  */
3586
3891
  export interface ContributionAnalysisDefault {
@@ -3595,6 +3900,7 @@ export interface ContributionAnalysisDefault {
3595
3900
  ContributorDimensions: ColumnIdentifier[] | undefined;
3596
3901
  }
3597
3902
  /**
3903
+ * @public
3598
3904
  * <p>The option that specifies individual data values for labels.</p>
3599
3905
  */
3600
3906
  export interface DataPathLabelType {
@@ -3612,6 +3918,7 @@ export interface DataPathLabelType {
3612
3918
  Visibility?: Visibility | string;
3613
3919
  }
3614
3920
  /**
3921
+ * @public
3615
3922
  * <p>The field label type.</p>
3616
3923
  */
3617
3924
  export interface FieldLabelType {
@@ -3626,6 +3933,7 @@ export interface FieldLabelType {
3626
3933
  Visibility?: Visibility | string;
3627
3934
  }
3628
3935
  /**
3936
+ * @public
3629
3937
  * <p>The maximum label of a data path label.</p>
3630
3938
  */
3631
3939
  export interface MaximumLabelType {
@@ -3635,6 +3943,7 @@ export interface MaximumLabelType {
3635
3943
  Visibility?: Visibility | string;
3636
3944
  }
3637
3945
  /**
3946
+ * @public
3638
3947
  * <p>The minimum label of a data path label.</p>
3639
3948
  */
3640
3949
  export interface MinimumLabelType {
@@ -3644,6 +3953,7 @@ export interface MinimumLabelType {
3644
3953
  Visibility?: Visibility | string;
3645
3954
  }
3646
3955
  /**
3956
+ * @public
3647
3957
  * <p>The range ends label type of a data path label.</p>
3648
3958
  */
3649
3959
  export interface RangeEndsLabelType {
@@ -3653,6 +3963,7 @@ export interface RangeEndsLabelType {
3653
3963
  Visibility?: Visibility | string;
3654
3964
  }
3655
3965
  /**
3966
+ * @public
3656
3967
  * <p>The option that determines the data label type.</p>
3657
3968
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
3658
3969
  */
@@ -3678,15 +3989,24 @@ export interface DataLabelType {
3678
3989
  */
3679
3990
  MaximumLabelType?: MaximumLabelType;
3680
3991
  }
3992
+ /**
3993
+ * @public
3994
+ */
3681
3995
  export declare enum DataLabelContent {
3682
3996
  PERCENT = "PERCENT",
3683
3997
  VALUE = "VALUE",
3684
3998
  VALUE_AND_PERCENT = "VALUE_AND_PERCENT"
3685
3999
  }
4000
+ /**
4001
+ * @public
4002
+ */
3686
4003
  export declare enum DataLabelOverlap {
3687
4004
  DISABLE_OVERLAP = "DISABLE_OVERLAP",
3688
4005
  ENABLE_OVERLAP = "ENABLE_OVERLAP"
3689
4006
  }
4007
+ /**
4008
+ * @public
4009
+ */
3690
4010
  export declare enum DataLabelPosition {
3691
4011
  BOTTOM = "BOTTOM",
3692
4012
  INSIDE = "INSIDE",
@@ -3696,6 +4016,7 @@ export declare enum DataLabelPosition {
3696
4016
  TOP = "TOP"
3697
4017
  }
3698
4018
  /**
4019
+ * @public
3699
4020
  * <p>The options that determine the presentation of the data labels.</p>
3700
4021
  */
3701
4022
  export interface DataLabelOptions {
@@ -3737,6 +4058,7 @@ export interface DataLabelOptions {
3737
4058
  Overlap?: DataLabelOverlap | string;
3738
4059
  }
3739
4060
  /**
4061
+ * @public
3740
4062
  * <p>The dimension type field with categorical type columns..</p>
3741
4063
  */
3742
4064
  export interface CategoricalDimensionField {
@@ -3758,6 +4080,7 @@ export interface CategoricalDimensionField {
3758
4080
  FormatConfiguration?: StringFormatConfiguration;
3759
4081
  }
3760
4082
  /**
4083
+ * @public
3761
4084
  * <p>The dimension type field with date type columns.</p>
3762
4085
  */
3763
4086
  export interface DateDimensionField {
@@ -3830,6 +4153,7 @@ export interface DateDimensionField {
3830
4153
  FormatConfiguration?: DateTimeFormatConfiguration;
3831
4154
  }
3832
4155
  /**
4156
+ * @public
3833
4157
  * <p>The dimension type field with numerical type columns.</p>
3834
4158
  */
3835
4159
  export interface NumericalDimensionField {
@@ -3851,6 +4175,7 @@ export interface NumericalDimensionField {
3851
4175
  FormatConfiguration?: NumberFormatConfiguration;
3852
4176
  }
3853
4177
  /**
4178
+ * @public
3854
4179
  * <p>The dimension type field.</p>
3855
4180
  */
3856
4181
  export interface DimensionField {
@@ -3868,6 +4193,7 @@ export interface DimensionField {
3868
4193
  DateDimensionField?: DateDimensionField;
3869
4194
  }
3870
4195
  /**
4196
+ * @public
3871
4197
  * <p>The table calculation measure field for pivot tables.</p>
3872
4198
  */
3873
4199
  export interface CalculatedMeasureField {
@@ -3881,6 +4207,7 @@ export interface CalculatedMeasureField {
3881
4207
  Expression: string | undefined;
3882
4208
  }
3883
4209
  /**
4210
+ * @public
3884
4211
  * <p>The measure type field with categorical type columns.</p>
3885
4212
  */
3886
4213
  export interface CategoricalMeasureField {
@@ -3902,6 +4229,7 @@ export interface CategoricalMeasureField {
3902
4229
  FormatConfiguration?: StringFormatConfiguration;
3903
4230
  }
3904
4231
  /**
4232
+ * @public
3905
4233
  * <p>The measure type field with date type columns.</p>
3906
4234
  */
3907
4235
  export interface DateMeasureField {
@@ -3923,6 +4251,7 @@ export interface DateMeasureField {
3923
4251
  FormatConfiguration?: DateTimeFormatConfiguration;
3924
4252
  }
3925
4253
  /**
4254
+ * @public
3926
4255
  * <p>The measure type field with numerical type columns.</p>
3927
4256
  */
3928
4257
  export interface NumericalMeasureField {
@@ -3944,6 +4273,7 @@ export interface NumericalMeasureField {
3944
4273
  FormatConfiguration?: NumberFormatConfiguration;
3945
4274
  }
3946
4275
  /**
4276
+ * @public
3947
4277
  * <p>The measure (metric) type field.</p>
3948
4278
  */
3949
4279
  export interface MeasureField {
@@ -3965,6 +4295,7 @@ export interface MeasureField {
3965
4295
  CalculatedMeasureField?: CalculatedMeasureField;
3966
4296
  }
3967
4297
  /**
4298
+ * @public
3968
4299
  * <p>The aggregated field wells of a bar chart.</p>
3969
4300
  */
3970
4301
  export interface BarChartAggregatedFieldWells {
@@ -3987,6 +4318,7 @@ export interface BarChartAggregatedFieldWells {
3987
4318
  SmallMultiples?: DimensionField[];
3988
4319
  }
3989
4320
  /**
4321
+ * @public
3990
4322
  * <p>The field wells of a <code>BarChartVisual</code>.</p>
3991
4323
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
3992
4324
  */
@@ -3996,6 +4328,9 @@ export interface BarChartFieldWells {
3996
4328
  */
3997
4329
  BarChartAggregatedFieldWells?: BarChartAggregatedFieldWells;
3998
4330
  }
4331
+ /**
4332
+ * @public
4333
+ */
3999
4334
  export declare enum LegendPosition {
4000
4335
  AUTO = "AUTO",
4001
4336
  BOTTOM = "BOTTOM",
@@ -4003,6 +4338,7 @@ export declare enum LegendPosition {
4003
4338
  TOP = "TOP"
4004
4339
  }
4005
4340
  /**
4341
+ * @public
4006
4342
  * <p>The options for the legend setup of a visual.</p>
4007
4343
  */
4008
4344
  export interface LegendOptions {
@@ -4051,15 +4387,22 @@ export interface LegendOptions {
4051
4387
  */
4052
4388
  Height?: string;
4053
4389
  }
4390
+ /**
4391
+ * @public
4392
+ */
4054
4393
  export declare enum BarChartOrientation {
4055
4394
  HORIZONTAL = "HORIZONTAL",
4056
4395
  VERTICAL = "VERTICAL"
4057
4396
  }
4397
+ /**
4398
+ * @public
4399
+ */
4058
4400
  export declare enum AxisBinding {
4059
4401
  PRIMARY_YAXIS = "PRIMARY_YAXIS",
4060
4402
  SECONDARY_YAXIS = "SECONDARY_YAXIS"
4061
4403
  }
4062
4404
  /**
4405
+ * @public
4063
4406
  * <p>The dynamic configuration of the reference line data configuration.</p>
4064
4407
  */
4065
4408
  export interface ReferenceLineDynamicDataConfiguration {
@@ -4077,6 +4420,7 @@ export interface ReferenceLineDynamicDataConfiguration {
4077
4420
  Calculation: NumericalAggregationFunction | undefined;
4078
4421
  }
4079
4422
  /**
4423
+ * @public
4080
4424
  * <p>The static data configuration of the reference line data configuration.</p>
4081
4425
  */
4082
4426
  export interface ReferenceLineStaticDataConfiguration {
@@ -4086,6 +4430,7 @@ export interface ReferenceLineStaticDataConfiguration {
4086
4430
  Value: number | undefined;
4087
4431
  }
4088
4432
  /**
4433
+ * @public
4089
4434
  * <p>The data configuration of the reference line.</p>
4090
4435
  */
4091
4436
  export interface ReferenceLineDataConfiguration {
@@ -4112,6 +4457,7 @@ export interface ReferenceLineDataConfiguration {
4112
4457
  AxisBinding?: AxisBinding | string;
4113
4458
  }
4114
4459
  /**
4460
+ * @public
4115
4461
  * <p>The configuration for a custom label on a <code>ReferenceLine</code>.</p>
4116
4462
  */
4117
4463
  export interface ReferenceLineCustomLabelConfiguration {
@@ -4120,16 +4466,23 @@ export interface ReferenceLineCustomLabelConfiguration {
4120
4466
  */
4121
4467
  CustomLabel: string | undefined;
4122
4468
  }
4469
+ /**
4470
+ * @public
4471
+ */
4123
4472
  export declare enum ReferenceLineLabelHorizontalPosition {
4124
4473
  CENTER = "CENTER",
4125
4474
  LEFT = "LEFT",
4126
4475
  RIGHT = "RIGHT"
4127
4476
  }
4477
+ /**
4478
+ * @public
4479
+ */
4128
4480
  export declare enum ReferenceLineValueLabelRelativePosition {
4129
4481
  AFTER_CUSTOM_LABEL = "AFTER_CUSTOM_LABEL",
4130
4482
  BEFORE_CUSTOM_LABEL = "BEFORE_CUSTOM_LABEL"
4131
4483
  }
4132
4484
  /**
4485
+ * @public
4133
4486
  * <p>The value label configuration of the label in a reference line.</p>
4134
4487
  */
4135
4488
  export interface ReferenceLineValueLabelConfiguration {
@@ -4154,11 +4507,15 @@ export interface ReferenceLineValueLabelConfiguration {
4154
4507
  */
4155
4508
  FormatConfiguration?: NumericFormatConfiguration;
4156
4509
  }
4510
+ /**
4511
+ * @public
4512
+ */
4157
4513
  export declare enum ReferenceLineLabelVerticalPosition {
4158
4514
  ABOVE = "ABOVE",
4159
4515
  BELOW = "BELOW"
4160
4516
  }
4161
4517
  /**
4518
+ * @public
4162
4519
  * <p>The label configuration of a reference line.</p>
4163
4520
  */
4164
4521
  export interface ReferenceLineLabelConfiguration {
@@ -4217,12 +4574,16 @@ export interface ReferenceLineLabelConfiguration {
4217
4574
  */
4218
4575
  VerticalPosition?: ReferenceLineLabelVerticalPosition | string;
4219
4576
  }
4577
+ /**
4578
+ * @public
4579
+ */
4220
4580
  export declare enum ReferenceLinePatternType {
4221
4581
  DASHED = "DASHED",
4222
4582
  DOTTED = "DOTTED",
4223
4583
  SOLID = "SOLID"
4224
4584
  }
4225
4585
  /**
4586
+ * @public
4226
4587
  * <p>The style configuration of the reference
4227
4588
  * line.</p>
4228
4589
  */
@@ -4254,6 +4615,7 @@ export interface ReferenceLineStyleConfiguration {
4254
4615
  Color?: string;
4255
4616
  }
4256
4617
  /**
4618
+ * @public
4257
4619
  * <p>The reference line visual display options.</p>
4258
4620
  */
4259
4621
  export interface ReferenceLine {
@@ -4286,11 +4648,17 @@ export interface ReferenceLine {
4286
4648
  */
4287
4649
  LabelConfiguration?: ReferenceLineLabelConfiguration;
4288
4650
  }
4651
+ /**
4652
+ * @public
4653
+ */
4289
4654
  export declare enum PanelBorderStyle {
4290
4655
  DASHED = "DASHED",
4291
4656
  DOTTED = "DOTTED",
4292
4657
  SOLID = "SOLID"
4293
4658
  }
4659
+ /**
4660
+ * @public
4661
+ */
4294
4662
  export declare enum HorizontalTextAlignment {
4295
4663
  AUTO = "AUTO",
4296
4664
  CENTER = "CENTER",
@@ -4298,6 +4666,7 @@ export declare enum HorizontalTextAlignment {
4298
4666
  RIGHT = "RIGHT"
4299
4667
  }
4300
4668
  /**
4669
+ * @public
4301
4670
  * <p>The options that determine the title styles for each small multiples
4302
4671
  * panel.</p>
4303
4672
  */
@@ -4316,6 +4685,7 @@ export interface PanelTitleOptions {
4316
4685
  HorizontalTextAlignment?: HorizontalTextAlignment | string;
4317
4686
  }
4318
4687
  /**
4688
+ * @public
4319
4689
  * <p>A collection of options that configure how each panel displays in a small multiples chart.</p>
4320
4690
  */
4321
4691
  export interface PanelConfiguration {
@@ -4357,6 +4727,7 @@ export interface PanelConfiguration {
4357
4727
  BackgroundColor?: string;
4358
4728
  }
4359
4729
  /**
4730
+ * @public
4360
4731
  * <p>Options that determine the layout and display options of a chart's small multiples.</p>
4361
4732
  */
4362
4733
  export interface SmallMultiplesOptions {
@@ -4377,11 +4748,15 @@ export interface SmallMultiplesOptions {
4377
4748
  */
4378
4749
  PanelConfiguration?: PanelConfiguration;
4379
4750
  }
4751
+ /**
4752
+ * @public
4753
+ */
4380
4754
  export declare enum OtherCategories {
4381
4755
  EXCLUDE = "EXCLUDE",
4382
4756
  INCLUDE = "INCLUDE"
4383
4757
  }
4384
4758
  /**
4759
+ * @public
4385
4760
  * <p>The limit configuration of the visual display for an axis.</p>
4386
4761
  */
4387
4762
  export interface ItemsLimitConfiguration {
@@ -4409,6 +4784,7 @@ export interface ItemsLimitConfiguration {
4409
4784
  OtherCategories?: OtherCategories | string;
4410
4785
  }
4411
4786
  /**
4787
+ * @public
4412
4788
  * <p>The sort configuration for a column that is not used in a field well.</p>
4413
4789
  */
4414
4790
  export interface ColumnSort {
@@ -4426,6 +4802,7 @@ export interface ColumnSort {
4426
4802
  AggregationFunction?: AggregationFunction;
4427
4803
  }
4428
4804
  /**
4805
+ * @public
4429
4806
  * <p>The sort configuration for a field in a
4430
4807
  * field well.</p>
4431
4808
  */
@@ -4451,6 +4828,7 @@ export interface FieldSort {
4451
4828
  Direction: SortDirection | string | undefined;
4452
4829
  }
4453
4830
  /**
4831
+ * @public
4454
4832
  * <p>The field sort options in a chart configuration.</p>
4455
4833
  */
4456
4834
  export interface FieldSortOptions {
@@ -4464,6 +4842,7 @@ export interface FieldSortOptions {
4464
4842
  ColumnSort?: ColumnSort;
4465
4843
  }
4466
4844
  /**
4845
+ * @public
4467
4846
  * <p>sort-configuration-description</p>
4468
4847
  */
4469
4848
  export interface BarChartSortConfiguration {
@@ -4493,6 +4872,7 @@ export interface BarChartSortConfiguration {
4493
4872
  SmallMultiplesLimitConfiguration?: ItemsLimitConfiguration;
4494
4873
  }
4495
4874
  /**
4875
+ * @public
4496
4876
  * <p>The tooltip item for the columns that are not part of a field well.</p>
4497
4877
  */
4498
4878
  export interface ColumnTooltipItem {
@@ -4514,6 +4894,7 @@ export interface ColumnTooltipItem {
4514
4894
  Aggregation?: AggregationFunction;
4515
4895
  }
4516
4896
  /**
4897
+ * @public
4517
4898
  * <p>The tooltip item for the fields.</p>
4518
4899
  */
4519
4900
  export interface FieldTooltipItem {
@@ -4531,6 +4912,7 @@ export interface FieldTooltipItem {
4531
4912
  Visibility?: Visibility | string;
4532
4913
  }
4533
4914
  /**
4915
+ * @public
4534
4916
  * <p>The tooltip.</p>
4535
4917
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
4536
4918
  */
@@ -4544,11 +4926,15 @@ export interface TooltipItem {
4544
4926
  */
4545
4927
  ColumnTooltipItem?: ColumnTooltipItem;
4546
4928
  }
4929
+ /**
4930
+ * @public
4931
+ */
4547
4932
  export declare enum TooltipTitleType {
4548
4933
  NONE = "NONE",
4549
4934
  PRIMARY_VALUE = "PRIMARY_VALUE"
4550
4935
  }
4551
4936
  /**
4937
+ * @public
4552
4938
  * <p>The setup for the detailed tooltip.</p>
4553
4939
  */
4554
4940
  export interface FieldBasedTooltip {
@@ -4576,11 +4962,15 @@ export interface FieldBasedTooltip {
4576
4962
  */
4577
4963
  TooltipFields?: TooltipItem[];
4578
4964
  }
4965
+ /**
4966
+ * @public
4967
+ */
4579
4968
  export declare enum SelectedTooltipType {
4580
4969
  BASIC = "BASIC",
4581
4970
  DETAILED = "DETAILED"
4582
4971
  }
4583
4972
  /**
4973
+ * @public
4584
4974
  * <p>The display options for the visual tooltip.</p>
4585
4975
  */
4586
4976
  export interface TooltipOptions {
@@ -4608,6 +4998,7 @@ export interface TooltipOptions {
4608
4998
  FieldBasedTooltip?: FieldBasedTooltip;
4609
4999
  }
4610
5000
  /**
5001
+ * @public
4611
5002
  * <p>The data path that needs to be sorted.</p>
4612
5003
  */
4613
5004
  export interface DataPathValue {
@@ -4621,6 +5012,7 @@ export interface DataPathValue {
4621
5012
  FieldValue: string | undefined;
4622
5013
  }
4623
5014
  /**
5015
+ * @public
4624
5016
  * <p>The color map that determines the color options for a particular element.</p>
4625
5017
  */
4626
5018
  export interface DataPathColor {
@@ -4638,6 +5030,7 @@ export interface DataPathColor {
4638
5030
  TimeGranularity?: TimeGranularity | string;
4639
5031
  }
4640
5032
  /**
5033
+ * @public
4641
5034
  * <p>The visual display options for the visual palette.</p>
4642
5035
  */
4643
5036
  export interface VisualPalette {
@@ -4651,6 +5044,7 @@ export interface VisualPalette {
4651
5044
  ColorMap?: DataPathColor[];
4652
5045
  }
4653
5046
  /**
5047
+ * @public
4654
5048
  * <p>The configuration of a <code>BarChartVisual</code>.</p>
4655
5049
  */
4656
5050
  export interface BarChartConfiguration {
@@ -4730,6 +5124,7 @@ export interface BarChartConfiguration {
4730
5124
  ContributionAnalysisDefaults?: ContributionAnalysisDefault[];
4731
5125
  }
4732
5126
  /**
5127
+ * @public
4733
5128
  * <p>The numeric equality type drill down filter.</p>
4734
5129
  */
4735
5130
  export interface CategoryDrillDownFilter {
@@ -4743,6 +5138,7 @@ export interface CategoryDrillDownFilter {
4743
5138
  CategoryValues: string[] | undefined;
4744
5139
  }
4745
5140
  /**
5141
+ * @public
4746
5142
  * <p>The category drill down filter.</p>
4747
5143
  */
4748
5144
  export interface NumericEqualityDrillDownFilter {
@@ -4756,6 +5152,7 @@ export interface NumericEqualityDrillDownFilter {
4756
5152
  Value: number | undefined;
4757
5153
  }
4758
5154
  /**
5155
+ * @public
4759
5156
  * <p>The time range drill down filter.</p>
4760
5157
  */
4761
5158
  export interface TimeRangeDrillDownFilter {
@@ -4777,6 +5174,7 @@ export interface TimeRangeDrillDownFilter {
4777
5174
  TimeGranularity: TimeGranularity | string | undefined;
4778
5175
  }
4779
5176
  /**
5177
+ * @public
4780
5178
  * <p>The drill down filter for the column hierarchies.</p>
4781
5179
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
4782
5180
  */
@@ -4795,6 +5193,7 @@ export interface DrillDownFilter {
4795
5193
  TimeRangeFilter?: TimeRangeDrillDownFilter;
4796
5194
  }
4797
5195
  /**
5196
+ * @public
4798
5197
  * <p>The option that determines the hierarchy of any <code>DateTime</code> fields.</p>
4799
5198
  */
4800
5199
  export interface DateTimeHierarchy {
@@ -4809,6 +5208,7 @@ export interface DateTimeHierarchy {
4809
5208
  DrillDownFilters?: DrillDownFilter[];
4810
5209
  }
4811
5210
  /**
5211
+ * @public
4812
5212
  * <p>The option that determines the hierarchy of the fields that are built within a visual's field wells. These fields can't be duplicated to other visuals.</p>
4813
5213
  */
4814
5214
  export interface ExplicitHierarchy {
@@ -4826,6 +5226,7 @@ export interface ExplicitHierarchy {
4826
5226
  DrillDownFilters?: DrillDownFilter[];
4827
5227
  }
4828
5228
  /**
5229
+ * @public
4829
5230
  * <p>The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.</p>
4830
5231
  */
4831
5232
  export interface PredefinedHierarchy {
@@ -4843,6 +5244,7 @@ export interface PredefinedHierarchy {
4843
5244
  DrillDownFilters?: DrillDownFilter[];
4844
5245
  }
4845
5246
  /**
5247
+ * @public
4846
5248
  * <p>The option that determines the hierarchy of the fields for a visual element.</p>
4847
5249
  */
4848
5250
  export interface ColumnHierarchy {
@@ -4860,6 +5262,7 @@ export interface ColumnHierarchy {
4860
5262
  PredefinedHierarchy?: PredefinedHierarchy;
4861
5263
  }
4862
5264
  /**
5265
+ * @public
4863
5266
  * <p>The text format for a subtitle.</p>
4864
5267
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
4865
5268
  */
@@ -4874,6 +5277,7 @@ export interface LongFormatText {
4874
5277
  RichText?: string;
4875
5278
  }
4876
5279
  /**
5280
+ * @public
4877
5281
  * <p>The subtitle label options for a visual.</p>
4878
5282
  */
4879
5283
  export interface VisualSubtitleLabelOptions {
@@ -4887,6 +5291,7 @@ export interface VisualSubtitleLabelOptions {
4887
5291
  FormatText?: LongFormatText;
4888
5292
  }
4889
5293
  /**
5294
+ * @public
4890
5295
  * <p>The text format for the title.</p>
4891
5296
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
4892
5297
  */
@@ -4901,6 +5306,7 @@ export interface ShortFormatText {
4901
5306
  RichText?: string;
4902
5307
  }
4903
5308
  /**
5309
+ * @public
4904
5310
  * <p>The title label options for a visual.</p>
4905
5311
  */
4906
5312
  export interface VisualTitleLabelOptions {
@@ -4914,6 +5320,7 @@ export interface VisualTitleLabelOptions {
4914
5320
  FormatText?: ShortFormatText;
4915
5321
  }
4916
5322
  /**
5323
+ * @public
4917
5324
  * <p>A bar chart.</p>
4918
5325
  * <p>The <code>BarChartVisual</code> structure describes a visual that is a member of the bar chart family. The following charts can be described using this structure:</p>
4919
5326
  * <ul>
@@ -4964,11 +5371,15 @@ export interface BarChartVisual {
4964
5371
  */
4965
5372
  ColumnHierarchies?: ColumnHierarchy[];
4966
5373
  }
5374
+ /**
5375
+ * @public
5376
+ */
4967
5377
  export declare enum BoxPlotFillStyle {
4968
5378
  SOLID = "SOLID",
4969
5379
  TRANSPARENT = "TRANSPARENT"
4970
5380
  }
4971
5381
  /**
5382
+ * @public
4972
5383
  * <p>The style options of the box plot.</p>
4973
5384
  */
4974
5385
  export interface BoxPlotStyleOptions {
@@ -4978,6 +5389,7 @@ export interface BoxPlotStyleOptions {
4978
5389
  FillStyle?: BoxPlotFillStyle | string;
4979
5390
  }
4980
5391
  /**
5392
+ * @public
4981
5393
  * <p>The options of a box plot visual.</p>
4982
5394
  */
4983
5395
  export interface BoxPlotOptions {
@@ -4995,6 +5407,7 @@ export interface BoxPlotOptions {
4995
5407
  AllDataPointsVisibility?: Visibility | string;
4996
5408
  }
4997
5409
  /**
5410
+ * @public
4998
5411
  * <p>The aggregated field well for a box plot.</p>
4999
5412
  */
5000
5413
  export interface BoxPlotAggregatedFieldWells {
@@ -5008,6 +5421,7 @@ export interface BoxPlotAggregatedFieldWells {
5008
5421
  Values?: MeasureField[];
5009
5422
  }
5010
5423
  /**
5424
+ * @public
5011
5425
  * <p>The field wells of a <code>BoxPlotVisual</code>.</p>
5012
5426
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
5013
5427
  */
@@ -5018,6 +5432,7 @@ export interface BoxPlotFieldWells {
5018
5432
  BoxPlotAggregatedFieldWells?: BoxPlotAggregatedFieldWells;
5019
5433
  }
5020
5434
  /**
5435
+ * @public
5021
5436
  * <p>The pagination configuration for a table visual or boxplot.</p>
5022
5437
  */
5023
5438
  export interface PaginationConfiguration {
@@ -5031,6 +5446,7 @@ export interface PaginationConfiguration {
5031
5446
  PageNumber: number | undefined;
5032
5447
  }
5033
5448
  /**
5449
+ * @public
5034
5450
  * <p>The sort configuration of a <code>BoxPlotVisual</code>.</p>
5035
5451
  */
5036
5452
  export interface BoxPlotSortConfiguration {
@@ -5044,6 +5460,7 @@ export interface BoxPlotSortConfiguration {
5044
5460
  PaginationConfiguration?: PaginationConfiguration;
5045
5461
  }
5046
5462
  /**
5463
+ * @public
5047
5464
  * <p>The configuration of a <code>BoxPlotVisual</code>.</p>
5048
5465
  */
5049
5466
  export interface BoxPlotChartConfiguration {
@@ -5093,6 +5510,7 @@ export interface BoxPlotChartConfiguration {
5093
5510
  VisualPalette?: VisualPalette;
5094
5511
  }
5095
5512
  /**
5513
+ * @public
5096
5514
  * <p>A box plot.</p>
5097
5515
  * <p>For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html">Using box plots</a> in the <i>Amazon QuickSight User Guide</i>.</p>
5098
5516
  */
@@ -5123,6 +5541,7 @@ export interface BoxPlotVisual {
5123
5541
  ColumnHierarchies?: ColumnHierarchy[];
5124
5542
  }
5125
5543
  /**
5544
+ * @public
5126
5545
  * <p>The aggregated field wells of a combo chart.</p>
5127
5546
  */
5128
5547
  export interface ComboChartAggregatedFieldWells {
@@ -5144,6 +5563,7 @@ export interface ComboChartAggregatedFieldWells {
5144
5563
  LineValues?: MeasureField[];
5145
5564
  }
5146
5565
  /**
5566
+ * @public
5147
5567
  * <p>The field wells of the visual.</p>
5148
5568
  * <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>
5149
5569
  */
@@ -5154,6 +5574,7 @@ export interface ComboChartFieldWells {
5154
5574
  ComboChartAggregatedFieldWells?: ComboChartAggregatedFieldWells;
5155
5575
  }
5156
5576
  /**
5577
+ * @public
5157
5578
  * <p>The sort configuration of a <code>ComboChartVisual</code>.</p>
5158
5579
  */
5159
5580
  export interface ComboChartSortConfiguration {
@@ -5175,6 +5596,7 @@ export interface ComboChartSortConfiguration {
5175
5596
  ColorItemsLimit?: ItemsLimitConfiguration;
5176
5597
  }
5177
5598
  /**
5599
+ * @public
5178
5600
  * <p>The configuration of a <code>ComboChartVisual</code>.</p>
5179
5601
  */
5180
5602
  export interface ComboChartConfiguration {