@horietakehiro/aws-cdk-utul 0.33.0 → 0.33.2

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 (158) hide show
  1. package/buildspec_schedule.yaml +42 -0
  2. package/lib/types/cfn-resource-types/aws-amazonmq-broker.d.ts +2 -1
  3. package/lib/types/cfn-resource-types/aws-amazonmq-broker.js +1 -1
  4. package/lib/types/cfn-resource-types/aws-appconfig-configurationprofile.d.ts +4 -0
  5. package/lib/types/cfn-resource-types/aws-appconfig-configurationprofile.js +1 -1
  6. package/lib/types/cfn-resource-types/aws-appconfig-deployment.d.ts +40 -4
  7. package/lib/types/cfn-resource-types/aws-appconfig-deployment.js +1 -1
  8. package/lib/types/cfn-resource-types/aws-appconfig-environment.d.ts +4 -0
  9. package/lib/types/cfn-resource-types/aws-appconfig-environment.js +1 -1
  10. package/lib/types/cfn-resource-types/aws-autoscaling-autoscalinggroup.d.ts +17 -0
  11. package/lib/types/cfn-resource-types/aws-autoscaling-autoscalinggroup.js +1 -1
  12. package/lib/types/cfn-resource-types/aws-bedrock-agent.d.ts +5 -0
  13. package/lib/types/cfn-resource-types/aws-bedrock-agent.js +1 -1
  14. package/lib/types/cfn-resource-types/aws-bedrock-datasource.d.ts +25 -16
  15. package/lib/types/cfn-resource-types/aws-bedrock-datasource.js +1 -1
  16. package/lib/types/cfn-resource-types/aws-bedrock-knowledgebase.d.ts +48 -3
  17. package/lib/types/cfn-resource-types/aws-bedrock-knowledgebase.js +1 -1
  18. package/lib/types/cfn-resource-types/aws-bedrock-prompt.d.ts +158 -3
  19. package/lib/types/cfn-resource-types/aws-bedrock-prompt.js +1 -1
  20. package/lib/types/cfn-resource-types/aws-cassandra-keyspace.d.ts +4 -0
  21. package/lib/types/cfn-resource-types/aws-cassandra-keyspace.js +1 -1
  22. package/lib/types/cfn-resource-types/aws-cassandra-type.d.ts +41 -0
  23. package/lib/types/cfn-resource-types/aws-cassandra-type.js +3 -0
  24. package/lib/types/cfn-resource-types/aws-cleanrooms-collaboration.d.ts +18 -0
  25. package/lib/types/cfn-resource-types/aws-cleanrooms-collaboration.js +1 -1
  26. package/lib/types/cfn-resource-types/aws-cleanrooms-membership.d.ts +11 -0
  27. package/lib/types/cfn-resource-types/aws-cleanrooms-membership.js +1 -1
  28. package/lib/types/cfn-resource-types/aws-cloudformation-guardhook.d.ts +1 -1
  29. package/lib/types/cfn-resource-types/aws-cloudformation-guardhook.js +1 -1
  30. package/lib/types/cfn-resource-types/aws-cloudformation-lambdahook.d.ts +1 -1
  31. package/lib/types/cfn-resource-types/aws-cloudformation-lambdahook.js +1 -1
  32. package/lib/types/cfn-resource-types/aws-cloudfront-anycastiplist.d.ts +27 -0
  33. package/lib/types/cfn-resource-types/aws-cloudfront-anycastiplist.js +3 -0
  34. package/lib/types/cfn-resource-types/aws-cloudfront-distribution.d.ts +24 -7
  35. package/lib/types/cfn-resource-types/aws-cloudfront-distribution.js +1 -1
  36. package/lib/types/cfn-resource-types/aws-connect-queue.d.ts +0 -1
  37. package/lib/types/cfn-resource-types/aws-connect-queue.js +1 -1
  38. package/lib/types/cfn-resource-types/aws-customerprofiles-eventtrigger.d.ts +162 -0
  39. package/lib/types/cfn-resource-types/aws-customerprofiles-eventtrigger.js +3 -0
  40. package/lib/types/cfn-resource-types/aws-databrew-dataset.d.ts +9 -0
  41. package/lib/types/cfn-resource-types/aws-databrew-dataset.js +1 -1
  42. package/lib/types/cfn-resource-types/aws-datazone-datasource.d.ts +23 -1
  43. package/lib/types/cfn-resource-types/aws-datazone-datasource.js +1 -1
  44. package/lib/types/cfn-resource-types/aws-datazone-projectmembership.d.ts +1 -1
  45. package/lib/types/cfn-resource-types/aws-datazone-projectmembership.js +1 -1
  46. package/lib/types/cfn-resource-types/aws-datazone-subscriptiontarget.d.ts +1 -1
  47. package/lib/types/cfn-resource-types/aws-datazone-subscriptiontarget.js +1 -1
  48. package/lib/types/cfn-resource-types/aws-dms-dataprovider.d.ts +1 -1
  49. package/lib/types/cfn-resource-types/aws-dms-dataprovider.js +1 -1
  50. package/lib/types/cfn-resource-types/aws-docdb-dbcluster.d.ts +3 -0
  51. package/lib/types/cfn-resource-types/aws-docdb-dbcluster.js +1 -1
  52. package/lib/types/cfn-resource-types/aws-dynamodb-globaltable.d.ts +5 -3
  53. package/lib/types/cfn-resource-types/aws-dynamodb-globaltable.js +1 -1
  54. package/lib/types/cfn-resource-types/aws-dynamodb-table.d.ts +1 -0
  55. package/lib/types/cfn-resource-types/aws-dynamodb-table.js +1 -1
  56. package/lib/types/cfn-resource-types/aws-ec2-ec2fleet.d.ts +10 -0
  57. package/lib/types/cfn-resource-types/aws-ec2-ec2fleet.js +1 -1
  58. package/lib/types/cfn-resource-types/aws-ec2-launchtemplate.d.ts +1022 -0
  59. package/lib/types/cfn-resource-types/aws-ec2-launchtemplate.js +3 -0
  60. package/lib/types/cfn-resource-types/aws-ec2-networkacl.d.ts +1 -0
  61. package/lib/types/cfn-resource-types/aws-ec2-networkacl.js +1 -1
  62. package/lib/types/cfn-resource-types/aws-ec2-spotfleet.d.ts +136 -126
  63. package/lib/types/cfn-resource-types/aws-ec2-spotfleet.js +1 -1
  64. package/lib/types/cfn-resource-types/aws-ec2-volume.d.ts +5 -5
  65. package/lib/types/cfn-resource-types/aws-ec2-volume.js +1 -1
  66. package/lib/types/cfn-resource-types/aws-ec2-vpccidrblock.d.ts +4 -0
  67. package/lib/types/cfn-resource-types/aws-ec2-vpccidrblock.js +1 -1
  68. package/lib/types/cfn-resource-types/aws-ec2-vpcendpoint.d.ts +27 -14
  69. package/lib/types/cfn-resource-types/aws-ec2-vpcendpoint.js +1 -1
  70. package/lib/types/cfn-resource-types/aws-ec2-vpcendpointservice.d.ts +8 -0
  71. package/lib/types/cfn-resource-types/aws-ec2-vpcendpointservice.js +1 -1
  72. package/lib/types/cfn-resource-types/aws-ecs-service.d.ts +6 -3
  73. package/lib/types/cfn-resource-types/aws-ecs-service.js +1 -1
  74. package/lib/types/cfn-resource-types/aws-ecs-taskdefinition.d.ts +5 -2
  75. package/lib/types/cfn-resource-types/aws-ecs-taskdefinition.js +1 -1
  76. package/lib/types/cfn-resource-types/aws-efs-filesystem.d.ts +10 -1
  77. package/lib/types/cfn-resource-types/aws-efs-filesystem.js +1 -1
  78. package/lib/types/cfn-resource-types/aws-fis-experimenttemplate.d.ts +1 -1
  79. package/lib/types/cfn-resource-types/aws-fis-experimenttemplate.js +1 -1
  80. package/lib/types/cfn-resource-types/aws-imagebuilder-image.d.ts +45 -45
  81. package/lib/types/cfn-resource-types/aws-imagebuilder-image.js +1 -1
  82. package/lib/types/cfn-resource-types/aws-lex-bot.d.ts +17 -0
  83. package/lib/types/cfn-resource-types/aws-lex-bot.js +1 -1
  84. package/lib/types/cfn-resource-types/aws-logs-loggroup.d.ts +11 -0
  85. package/lib/types/cfn-resource-types/aws-logs-loggroup.js +1 -1
  86. package/lib/types/cfn-resource-types/aws-logs-metricfilter.d.ts +4 -0
  87. package/lib/types/cfn-resource-types/aws-logs-metricfilter.js +1 -1
  88. package/lib/types/cfn-resource-types/aws-logs-subscriptionfilter.d.ts +4 -0
  89. package/lib/types/cfn-resource-types/aws-logs-subscriptionfilter.js +1 -1
  90. package/lib/types/cfn-resource-types/aws-mediaconnect-bridge.d.ts +10 -0
  91. package/lib/types/cfn-resource-types/aws-mediaconnect-bridge.js +1 -1
  92. package/lib/types/cfn-resource-types/aws-mediaconnect-bridgesource.d.ts +10 -0
  93. package/lib/types/cfn-resource-types/aws-mediaconnect-bridgesource.js +1 -1
  94. package/lib/types/cfn-resource-types/aws-mediaconvert-queue.d.ts +1 -0
  95. package/lib/types/cfn-resource-types/aws-mediaconvert-queue.js +1 -1
  96. package/lib/types/cfn-resource-types/aws-opensearchservice-domain.d.ts +10 -0
  97. package/lib/types/cfn-resource-types/aws-opensearchservice-domain.js +1 -1
  98. package/lib/types/cfn-resource-types/aws-pcs-cluster.d.ts +151 -0
  99. package/lib/types/cfn-resource-types/aws-pcs-cluster.js +3 -0
  100. package/lib/types/cfn-resource-types/aws-pcs-computenodegroup.d.ts +142 -0
  101. package/lib/types/cfn-resource-types/aws-pcs-computenodegroup.js +3 -0
  102. package/lib/types/cfn-resource-types/aws-pcs-queue.d.ts +65 -0
  103. package/lib/types/cfn-resource-types/aws-pcs-queue.js +3 -0
  104. package/lib/types/cfn-resource-types/aws-qbusiness-dataaccessor.d.ts +1 -1
  105. package/lib/types/cfn-resource-types/aws-qbusiness-dataaccessor.js +1 -1
  106. package/lib/types/cfn-resource-types/aws-quicksight-analysis.d.ts +4218 -0
  107. package/lib/types/cfn-resource-types/aws-quicksight-analysis.js +3 -0
  108. package/lib/types/cfn-resource-types/aws-quicksight-custompermissions.d.ts +48 -0
  109. package/lib/types/cfn-resource-types/aws-quicksight-custompermissions.js +3 -0
  110. package/lib/types/cfn-resource-types/aws-quicksight-dashboard.d.ts +4338 -0
  111. package/lib/types/cfn-resource-types/aws-quicksight-dashboard.js +3 -0
  112. package/lib/types/cfn-resource-types/aws-quicksight-dataset.d.ts +16 -22
  113. package/lib/types/cfn-resource-types/aws-quicksight-dataset.js +1 -1
  114. package/lib/types/cfn-resource-types/aws-quicksight-template.d.ts +4018 -0
  115. package/lib/types/cfn-resource-types/aws-quicksight-template.js +3 -0
  116. package/lib/types/cfn-resource-types/aws-rds-dbcluster.d.ts +24 -13
  117. package/lib/types/cfn-resource-types/aws-rds-dbcluster.js +1 -1
  118. package/lib/types/cfn-resource-types/aws-rds-dbinstance.d.ts +1 -0
  119. package/lib/types/cfn-resource-types/aws-rds-dbinstance.js +1 -1
  120. package/lib/types/cfn-resource-types/aws-redshift-integration.d.ts +3 -5
  121. package/lib/types/cfn-resource-types/aws-redshift-integration.js +1 -1
  122. package/lib/types/cfn-resource-types/aws-resiliencehub-app.d.ts +4 -0
  123. package/lib/types/cfn-resource-types/aws-resiliencehub-app.js +1 -1
  124. package/lib/types/cfn-resource-types/aws-sagemaker-cluster.d.ts +52 -52
  125. package/lib/types/cfn-resource-types/aws-sagemaker-cluster.js +1 -1
  126. package/lib/types/cfn-resource-types/aws-sagemaker-domain.d.ts +5 -0
  127. package/lib/types/cfn-resource-types/aws-sagemaker-domain.js +1 -1
  128. package/lib/types/cfn-resource-types/aws-sagemaker-endpointconfig.d.ts +0 -1
  129. package/lib/types/cfn-resource-types/aws-sagemaker-endpointconfig.js +1 -1
  130. package/lib/types/cfn-resource-types/aws-sagemaker-partnerapp.d.ts +89 -0
  131. package/lib/types/cfn-resource-types/aws-sagemaker-partnerapp.js +3 -0
  132. package/lib/types/cfn-resource-types/aws-sagemaker-space.d.ts +4 -0
  133. package/lib/types/cfn-resource-types/aws-sagemaker-space.js +1 -1
  134. package/lib/types/cfn-resource-types/aws-sagemaker-userprofile.d.ts +5 -0
  135. package/lib/types/cfn-resource-types/aws-sagemaker-userprofile.js +1 -1
  136. package/lib/types/cfn-resource-types/aws-securityhub-configurationpolicy.d.ts +1 -1
  137. package/lib/types/cfn-resource-types/aws-securityhub-configurationpolicy.js +1 -1
  138. package/lib/types/cfn-resource-types/aws-ses-configurationset.d.ts +4 -0
  139. package/lib/types/cfn-resource-types/aws-ses-configurationset.js +1 -1
  140. package/lib/types/cfn-resource-types/aws-ses-mailmanagerruleset.d.ts +10 -1
  141. package/lib/types/cfn-resource-types/aws-ses-mailmanagerruleset.js +1 -1
  142. package/lib/types/cfn-resource-types/aws-ssmquicksetup-configurationmanager.d.ts +1 -1
  143. package/lib/types/cfn-resource-types/aws-ssmquicksetup-configurationmanager.js +1 -1
  144. package/lib/types/cfn-resource-types/aws-synthetics-canary.d.ts +4 -0
  145. package/lib/types/cfn-resource-types/aws-synthetics-canary.js +1 -1
  146. package/lib/types/cfn-resource-types/aws-wisdom-aiagent.d.ts +1 -0
  147. package/lib/types/cfn-resource-types/aws-wisdom-aiagent.js +1 -1
  148. package/lib/types/cfn-resource-types/aws-wisdom-aiprompt.d.ts +1 -0
  149. package/lib/types/cfn-resource-types/aws-wisdom-aiprompt.js +1 -1
  150. package/lib/types/cfn-resource-types.d.ts +24 -6
  151. package/lib/types/cfn-resource-types.js +50 -32
  152. package/package.json +2 -2
  153. package/lib/types/cfn-resource-types/aws-iot1click-device.d.ts +0 -8
  154. package/lib/types/cfn-resource-types/aws-iot1click-device.js +0 -3
  155. package/lib/types/cfn-resource-types/aws-iot1click-placement.d.ts +0 -14
  156. package/lib/types/cfn-resource-types/aws-iot1click-placement.js +0 -3
  157. package/lib/types/cfn-resource-types/aws-iot1click-project.d.ts +0 -18
  158. package/lib/types/cfn-resource-types/aws-iot1click-project.js +0 -3
@@ -0,0 +1,4338 @@
1
+ export type DayOfTheWeek = ("SUNDAY" | "MONDAY" | "TUESDAY" | "WEDNESDAY" | "THURSDAY" | "FRIDAY" | "SATURDAY");
2
+ export type WidgetStatus = ("ENABLED" | "DISABLED");
3
+ export type FilterNullOption = ("ALL_VALUES" | "NULLS_ONLY" | "NON_NULLS_ONLY");
4
+ export type CategoryFilterMatchOperator = ("EQUALS" | "DOES_NOT_EQUAL" | "CONTAINS" | "DOES_NOT_CONTAIN" | "STARTS_WITH" | "ENDS_WITH");
5
+ export type CategoryFilterSelectAllOptions = "FILTER_ALL_VALUES";
6
+ export type SheetControlSliderType = ("SINGLE_POINT" | "RANGE");
7
+ export type Visibility = ("HIDDEN" | "VISIBLE");
8
+ export type FontStyle = ("NORMAL" | "ITALIC");
9
+ export type RelativeFontSize = ("EXTRA_SMALL" | "SMALL" | "MEDIUM" | "LARGE" | "EXTRA_LARGE");
10
+ export type FontDecoration = ("UNDERLINE" | "NONE");
11
+ export type FontWeightName = ("NORMAL" | "BOLD");
12
+ export type CommitMode = ("AUTO" | "MANUAL");
13
+ export type SheetControlListType = ("MULTI_SELECT" | "SINGLE_SELECT");
14
+ export type SheetControlDateTimePickerType = ("SINGLE_VALUED" | "DATE_RANGE");
15
+ export type SimpleAttributeAggregationFunction = "UNIQUE_VALUE";
16
+ export type DateAggregationFunction = ("COUNT" | "DISTINCT_COUNT" | "MIN" | "MAX");
17
+ export type SimpleNumericalAggregationFunction = ("SUM" | "AVERAGE" | "MIN" | "MAX" | "COUNT" | "DISTINCT_COUNT" | "VAR" | "VARP" | "STDEV" | "STDEVP" | "MEDIAN");
18
+ export type CategoricalAggregationFunction = ("COUNT" | "DISTINCT_COUNT");
19
+ export type NumericEqualityMatchOperator = ("EQUALS" | "DOES_NOT_EQUAL");
20
+ export type NumericFilterSelectAllOptions = "FILTER_ALL_VALUES";
21
+ export type TimeGranularity = ("YEAR" | "QUARTER" | "MONTH" | "WEEK" | "DAY" | "HOUR" | "MINUTE" | "SECOND" | "MILLISECOND");
22
+ export type RelativeDateType = ("PREVIOUS" | "THIS" | "LAST" | "NOW" | "NEXT");
23
+ export type AnchorOption = "NOW";
24
+ export type SortDirection = ("ASC" | "DESC");
25
+ export type CrossDatasetTypes = ("ALL_DATASETS" | "SINGLE_DATASET");
26
+ export type FilterVisualScope = ("ALL_VISUALS" | "SELECTED_VISUALS");
27
+ export type ColumnRole = ("DIMENSION" | "MEASURE");
28
+ export type NegativeValueDisplayMode = ("POSITIVE" | "NEGATIVE");
29
+ export type NumberScale = ("NONE" | "AUTO" | "THOUSANDS" | "MILLIONS" | "BILLIONS" | "TRILLIONS");
30
+ export type NumericSeparatorSymbol = ("COMMA" | "DOT" | "SPACE");
31
+ export type SpecialValue = ("EMPTY" | "NULL" | "OTHER");
32
+ export type SheetContentType = ("PAGINATED" | "INTERACTIVE");
33
+ export type ResizeOption = ("FIXED" | "RESPONSIVE");
34
+ export type PaperSize = ("US_LETTER" | "US_LEGAL" | "US_TABLOID_LEDGER" | "A0" | "A1" | "A2" | "A3" | "A4" | "A5" | "JIS_B4" | "JIS_B5");
35
+ export type PaperOrientation = ("PORTRAIT" | "LANDSCAPE");
36
+ export type LayoutElementType = ("VISUAL" | "FILTER_CONTROL" | "PARAMETER_CONTROL" | "TEXT_BOX" | "IMAGE");
37
+ export type SectionPageBreakStatus = ("ENABLED" | "DISABLED");
38
+ export type ImageCustomActionTrigger = ("CLICK" | "MENU");
39
+ export type SelectAllValueOptions = "ALL_VALUES";
40
+ export type URLTargetConfiguration = ("NEW_TAB" | "NEW_WINDOW" | "SAME_TAB");
41
+ export type SheetImageScalingType = ("SCALE_TO_WIDTH" | "SCALE_TO_HEIGHT" | "SCALE_TO_CONTAINER" | "SCALE_NONE");
42
+ export type DashboardBehavior = ("ENABLED" | "DISABLED");
43
+ export type OtherCategories = ("INCLUDE" | "EXCLUDE");
44
+ export type DataLabelPosition = ("INSIDE" | "OUTSIDE" | "LEFT" | "TOP" | "BOTTOM" | "RIGHT");
45
+ export type FunnelChartMeasureDataLabelStyle = ("VALUE_ONLY" | "PERCENTAGE_BY_FIRST_STAGE" | "PERCENTAGE_BY_PREVIOUS_STAGE" | "VALUE_AND_PERCENTAGE_BY_FIRST_STAGE" | "VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE");
46
+ export type SelectedTooltipType = ("BASIC" | "DETAILED");
47
+ export type TooltipTarget = ("BOTH" | "BAR" | "LINE");
48
+ export type TooltipTitleType = ("NONE" | "PRIMARY_VALUE");
49
+ export type PivotTableDataPathType = ("HIERARCHY_ROWS_LAYOUT_COLUMN" | "MULTIPLE_ROW_METRICS_COLUMN" | "EMPTY_COLUMN_HEADER" | "COUNT_METRIC_COLUMN");
50
+ export type VisualCustomActionTrigger = ("DATA_POINT_CLICK" | "DATA_POINT_MENU");
51
+ export type SelectedFieldOptions = "ALL_FIELDS";
52
+ export type TargetVisualOptions = "ALL_VISUALS";
53
+ export type LegendPosition = ("AUTO" | "RIGHT" | "BOTTOM" | "TOP");
54
+ export type AxisBinding = ("PRIMARY_YAXIS" | "SECONDARY_YAXIS");
55
+ export type ReferenceLineSeriesType = ("BAR" | "LINE");
56
+ export type ReferenceLineLabelHorizontalPosition = ("LEFT" | "CENTER" | "RIGHT");
57
+ export type ReferenceLineValueLabelRelativePosition = ("BEFORE_CUSTOM_LABEL" | "AFTER_CUSTOM_LABEL");
58
+ export type ReferenceLineLabelVerticalPosition = ("ABOVE" | "BELOW");
59
+ export type ReferenceLinePatternType = ("SOLID" | "DASHED" | "DOTTED");
60
+ export type BoxPlotFillStyle = ("SOLID" | "TRANSPARENT");
61
+ export type GeospatialMapNavigation = ("ENABLED" | "DISABLED");
62
+ export type BaseMapStyleType = ("LIGHT_GRAY" | "DARK_GRAY" | "STREET" | "IMAGERY");
63
+ export type LayerCustomActionTrigger = ("DATA_POINT_CLICK" | "DATA_POINT_MENU");
64
+ export type GeospatialLayerType = ("POINT" | "LINE" | "POLYGON");
65
+ /**
66
+ * Defines view state of the color
67
+ */
68
+ export type GeospatialColorState = ("ENABLED" | "DISABLED");
69
+ export type MapZoomMode = ("AUTO" | "MANUAL");
70
+ export type GeospatialSelectedPointStyle = ("POINT" | "CLUSTER" | "HEATMAP");
71
+ export type DataLabelContent = ("VALUE" | "PERCENT" | "VALUE_AND_PERCENT");
72
+ export type DataLabelOverlap = ("DISABLE_OVERLAP" | "ENABLE_OVERLAP");
73
+ export type RadarChartShape = ("CIRCLE" | "POLYGON");
74
+ export type RadarChartAxesRangeScale = ("AUTO" | "INDEPENDENT" | "SHARED");
75
+ export type SingleYAxisOption = "PRIMARY_Y_AXIS";
76
+ export type BarsArrangement = ("CLUSTERED" | "STACKED" | "STACKED_PERCENT");
77
+ export type WordCloudWordOrientation = ("HORIZONTAL" | "HORIZONTAL_AND_VERTICAL");
78
+ export type WordCloudWordScaling = ("EMPHASIZE" | "NORMAL");
79
+ export type WordCloudCloudLayout = ("FLUID" | "NORMAL");
80
+ export type WordCloudWordCasing = ("LOWER_CASE" | "EXISTING_CASE");
81
+ export type WordCloudWordPadding = ("NONE" | "SMALL" | "MEDIUM" | "LARGE");
82
+ export type ConditionalFormattingIconDisplayOption = "ICON_ONLY";
83
+ export type Icon = ("CARET_UP" | "CARET_DOWN" | "PLUS" | "MINUS" | "ARROW_UP" | "ARROW_DOWN" | "ARROW_LEFT" | "ARROW_UP_LEFT" | "ARROW_DOWN_LEFT" | "ARROW_RIGHT" | "ARROW_UP_RIGHT" | "ARROW_DOWN_RIGHT" | "FACE_UP" | "FACE_DOWN" | "FACE_FLAT" | "ONE_BAR" | "TWO_BAR" | "THREE_BAR" | "CIRCLE" | "TRIANGLE" | "SQUARE" | "FLAG" | "THUMBS_UP" | "THUMBS_DOWN" | "CHECKMARK" | "X");
84
+ export type ConditionalFormattingIconSetType = ("PLUS_MINUS" | "CHECK_X" | "THREE_COLOR_ARROW" | "THREE_GRAY_ARROW" | "CARET_UP_MINUS_DOWN" | "THREE_SHAPE" | "THREE_CIRCLE" | "FLAGS" | "BARS" | "FOUR_COLOR_ARROW" | "FOUR_GRAY_ARROW");
85
+ export type ArcThicknessOptions = ("SMALL" | "MEDIUM" | "LARGE");
86
+ export type ComparisonMethod = ("DIFFERENCE" | "PERCENT_DIFFERENCE" | "PERCENT");
87
+ export type PrimaryValueDisplayType = ("HIDDEN" | "COMPARISON" | "ACTUAL");
88
+ export type CustomContentType = ("IMAGE" | "OTHER_EMBEDDED_CONTENT");
89
+ export type CustomContentImageScalingConfiguration = ("FIT_TO_HEIGHT" | "FIT_TO_WIDTH" | "DO_NOT_SCALE" | "SCALE_TO_VISUAL");
90
+ export type ArcThickness = ("SMALL" | "MEDIUM" | "LARGE" | "WHOLE");
91
+ export type PanelBorderStyle = ("SOLID" | "DASHED" | "DOTTED");
92
+ export type HorizontalTextAlignment = ("LEFT" | "CENTER" | "RIGHT" | "AUTO");
93
+ export type SmallMultiplesAxisPlacement = ("OUTSIDE" | "INSIDE");
94
+ export type SmallMultiplesAxisScale = ("SHARED" | "INDEPENDENT");
95
+ export type KPIVisualStandardLayoutType = ("CLASSIC" | "VERTICAL");
96
+ export type KPISparklineType = ("LINE" | "AREA");
97
+ export type HistogramBinType = ("BIN_COUNT" | "BIN_WIDTH");
98
+ export type PluginVisualAxisName = ("GROUP_BY" | "VALUE");
99
+ export type VerticalTextAlignment = ("TOP" | "MIDDLE" | "BOTTOM" | "AUTO");
100
+ export type TableBorderStyle = ("NONE" | "SOLID");
101
+ export type TextWrap = ("NONE" | "WRAP");
102
+ export type TableOrientation = ("VERTICAL" | "HORIZONTAL");
103
+ export type TableFieldIconSetType = "LINK";
104
+ export type TableCellImageScalingConfiguration = ("FIT_TO_CELL_HEIGHT" | "FIT_TO_CELL_WIDTH" | "DO_NOT_SCALE");
105
+ export type SimpleTotalAggregationFunction = ("DEFAULT" | "SUM" | "AVERAGE" | "MIN" | "MAX" | "NONE");
106
+ export type TableTotalsScrollStatus = ("PINNED" | "SCROLLED");
107
+ export type TableTotalsPlacement = ("START" | "END" | "AUTO");
108
+ export type PivotTableConditionalFormattingScopeRole = ("FIELD" | "FIELD_TOTAL" | "GRAND_TOTAL");
109
+ export type PivotTableRowsLayout = ("TABULAR" | "HIERARCHY");
110
+ export type PivotTableMetricPlacement = ("ROW" | "COLUMN");
111
+ export type PivotTableFieldCollapseState = ("COLLAPSED" | "EXPANDED");
112
+ export type PivotTableSubtotalLevel = ("ALL" | "CUSTOM" | "LAST");
113
+ export type StyledCellType = ("TOTAL" | "METRIC_HEADER" | "VALUE");
114
+ export type BarChartOrientation = ("HORIZONTAL" | "VERTICAL");
115
+ export type ColorFillType = ("DISCRETE" | "GRADIENT");
116
+ export type TopBottomComputationType = ("TOP" | "BOTTOM");
117
+ export type ForecastComputationSeasonality = ("AUTOMATIC" | "CUSTOM");
118
+ export type MaximumMinimumComputationType = ("MAXIMUM" | "MINIMUM");
119
+ export type TopBottomSortOrder = ("PERCENT_DIFFERENCE" | "ABSOLUTE_DIFFERENCE");
120
+ export type MissingDataTreatmentOption = ("INTERPOLATE" | "SHOW_AS_ZERO" | "SHOW_AS_BLANK");
121
+ export type LineInterpolation = ("LINEAR" | "SMOOTH" | "STEPPED");
122
+ export type LineChartLineStyle = ("SOLID" | "DOTTED" | "DASHED");
123
+ export type LineChartMarkerShape = ("CIRCLE" | "TRIANGLE" | "SQUARE" | "DIAMOND" | "ROUNDED_SQUARE");
124
+ export type LineChartType = ("LINE" | "AREA" | "STACKED_AREA");
125
+ export type ParameterValueType = ("MULTI_VALUED" | "SINGLE_VALUED");
126
+ export type ValueWhenUnsetOption = ("RECOMMENDED_VALUE" | "NULL");
127
+ export type ValidationStrategyMode = ("STRICT" | "LENIENT");
128
+ export type DashboardUIState = ("EXPANDED" | "COLLAPSED");
129
+ export type ResourceStatus = ("CREATION_IN_PROGRESS" | "CREATION_SUCCESSFUL" | "CREATION_FAILED" | "UPDATE_IN_PROGRESS" | "UPDATE_SUCCESSFUL" | "UPDATE_FAILED" | "DELETED");
130
+ export type DashboardErrorType = ("ACCESS_DENIED" | "SOURCE_NOT_FOUND" | "DATA_SET_NOT_FOUND" | "INTERNAL_FAILURE" | "PARAMETER_VALUE_INCOMPATIBLE" | "PARAMETER_TYPE_INVALID" | "PARAMETER_NOT_FOUND" | "COLUMN_TYPE_MISMATCH" | "COLUMN_GEOGRAPHIC_ROLE_MISMATCH" | "COLUMN_REPLACEMENT_MISSING");
131
+ /**
132
+ * Definition of the AWS::QuickSight::Dashboard Resource Type.
133
+ */
134
+ export interface _AWS_QUICKSIGHT_DASHBOARD {
135
+ /**
136
+ * <p>The time that this dashboard was created.</p>
137
+ */
138
+ CreatedTime?: string;
139
+ Parameters?: Parameters;
140
+ VersionDescription?: string;
141
+ SourceEntity?: DashboardSourceEntity;
142
+ ThemeArn?: string;
143
+ Definition?: DashboardVersionDefinition;
144
+ /**
145
+ * <p>The last time that this dashboard was updated.</p>
146
+ */
147
+ LastUpdatedTime?: string;
148
+ ValidationStrategy?: ValidationStrategy;
149
+ /**
150
+ * @minItems 0
151
+ * @maxItems 10
152
+ */
153
+ FolderArns?: string[];
154
+ DashboardId: string;
155
+ LinkSharingConfiguration?: LinkSharingConfiguration;
156
+ Name: string;
157
+ DashboardPublishOptions?: DashboardPublishOptions;
158
+ /**
159
+ * <p>The last time that this dashboard was published.</p>
160
+ */
161
+ LastPublishedTime?: string;
162
+ Version?: DashboardVersion;
163
+ AwsAccountId: string;
164
+ /**
165
+ * @minItems 1
166
+ * @maxItems 64
167
+ */
168
+ Permissions?: ResourcePermission[];
169
+ /**
170
+ * @minItems 0
171
+ * @maxItems 5
172
+ */
173
+ LinkEntities?: string[];
174
+ /**
175
+ * <p>The Amazon Resource Name (ARN) of the resource.</p>
176
+ */
177
+ Arn?: string;
178
+ /**
179
+ * @minItems 1
180
+ * @maxItems 200
181
+ */
182
+ Tags?: Tag[];
183
+ }
184
+ /**
185
+ * <p>A list of Amazon QuickSight parameters and the list's override values.</p>
186
+ */
187
+ export interface Parameters {
188
+ /**
189
+ * <p>The parameters that have a data type of string.</p>
190
+ *
191
+ * @minItems 0
192
+ * @maxItems 100
193
+ */
194
+ StringParameters?: StringParameter[];
195
+ /**
196
+ * <p>The parameters that have a data type of decimal.</p>
197
+ *
198
+ * @minItems 0
199
+ * @maxItems 100
200
+ */
201
+ DecimalParameters?: DecimalParameter[];
202
+ /**
203
+ * <p>The parameters that have a data type of integer.</p>
204
+ *
205
+ * @minItems 0
206
+ * @maxItems 100
207
+ */
208
+ IntegerParameters?: IntegerParameter[];
209
+ /**
210
+ * <p>The parameters that have a data type of date-time.</p>
211
+ *
212
+ * @minItems 0
213
+ * @maxItems 100
214
+ */
215
+ DateTimeParameters?: DateTimeParameter[];
216
+ }
217
+ /**
218
+ * <p>A string parameter.</p>
219
+ */
220
+ export interface StringParameter {
221
+ /**
222
+ * <p>The values of a string parameter.</p>
223
+ */
224
+ Values: string[];
225
+ /**
226
+ * <p>A display name for a string parameter.</p>
227
+ */
228
+ Name: string;
229
+ }
230
+ /**
231
+ * <p>A decimal parameter.</p>
232
+ */
233
+ export interface DecimalParameter {
234
+ /**
235
+ * <p>The values for the decimal parameter.</p>
236
+ */
237
+ Values: number[];
238
+ /**
239
+ * <p>A display name for the decimal parameter.</p>
240
+ */
241
+ Name: string;
242
+ }
243
+ /**
244
+ * <p>An integer parameter.</p>
245
+ */
246
+ export interface IntegerParameter {
247
+ /**
248
+ * <p>The values for the integer parameter.</p>
249
+ */
250
+ Values: number[];
251
+ /**
252
+ * <p>The name of the integer parameter.</p>
253
+ */
254
+ Name: string;
255
+ }
256
+ /**
257
+ * <p>A date-time parameter.</p>
258
+ */
259
+ export interface DateTimeParameter {
260
+ /**
261
+ * <p>The values for the date-time parameter.</p>
262
+ */
263
+ Values: string[];
264
+ /**
265
+ * <p>A display name for the date-time parameter.</p>
266
+ */
267
+ Name: string;
268
+ }
269
+ /**
270
+ * <p>Dashboard source entity.</p>
271
+ */
272
+ export interface DashboardSourceEntity {
273
+ SourceTemplate?: DashboardSourceTemplate;
274
+ }
275
+ /**
276
+ * <p>Dashboard source template.</p>
277
+ */
278
+ export interface DashboardSourceTemplate {
279
+ /**
280
+ * <p>Dataset references.</p>
281
+ *
282
+ * @minItems 1
283
+ */
284
+ DataSetReferences: DataSetReference[];
285
+ /**
286
+ * <p>The Amazon Resource Name (ARN) of the resource.</p>
287
+ */
288
+ Arn: string;
289
+ }
290
+ /**
291
+ * <p>Dataset reference.</p>
292
+ */
293
+ export interface DataSetReference {
294
+ /**
295
+ * <p>Dataset Amazon Resource Name (ARN).</p>
296
+ */
297
+ DataSetArn: string;
298
+ /**
299
+ * <p>Dataset placeholder.</p>
300
+ */
301
+ DataSetPlaceholder: string;
302
+ }
303
+ export interface DashboardVersionDefinition {
304
+ Options?: AssetOptions;
305
+ /**
306
+ * @minItems 0
307
+ * @maxItems 2000
308
+ */
309
+ FilterGroups?: FilterGroup[];
310
+ /**
311
+ * @minItems 0
312
+ * @maxItems 200
313
+ */
314
+ StaticFiles?: StaticFile[];
315
+ /**
316
+ * @minItems 0
317
+ * @maxItems 500
318
+ */
319
+ CalculatedFields?: CalculatedField[];
320
+ /**
321
+ * @minItems 1
322
+ * @maxItems 50
323
+ */
324
+ DataSetIdentifierDeclarations: DataSetIdentifierDeclaration[];
325
+ /**
326
+ * @minItems 0
327
+ * @maxItems 2000
328
+ */
329
+ ColumnConfigurations?: ColumnConfiguration[];
330
+ AnalysisDefaults?: AnalysisDefaults;
331
+ /**
332
+ * @minItems 0
333
+ * @maxItems 20
334
+ */
335
+ Sheets?: SheetDefinition[];
336
+ /**
337
+ * @minItems 0
338
+ * @maxItems 200
339
+ */
340
+ ParameterDeclarations?: ParameterDeclaration[];
341
+ }
342
+ export interface AssetOptions {
343
+ Timezone?: string;
344
+ WeekStart?: DayOfTheWeek;
345
+ }
346
+ export interface FilterGroup {
347
+ Status?: WidgetStatus;
348
+ /**
349
+ * @minItems 0
350
+ * @maxItems 20
351
+ */
352
+ Filters: Filter[];
353
+ CrossDataset: CrossDatasetTypes;
354
+ ScopeConfiguration: FilterScopeConfiguration;
355
+ FilterGroupId: string;
356
+ }
357
+ export interface Filter {
358
+ NestedFilter?: NestedFilter;
359
+ NumericEqualityFilter?: NumericEqualityFilter;
360
+ NumericRangeFilter?: NumericRangeFilter;
361
+ TimeRangeFilter?: TimeRangeFilter;
362
+ RelativeDatesFilter?: RelativeDatesFilter;
363
+ TopBottomFilter?: TopBottomFilter;
364
+ TimeEqualityFilter?: TimeEqualityFilter;
365
+ CategoryFilter?: CategoryFilter;
366
+ }
367
+ export interface NestedFilter {
368
+ Column: ColumnIdentifier;
369
+ InnerFilter: InnerFilter;
370
+ IncludeInnerSet: boolean;
371
+ FilterId: string;
372
+ }
373
+ export interface ColumnIdentifier {
374
+ ColumnName: string;
375
+ DataSetIdentifier: string;
376
+ }
377
+ export interface InnerFilter {
378
+ CategoryInnerFilter?: CategoryInnerFilter;
379
+ }
380
+ export interface CategoryInnerFilter {
381
+ Configuration: CategoryFilterConfiguration;
382
+ Column: ColumnIdentifier;
383
+ DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
384
+ }
385
+ export interface CategoryFilterConfiguration {
386
+ CustomFilterListConfiguration?: CustomFilterListConfiguration;
387
+ CustomFilterConfiguration?: CustomFilterConfiguration;
388
+ FilterListConfiguration?: FilterListConfiguration;
389
+ }
390
+ export interface CustomFilterListConfiguration {
391
+ /**
392
+ * @minItems 0
393
+ * @maxItems 100000
394
+ */
395
+ CategoryValues?: string[];
396
+ NullOption: FilterNullOption;
397
+ MatchOperator: CategoryFilterMatchOperator;
398
+ SelectAllOptions?: CategoryFilterSelectAllOptions;
399
+ }
400
+ export interface CustomFilterConfiguration {
401
+ CategoryValue?: string;
402
+ ParameterName?: string;
403
+ NullOption: FilterNullOption;
404
+ MatchOperator: CategoryFilterMatchOperator;
405
+ SelectAllOptions?: CategoryFilterSelectAllOptions;
406
+ }
407
+ export interface FilterListConfiguration {
408
+ /**
409
+ * @minItems 0
410
+ * @maxItems 100000
411
+ */
412
+ CategoryValues?: string[];
413
+ NullOption?: FilterNullOption;
414
+ MatchOperator: CategoryFilterMatchOperator;
415
+ SelectAllOptions?: CategoryFilterSelectAllOptions;
416
+ }
417
+ export interface DefaultFilterControlConfiguration {
418
+ ControlOptions: DefaultFilterControlOptions;
419
+ Title: string;
420
+ }
421
+ export interface DefaultFilterControlOptions {
422
+ DefaultSliderOptions?: DefaultSliderControlOptions;
423
+ DefaultRelativeDateTimeOptions?: DefaultRelativeDateTimeControlOptions;
424
+ DefaultTextFieldOptions?: DefaultTextFieldControlOptions;
425
+ DefaultTextAreaOptions?: DefaultTextAreaControlOptions;
426
+ DefaultDropdownOptions?: DefaultFilterDropDownControlOptions;
427
+ DefaultDateTimePickerOptions?: DefaultDateTimePickerControlOptions;
428
+ DefaultListOptions?: DefaultFilterListControlOptions;
429
+ }
430
+ export interface DefaultSliderControlOptions {
431
+ Type?: SheetControlSliderType;
432
+ StepSize: number;
433
+ DisplayOptions?: SliderControlDisplayOptions;
434
+ MaximumValue: number;
435
+ MinimumValue: number;
436
+ }
437
+ export interface SliderControlDisplayOptions {
438
+ TitleOptions?: LabelOptions;
439
+ InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
440
+ }
441
+ export interface LabelOptions {
442
+ CustomLabel?: string;
443
+ Visibility?: Visibility;
444
+ FontConfiguration?: FontConfiguration;
445
+ }
446
+ export interface FontConfiguration {
447
+ FontStyle?: FontStyle;
448
+ FontSize?: FontSize;
449
+ FontDecoration?: FontDecoration;
450
+ FontColor?: string;
451
+ FontWeight?: FontWeight;
452
+ }
453
+ export interface FontSize {
454
+ Relative?: RelativeFontSize;
455
+ /**
456
+ * String based length that is composed of value and unit in px
457
+ */
458
+ Absolute?: string;
459
+ }
460
+ export interface FontWeight {
461
+ Name?: FontWeightName;
462
+ }
463
+ export interface SheetControlInfoIconLabelOptions {
464
+ Visibility?: Visibility;
465
+ InfoIconText?: string;
466
+ }
467
+ export interface DefaultRelativeDateTimeControlOptions {
468
+ DisplayOptions?: RelativeDateTimeControlDisplayOptions;
469
+ CommitMode?: CommitMode;
470
+ }
471
+ export interface RelativeDateTimeControlDisplayOptions {
472
+ TitleOptions?: LabelOptions;
473
+ InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
474
+ DateTimeFormat?: string;
475
+ }
476
+ export interface DefaultTextFieldControlOptions {
477
+ DisplayOptions?: TextFieldControlDisplayOptions;
478
+ }
479
+ export interface TextFieldControlDisplayOptions {
480
+ TitleOptions?: LabelOptions;
481
+ PlaceholderOptions?: TextControlPlaceholderOptions;
482
+ InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
483
+ }
484
+ export interface TextControlPlaceholderOptions {
485
+ Visibility?: Visibility;
486
+ }
487
+ export interface DefaultTextAreaControlOptions {
488
+ Delimiter?: string;
489
+ DisplayOptions?: TextAreaControlDisplayOptions;
490
+ }
491
+ export interface TextAreaControlDisplayOptions {
492
+ TitleOptions?: LabelOptions;
493
+ PlaceholderOptions?: TextControlPlaceholderOptions;
494
+ InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
495
+ }
496
+ export interface DefaultFilterDropDownControlOptions {
497
+ Type?: SheetControlListType;
498
+ DisplayOptions?: DropDownControlDisplayOptions;
499
+ CommitMode?: CommitMode;
500
+ SelectableValues?: FilterSelectableValues;
501
+ }
502
+ export interface DropDownControlDisplayOptions {
503
+ TitleOptions?: LabelOptions;
504
+ SelectAllOptions?: ListControlSelectAllOptions;
505
+ InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
506
+ }
507
+ export interface ListControlSelectAllOptions {
508
+ Visibility?: Visibility;
509
+ }
510
+ export interface FilterSelectableValues {
511
+ /**
512
+ * @minItems 0
513
+ * @maxItems 50000
514
+ */
515
+ Values?: string[];
516
+ }
517
+ export interface DefaultDateTimePickerControlOptions {
518
+ Type?: SheetControlDateTimePickerType;
519
+ DisplayOptions?: DateTimePickerControlDisplayOptions;
520
+ CommitMode?: CommitMode;
521
+ }
522
+ export interface DateTimePickerControlDisplayOptions {
523
+ TitleOptions?: LabelOptions;
524
+ InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
525
+ DateTimeFormat?: string;
526
+ }
527
+ export interface DefaultFilterListControlOptions {
528
+ Type?: SheetControlListType;
529
+ DisplayOptions?: ListControlDisplayOptions;
530
+ SelectableValues?: FilterSelectableValues;
531
+ }
532
+ export interface ListControlDisplayOptions {
533
+ TitleOptions?: LabelOptions;
534
+ SearchOptions?: ListControlSearchOptions;
535
+ SelectAllOptions?: ListControlSelectAllOptions;
536
+ InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
537
+ }
538
+ export interface ListControlSearchOptions {
539
+ Visibility?: Visibility;
540
+ }
541
+ export interface NumericEqualityFilter {
542
+ AggregationFunction?: AggregationFunction;
543
+ Column: ColumnIdentifier;
544
+ Value?: number;
545
+ ParameterName?: string;
546
+ NullOption: FilterNullOption;
547
+ MatchOperator: NumericEqualityMatchOperator;
548
+ SelectAllOptions?: NumericFilterSelectAllOptions;
549
+ DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
550
+ FilterId: string;
551
+ }
552
+ export interface AggregationFunction {
553
+ AttributeAggregationFunction?: AttributeAggregationFunction;
554
+ DateAggregationFunction?: DateAggregationFunction;
555
+ NumericalAggregationFunction?: NumericalAggregationFunction;
556
+ CategoricalAggregationFunction?: CategoricalAggregationFunction;
557
+ }
558
+ export interface AttributeAggregationFunction {
559
+ SimpleAttributeAggregation?: SimpleAttributeAggregationFunction;
560
+ ValueForMultipleValues?: string;
561
+ }
562
+ export interface NumericalAggregationFunction {
563
+ PercentileAggregation?: PercentileAggregation;
564
+ SimpleNumericalAggregation?: SimpleNumericalAggregationFunction;
565
+ }
566
+ export interface PercentileAggregation {
567
+ PercentileValue?: number;
568
+ }
569
+ export interface NumericRangeFilter {
570
+ AggregationFunction?: AggregationFunction;
571
+ Column: ColumnIdentifier;
572
+ IncludeMaximum?: boolean;
573
+ RangeMinimum?: NumericRangeFilterValue;
574
+ NullOption: FilterNullOption;
575
+ SelectAllOptions?: NumericFilterSelectAllOptions;
576
+ DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
577
+ FilterId: string;
578
+ RangeMaximum?: NumericRangeFilterValue;
579
+ IncludeMinimum?: boolean;
580
+ }
581
+ export interface NumericRangeFilterValue {
582
+ StaticValue?: number;
583
+ Parameter?: string;
584
+ }
585
+ export interface TimeRangeFilter {
586
+ RangeMinimumValue?: TimeRangeFilterValue;
587
+ Column: ColumnIdentifier;
588
+ RangeMaximumValue?: TimeRangeFilterValue;
589
+ IncludeMaximum?: boolean;
590
+ TimeGranularity?: TimeGranularity;
591
+ NullOption: FilterNullOption;
592
+ DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
593
+ FilterId: string;
594
+ IncludeMinimum?: boolean;
595
+ ExcludePeriodConfiguration?: ExcludePeriodConfiguration;
596
+ }
597
+ export interface TimeRangeFilterValue {
598
+ RollingDate?: RollingDateConfiguration;
599
+ StaticValue?: string;
600
+ Parameter?: string;
601
+ }
602
+ export interface RollingDateConfiguration {
603
+ Expression: string;
604
+ DataSetIdentifier?: string;
605
+ }
606
+ export interface ExcludePeriodConfiguration {
607
+ Status?: WidgetStatus;
608
+ Amount: number;
609
+ Granularity: TimeGranularity;
610
+ }
611
+ export interface RelativeDatesFilter {
612
+ RelativeDateValue?: number;
613
+ Column: ColumnIdentifier;
614
+ RelativeDateType: RelativeDateType;
615
+ TimeGranularity: TimeGranularity;
616
+ ParameterName?: string;
617
+ NullOption: FilterNullOption;
618
+ DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
619
+ FilterId: string;
620
+ AnchorDateConfiguration: AnchorDateConfiguration;
621
+ MinimumGranularity?: TimeGranularity;
622
+ ExcludePeriodConfiguration?: ExcludePeriodConfiguration;
623
+ }
624
+ export interface AnchorDateConfiguration {
625
+ AnchorOption?: AnchorOption;
626
+ ParameterName?: string;
627
+ }
628
+ export interface TopBottomFilter {
629
+ /**
630
+ * @minItems 0
631
+ * @maxItems 100
632
+ */
633
+ AggregationSortConfigurations: AggregationSortConfiguration[];
634
+ Column: ColumnIdentifier;
635
+ TimeGranularity?: TimeGranularity;
636
+ ParameterName?: string;
637
+ Limit?: number;
638
+ DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
639
+ FilterId: string;
640
+ }
641
+ export interface AggregationSortConfiguration {
642
+ AggregationFunction?: AggregationFunction;
643
+ SortDirection: SortDirection;
644
+ Column: ColumnIdentifier;
645
+ }
646
+ export interface TimeEqualityFilter {
647
+ Column: ColumnIdentifier;
648
+ RollingDate?: RollingDateConfiguration;
649
+ Value?: string;
650
+ TimeGranularity?: TimeGranularity;
651
+ ParameterName?: string;
652
+ DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
653
+ FilterId: string;
654
+ }
655
+ export interface CategoryFilter {
656
+ Configuration: CategoryFilterConfiguration;
657
+ Column: ColumnIdentifier;
658
+ DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
659
+ FilterId: string;
660
+ }
661
+ export interface FilterScopeConfiguration {
662
+ AllSheets?: AllSheetsFilterScopeConfiguration;
663
+ SelectedSheets?: SelectedSheetsFilterScopeConfiguration;
664
+ }
665
+ export interface AllSheetsFilterScopeConfiguration {
666
+ }
667
+ export interface SelectedSheetsFilterScopeConfiguration {
668
+ /**
669
+ * @minItems 1
670
+ * @maxItems 50
671
+ */
672
+ SheetVisualScopingConfigurations?: SheetVisualScopingConfiguration[];
673
+ }
674
+ export interface SheetVisualScopingConfiguration {
675
+ Scope: FilterVisualScope;
676
+ SheetId: string;
677
+ /**
678
+ * @minItems 0
679
+ * @maxItems 50
680
+ */
681
+ VisualIds?: string[];
682
+ }
683
+ export interface StaticFile {
684
+ ImageStaticFile?: ImageStaticFile;
685
+ SpatialStaticFile?: SpatialStaticFile;
686
+ }
687
+ export interface ImageStaticFile {
688
+ StaticFileId: string;
689
+ Source?: StaticFileSource;
690
+ }
691
+ export interface StaticFileSource {
692
+ UrlOptions?: StaticFileUrlSourceOptions;
693
+ S3Options?: StaticFileS3SourceOptions;
694
+ }
695
+ export interface StaticFileUrlSourceOptions {
696
+ Url: string;
697
+ }
698
+ export interface StaticFileS3SourceOptions {
699
+ BucketName: string;
700
+ ObjectKey: string;
701
+ Region: string;
702
+ }
703
+ export interface SpatialStaticFile {
704
+ StaticFileId: string;
705
+ Source?: StaticFileSource;
706
+ }
707
+ export interface CalculatedField {
708
+ Expression: string;
709
+ DataSetIdentifier: string;
710
+ Name: string;
711
+ }
712
+ export interface DataSetIdentifierDeclaration {
713
+ Identifier: string;
714
+ DataSetArn: string;
715
+ }
716
+ export interface ColumnConfiguration {
717
+ Role?: ColumnRole;
718
+ FormatConfiguration?: FormatConfiguration;
719
+ Column: ColumnIdentifier;
720
+ ColorsConfiguration?: ColorsConfiguration;
721
+ }
722
+ export interface FormatConfiguration {
723
+ NumberFormatConfiguration?: NumberFormatConfiguration;
724
+ DateTimeFormatConfiguration?: DateTimeFormatConfiguration;
725
+ StringFormatConfiguration?: StringFormatConfiguration;
726
+ }
727
+ export interface NumberFormatConfiguration {
728
+ FormatConfiguration?: NumericFormatConfiguration;
729
+ }
730
+ export interface NumericFormatConfiguration {
731
+ NumberDisplayFormatConfiguration?: NumberDisplayFormatConfiguration;
732
+ CurrencyDisplayFormatConfiguration?: CurrencyDisplayFormatConfiguration;
733
+ PercentageDisplayFormatConfiguration?: PercentageDisplayFormatConfiguration;
734
+ }
735
+ export interface NumberDisplayFormatConfiguration {
736
+ NegativeValueConfiguration?: NegativeValueConfiguration;
737
+ DecimalPlacesConfiguration?: DecimalPlacesConfiguration;
738
+ NumberScale?: NumberScale;
739
+ NullValueFormatConfiguration?: NullValueFormatConfiguration;
740
+ Suffix?: string;
741
+ SeparatorConfiguration?: NumericSeparatorConfiguration;
742
+ Prefix?: string;
743
+ }
744
+ export interface NegativeValueConfiguration {
745
+ DisplayMode: NegativeValueDisplayMode;
746
+ }
747
+ export interface DecimalPlacesConfiguration {
748
+ DecimalPlaces: number;
749
+ }
750
+ export interface NullValueFormatConfiguration {
751
+ NullString: string;
752
+ }
753
+ export interface NumericSeparatorConfiguration {
754
+ DecimalSeparator?: NumericSeparatorSymbol;
755
+ ThousandsSeparator?: ThousandSeparatorOptions;
756
+ }
757
+ export interface ThousandSeparatorOptions {
758
+ Symbol?: NumericSeparatorSymbol;
759
+ Visibility?: Visibility;
760
+ }
761
+ export interface CurrencyDisplayFormatConfiguration {
762
+ NegativeValueConfiguration?: NegativeValueConfiguration;
763
+ DecimalPlacesConfiguration?: DecimalPlacesConfiguration;
764
+ NumberScale?: NumberScale;
765
+ NullValueFormatConfiguration?: NullValueFormatConfiguration;
766
+ Suffix?: string;
767
+ SeparatorConfiguration?: NumericSeparatorConfiguration;
768
+ Symbol?: string;
769
+ Prefix?: string;
770
+ }
771
+ export interface PercentageDisplayFormatConfiguration {
772
+ NegativeValueConfiguration?: NegativeValueConfiguration;
773
+ DecimalPlacesConfiguration?: DecimalPlacesConfiguration;
774
+ NullValueFormatConfiguration?: NullValueFormatConfiguration;
775
+ Suffix?: string;
776
+ SeparatorConfiguration?: NumericSeparatorConfiguration;
777
+ Prefix?: string;
778
+ }
779
+ export interface DateTimeFormatConfiguration {
780
+ NumericFormatConfiguration?: NumericFormatConfiguration;
781
+ NullValueFormatConfiguration?: NullValueFormatConfiguration;
782
+ DateTimeFormat?: string;
783
+ }
784
+ export interface StringFormatConfiguration {
785
+ NumericFormatConfiguration?: NumericFormatConfiguration;
786
+ NullValueFormatConfiguration?: NullValueFormatConfiguration;
787
+ }
788
+ export interface ColorsConfiguration {
789
+ /**
790
+ * @minItems 0
791
+ * @maxItems 50
792
+ */
793
+ CustomColors?: CustomColor[];
794
+ }
795
+ export interface CustomColor {
796
+ Color: string;
797
+ FieldValue?: string;
798
+ SpecialValue?: SpecialValue;
799
+ }
800
+ export interface AnalysisDefaults {
801
+ DefaultNewSheetConfiguration: DefaultNewSheetConfiguration;
802
+ }
803
+ export interface DefaultNewSheetConfiguration {
804
+ SheetContentType?: SheetContentType;
805
+ InteractiveLayoutConfiguration?: DefaultInteractiveLayoutConfiguration;
806
+ PaginatedLayoutConfiguration?: DefaultPaginatedLayoutConfiguration;
807
+ }
808
+ export interface DefaultInteractiveLayoutConfiguration {
809
+ FreeForm?: DefaultFreeFormLayoutConfiguration;
810
+ Grid?: DefaultGridLayoutConfiguration;
811
+ }
812
+ export interface DefaultFreeFormLayoutConfiguration {
813
+ CanvasSizeOptions: FreeFormLayoutCanvasSizeOptions;
814
+ }
815
+ export interface FreeFormLayoutCanvasSizeOptions {
816
+ ScreenCanvasSizeOptions?: FreeFormLayoutScreenCanvasSizeOptions;
817
+ }
818
+ export interface FreeFormLayoutScreenCanvasSizeOptions {
819
+ /**
820
+ * String based length that is composed of value and unit in px
821
+ */
822
+ OptimizedViewPortWidth: string;
823
+ }
824
+ export interface DefaultGridLayoutConfiguration {
825
+ CanvasSizeOptions: GridLayoutCanvasSizeOptions;
826
+ }
827
+ export interface GridLayoutCanvasSizeOptions {
828
+ ScreenCanvasSizeOptions?: GridLayoutScreenCanvasSizeOptions;
829
+ }
830
+ export interface GridLayoutScreenCanvasSizeOptions {
831
+ /**
832
+ * String based length that is composed of value and unit in px
833
+ */
834
+ OptimizedViewPortWidth?: string;
835
+ ResizeOption: ResizeOption;
836
+ }
837
+ export interface DefaultPaginatedLayoutConfiguration {
838
+ SectionBased?: DefaultSectionBasedLayoutConfiguration;
839
+ }
840
+ export interface DefaultSectionBasedLayoutConfiguration {
841
+ CanvasSizeOptions: SectionBasedLayoutCanvasSizeOptions;
842
+ }
843
+ export interface SectionBasedLayoutCanvasSizeOptions {
844
+ PaperCanvasSizeOptions?: SectionBasedLayoutPaperCanvasSizeOptions;
845
+ }
846
+ export interface SectionBasedLayoutPaperCanvasSizeOptions {
847
+ PaperMargin?: Spacing;
848
+ PaperSize?: PaperSize;
849
+ PaperOrientation?: PaperOrientation;
850
+ }
851
+ export interface Spacing {
852
+ /**
853
+ * String based length that is composed of value and unit
854
+ */
855
+ Left?: string;
856
+ /**
857
+ * String based length that is composed of value and unit
858
+ */
859
+ Top?: string;
860
+ /**
861
+ * String based length that is composed of value and unit
862
+ */
863
+ Right?: string;
864
+ /**
865
+ * String based length that is composed of value and unit
866
+ */
867
+ Bottom?: string;
868
+ }
869
+ export interface SheetDefinition {
870
+ Description?: string;
871
+ /**
872
+ * @minItems 0
873
+ * @maxItems 200
874
+ */
875
+ ParameterControls?: ParameterControl[];
876
+ /**
877
+ * @minItems 0
878
+ * @maxItems 100
879
+ */
880
+ TextBoxes?: SheetTextBox[];
881
+ /**
882
+ * @minItems 1
883
+ * @maxItems 1
884
+ */
885
+ Layouts?: Layout[];
886
+ ContentType?: SheetContentType;
887
+ SheetId: string;
888
+ /**
889
+ * @minItems 0
890
+ * @maxItems 200
891
+ */
892
+ FilterControls?: FilterControl[];
893
+ /**
894
+ * @minItems 0
895
+ * @maxItems 10
896
+ */
897
+ Images?: SheetImage[];
898
+ /**
899
+ * @minItems 0
900
+ * @maxItems 1
901
+ */
902
+ SheetControlLayouts?: SheetControlLayout[];
903
+ Title?: string;
904
+ /**
905
+ * @minItems 0
906
+ * @maxItems 50
907
+ */
908
+ Visuals?: Visual[];
909
+ Name?: string;
910
+ }
911
+ export interface ParameterControl {
912
+ Slider?: ParameterSliderControl;
913
+ TextArea?: ParameterTextAreaControl;
914
+ Dropdown?: ParameterDropDownControl;
915
+ TextField?: ParameterTextFieldControl;
916
+ List?: ParameterListControl;
917
+ DateTimePicker?: ParameterDateTimePickerControl;
918
+ }
919
+ export interface ParameterSliderControl {
920
+ ParameterControlId: string;
921
+ StepSize: number;
922
+ DisplayOptions?: SliderControlDisplayOptions;
923
+ SourceParameterName: string;
924
+ Title: string;
925
+ MaximumValue: number;
926
+ MinimumValue: number;
927
+ }
928
+ export interface ParameterTextAreaControl {
929
+ ParameterControlId: string;
930
+ Delimiter?: string;
931
+ DisplayOptions?: TextAreaControlDisplayOptions;
932
+ SourceParameterName: string;
933
+ Title: string;
934
+ }
935
+ export interface ParameterDropDownControl {
936
+ ParameterControlId: string;
937
+ Type?: SheetControlListType;
938
+ DisplayOptions?: DropDownControlDisplayOptions;
939
+ SourceParameterName: string;
940
+ CascadingControlConfiguration?: CascadingControlConfiguration;
941
+ Title: string;
942
+ CommitMode?: CommitMode;
943
+ SelectableValues?: ParameterSelectableValues;
944
+ }
945
+ export interface CascadingControlConfiguration {
946
+ /**
947
+ * @minItems 0
948
+ * @maxItems 200
949
+ */
950
+ SourceControls?: CascadingControlSource[];
951
+ }
952
+ export interface CascadingControlSource {
953
+ SourceSheetControlId?: string;
954
+ ColumnToMatch?: ColumnIdentifier;
955
+ }
956
+ export interface ParameterSelectableValues {
957
+ LinkToDataSetColumn?: ColumnIdentifier;
958
+ /**
959
+ * @minItems 0
960
+ * @maxItems 50000
961
+ */
962
+ Values?: string[];
963
+ }
964
+ export interface ParameterTextFieldControl {
965
+ ParameterControlId: string;
966
+ DisplayOptions?: TextFieldControlDisplayOptions;
967
+ SourceParameterName: string;
968
+ Title: string;
969
+ }
970
+ export interface ParameterListControl {
971
+ ParameterControlId: string;
972
+ Type?: SheetControlListType;
973
+ DisplayOptions?: ListControlDisplayOptions;
974
+ SourceParameterName: string;
975
+ CascadingControlConfiguration?: CascadingControlConfiguration;
976
+ Title: string;
977
+ SelectableValues?: ParameterSelectableValues;
978
+ }
979
+ export interface ParameterDateTimePickerControl {
980
+ ParameterControlId: string;
981
+ DisplayOptions?: DateTimePickerControlDisplayOptions;
982
+ SourceParameterName: string;
983
+ Title: string;
984
+ }
985
+ export interface SheetTextBox {
986
+ SheetTextBoxId: string;
987
+ Content?: string;
988
+ }
989
+ export interface Layout {
990
+ Configuration: LayoutConfiguration;
991
+ }
992
+ export interface LayoutConfiguration {
993
+ GridLayout?: GridLayoutConfiguration;
994
+ FreeFormLayout?: FreeFormLayoutConfiguration;
995
+ SectionBasedLayout?: SectionBasedLayoutConfiguration;
996
+ }
997
+ export interface GridLayoutConfiguration {
998
+ CanvasSizeOptions?: GridLayoutCanvasSizeOptions;
999
+ /**
1000
+ * @minItems 0
1001
+ * @maxItems 430
1002
+ */
1003
+ Elements: GridLayoutElement[];
1004
+ }
1005
+ export interface GridLayoutElement {
1006
+ ElementType: LayoutElementType;
1007
+ ColumnSpan: number;
1008
+ ColumnIndex?: number;
1009
+ RowIndex?: number;
1010
+ RowSpan: number;
1011
+ ElementId: string;
1012
+ }
1013
+ export interface FreeFormLayoutConfiguration {
1014
+ CanvasSizeOptions?: FreeFormLayoutCanvasSizeOptions;
1015
+ /**
1016
+ * @minItems 0
1017
+ * @maxItems 430
1018
+ */
1019
+ Elements: FreeFormLayoutElement[];
1020
+ }
1021
+ export interface FreeFormLayoutElement {
1022
+ ElementType: LayoutElementType;
1023
+ BorderStyle?: FreeFormLayoutElementBorderStyle;
1024
+ /**
1025
+ * String based length that is composed of value and unit in px
1026
+ */
1027
+ Height: string;
1028
+ Visibility?: Visibility;
1029
+ /**
1030
+ * @minItems 0
1031
+ * @maxItems 10000
1032
+ */
1033
+ RenderingRules?: SheetElementRenderingRule[];
1034
+ /**
1035
+ * String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value
1036
+ */
1037
+ YAxisLocation: string;
1038
+ LoadingAnimation?: LoadingAnimation;
1039
+ /**
1040
+ * String based length that is composed of value and unit in px
1041
+ */
1042
+ Width: string;
1043
+ BackgroundStyle?: FreeFormLayoutElementBackgroundStyle;
1044
+ ElementId: string;
1045
+ /**
1046
+ * String based length that is composed of value and unit in px
1047
+ */
1048
+ XAxisLocation: string;
1049
+ SelectedBorderStyle?: FreeFormLayoutElementBorderStyle;
1050
+ }
1051
+ export interface FreeFormLayoutElementBorderStyle {
1052
+ Color?: string;
1053
+ Visibility?: Visibility;
1054
+ }
1055
+ export interface SheetElementRenderingRule {
1056
+ Expression: string;
1057
+ ConfigurationOverrides: SheetElementConfigurationOverrides;
1058
+ }
1059
+ export interface SheetElementConfigurationOverrides {
1060
+ Visibility?: Visibility;
1061
+ }
1062
+ export interface LoadingAnimation {
1063
+ Visibility?: Visibility;
1064
+ }
1065
+ export interface FreeFormLayoutElementBackgroundStyle {
1066
+ Color?: string;
1067
+ Visibility?: Visibility;
1068
+ }
1069
+ export interface SectionBasedLayoutConfiguration {
1070
+ CanvasSizeOptions: SectionBasedLayoutCanvasSizeOptions;
1071
+ /**
1072
+ * @minItems 0
1073
+ * @maxItems 1
1074
+ */
1075
+ FooterSections: HeaderFooterSectionConfiguration[];
1076
+ /**
1077
+ * @minItems 0
1078
+ * @maxItems 28
1079
+ */
1080
+ BodySections: BodySectionConfiguration[];
1081
+ /**
1082
+ * @minItems 0
1083
+ * @maxItems 1
1084
+ */
1085
+ HeaderSections: HeaderFooterSectionConfiguration[];
1086
+ }
1087
+ export interface HeaderFooterSectionConfiguration {
1088
+ Layout: SectionLayoutConfiguration;
1089
+ Style?: SectionStyle;
1090
+ SectionId: string;
1091
+ }
1092
+ export interface SectionLayoutConfiguration {
1093
+ FreeFormLayout: FreeFormSectionLayoutConfiguration;
1094
+ }
1095
+ export interface FreeFormSectionLayoutConfiguration {
1096
+ /**
1097
+ * @minItems 0
1098
+ * @maxItems 430
1099
+ */
1100
+ Elements: FreeFormLayoutElement[];
1101
+ }
1102
+ export interface SectionStyle {
1103
+ Padding?: Spacing;
1104
+ /**
1105
+ * String based length that is composed of value and unit in px
1106
+ */
1107
+ Height?: string;
1108
+ }
1109
+ export interface BodySectionConfiguration {
1110
+ Content: BodySectionContent;
1111
+ Style?: SectionStyle;
1112
+ PageBreakConfiguration?: SectionPageBreakConfiguration;
1113
+ SectionId: string;
1114
+ }
1115
+ export interface BodySectionContent {
1116
+ Layout?: SectionLayoutConfiguration;
1117
+ }
1118
+ export interface SectionPageBreakConfiguration {
1119
+ After?: SectionAfterPageBreak;
1120
+ }
1121
+ export interface SectionAfterPageBreak {
1122
+ Status?: SectionPageBreakStatus;
1123
+ }
1124
+ export interface FilterControl {
1125
+ Slider?: FilterSliderControl;
1126
+ TextArea?: FilterTextAreaControl;
1127
+ Dropdown?: FilterDropDownControl;
1128
+ TextField?: FilterTextFieldControl;
1129
+ List?: FilterListControl;
1130
+ DateTimePicker?: FilterDateTimePickerControl;
1131
+ RelativeDateTime?: FilterRelativeDateTimeControl;
1132
+ CrossSheet?: FilterCrossSheetControl;
1133
+ }
1134
+ export interface FilterSliderControl {
1135
+ FilterControlId: string;
1136
+ Type?: SheetControlSliderType;
1137
+ StepSize: number;
1138
+ DisplayOptions?: SliderControlDisplayOptions;
1139
+ Title: string;
1140
+ MaximumValue: number;
1141
+ SourceFilterId: string;
1142
+ MinimumValue: number;
1143
+ }
1144
+ export interface FilterTextAreaControl {
1145
+ FilterControlId: string;
1146
+ Delimiter?: string;
1147
+ DisplayOptions?: TextAreaControlDisplayOptions;
1148
+ Title: string;
1149
+ SourceFilterId: string;
1150
+ }
1151
+ export interface FilterDropDownControl {
1152
+ FilterControlId: string;
1153
+ Type?: SheetControlListType;
1154
+ DisplayOptions?: DropDownControlDisplayOptions;
1155
+ CascadingControlConfiguration?: CascadingControlConfiguration;
1156
+ Title: string;
1157
+ CommitMode?: CommitMode;
1158
+ SourceFilterId: string;
1159
+ SelectableValues?: FilterSelectableValues;
1160
+ }
1161
+ export interface FilterTextFieldControl {
1162
+ FilterControlId: string;
1163
+ DisplayOptions?: TextFieldControlDisplayOptions;
1164
+ Title: string;
1165
+ SourceFilterId: string;
1166
+ }
1167
+ export interface FilterListControl {
1168
+ FilterControlId: string;
1169
+ Type?: SheetControlListType;
1170
+ DisplayOptions?: ListControlDisplayOptions;
1171
+ CascadingControlConfiguration?: CascadingControlConfiguration;
1172
+ Title: string;
1173
+ SourceFilterId: string;
1174
+ SelectableValues?: FilterSelectableValues;
1175
+ }
1176
+ export interface FilterDateTimePickerControl {
1177
+ FilterControlId: string;
1178
+ Type?: SheetControlDateTimePickerType;
1179
+ DisplayOptions?: DateTimePickerControlDisplayOptions;
1180
+ Title: string;
1181
+ CommitMode?: CommitMode;
1182
+ SourceFilterId: string;
1183
+ }
1184
+ export interface FilterRelativeDateTimeControl {
1185
+ FilterControlId: string;
1186
+ DisplayOptions?: RelativeDateTimeControlDisplayOptions;
1187
+ Title: string;
1188
+ CommitMode?: CommitMode;
1189
+ SourceFilterId: string;
1190
+ }
1191
+ export interface FilterCrossSheetControl {
1192
+ FilterControlId: string;
1193
+ CascadingControlConfiguration?: CascadingControlConfiguration;
1194
+ SourceFilterId: string;
1195
+ }
1196
+ export interface SheetImage {
1197
+ /**
1198
+ * @minItems 0
1199
+ * @maxItems 10
1200
+ */
1201
+ Actions?: ImageCustomAction[];
1202
+ SheetImageId: string;
1203
+ Tooltip?: SheetImageTooltipConfiguration;
1204
+ Scaling?: SheetImageScalingConfiguration;
1205
+ Interactions?: ImageInteractionOptions;
1206
+ Source: SheetImageSource;
1207
+ ImageContentAltText?: string;
1208
+ }
1209
+ export interface ImageCustomAction {
1210
+ Status?: WidgetStatus;
1211
+ Trigger: ImageCustomActionTrigger;
1212
+ CustomActionId: string;
1213
+ Name: string;
1214
+ /**
1215
+ * @minItems 1
1216
+ * @maxItems 2
1217
+ */
1218
+ ActionOperations: ImageCustomActionOperation[];
1219
+ }
1220
+ export interface ImageCustomActionOperation {
1221
+ NavigationOperation?: CustomActionNavigationOperation;
1222
+ SetParametersOperation?: CustomActionSetParametersOperation;
1223
+ URLOperation?: CustomActionURLOperation;
1224
+ }
1225
+ export interface CustomActionNavigationOperation {
1226
+ LocalNavigationConfiguration?: LocalNavigationConfiguration;
1227
+ }
1228
+ export interface LocalNavigationConfiguration {
1229
+ TargetSheetId: string;
1230
+ }
1231
+ export interface CustomActionSetParametersOperation {
1232
+ /**
1233
+ * @minItems 1
1234
+ * @maxItems 200
1235
+ */
1236
+ ParameterValueConfigurations: SetParameterValueConfiguration[];
1237
+ }
1238
+ export interface SetParameterValueConfiguration {
1239
+ DestinationParameterName: string;
1240
+ Value: DestinationParameterValueConfiguration;
1241
+ }
1242
+ export interface DestinationParameterValueConfiguration {
1243
+ CustomValuesConfiguration?: CustomValuesConfiguration;
1244
+ SourceParameterName?: string;
1245
+ SelectAllValueOptions?: SelectAllValueOptions;
1246
+ SourceField?: string;
1247
+ SourceColumn?: ColumnIdentifier;
1248
+ }
1249
+ export interface CustomValuesConfiguration {
1250
+ IncludeNullValue?: boolean;
1251
+ CustomValues: CustomParameterValues;
1252
+ }
1253
+ export interface CustomParameterValues {
1254
+ /**
1255
+ * @minItems 0
1256
+ * @maxItems 50000
1257
+ */
1258
+ DecimalValues?: number[];
1259
+ /**
1260
+ * @minItems 0
1261
+ * @maxItems 50000
1262
+ */
1263
+ IntegerValues?: number[];
1264
+ /**
1265
+ * @minItems 0
1266
+ * @maxItems 50000
1267
+ */
1268
+ StringValues?: string[];
1269
+ /**
1270
+ * @minItems 0
1271
+ * @maxItems 50000
1272
+ */
1273
+ DateTimeValues?: string[];
1274
+ }
1275
+ export interface CustomActionURLOperation {
1276
+ URLTemplate: string;
1277
+ URLTarget: URLTargetConfiguration;
1278
+ }
1279
+ export interface SheetImageTooltipConfiguration {
1280
+ Visibility?: Visibility;
1281
+ TooltipText?: SheetImageTooltipText;
1282
+ }
1283
+ export interface SheetImageTooltipText {
1284
+ PlainText?: string;
1285
+ }
1286
+ export interface SheetImageScalingConfiguration {
1287
+ ScalingType?: SheetImageScalingType;
1288
+ }
1289
+ export interface ImageInteractionOptions {
1290
+ ImageMenuOption?: ImageMenuOption;
1291
+ }
1292
+ export interface ImageMenuOption {
1293
+ AvailabilityStatus?: DashboardBehavior;
1294
+ }
1295
+ export interface SheetImageSource {
1296
+ SheetImageStaticFileSource?: SheetImageStaticFileSource;
1297
+ }
1298
+ export interface SheetImageStaticFileSource {
1299
+ StaticFileId: string;
1300
+ }
1301
+ export interface SheetControlLayout {
1302
+ Configuration: SheetControlLayoutConfiguration;
1303
+ }
1304
+ export interface SheetControlLayoutConfiguration {
1305
+ GridLayout?: GridLayoutConfiguration;
1306
+ }
1307
+ export interface Visual {
1308
+ FunnelChartVisual?: FunnelChartVisual;
1309
+ BoxPlotVisual?: BoxPlotVisual;
1310
+ LayerMapVisual?: LayerMapVisual;
1311
+ GeospatialMapVisual?: GeospatialMapVisual;
1312
+ ScatterPlotVisual?: ScatterPlotVisual;
1313
+ RadarChartVisual?: RadarChartVisual;
1314
+ ComboChartVisual?: ComboChartVisual;
1315
+ WordCloudVisual?: WordCloudVisual;
1316
+ SankeyDiagramVisual?: SankeyDiagramVisual;
1317
+ GaugeChartVisual?: GaugeChartVisual;
1318
+ FilledMapVisual?: FilledMapVisual;
1319
+ WaterfallVisual?: WaterfallVisual;
1320
+ CustomContentVisual?: CustomContentVisual;
1321
+ PieChartVisual?: PieChartVisual;
1322
+ KPIVisual?: KPIVisual;
1323
+ HistogramVisual?: HistogramVisual;
1324
+ PluginVisual?: PluginVisual;
1325
+ TableVisual?: TableVisual;
1326
+ PivotTableVisual?: PivotTableVisual;
1327
+ BarChartVisual?: BarChartVisual;
1328
+ HeatMapVisual?: HeatMapVisual;
1329
+ TreeMapVisual?: TreeMapVisual;
1330
+ InsightVisual?: InsightVisual;
1331
+ LineChartVisual?: LineChartVisual;
1332
+ EmptyVisual?: EmptyVisual;
1333
+ }
1334
+ export interface FunnelChartVisual {
1335
+ Subtitle?: VisualSubtitleLabelOptions;
1336
+ VisualId: string;
1337
+ ChartConfiguration?: FunnelChartConfiguration;
1338
+ /**
1339
+ * @minItems 0
1340
+ * @maxItems 10
1341
+ */
1342
+ Actions?: VisualCustomAction[];
1343
+ Title?: VisualTitleLabelOptions;
1344
+ VisualContentAltText?: string;
1345
+ /**
1346
+ * @minItems 0
1347
+ * @maxItems 2
1348
+ */
1349
+ ColumnHierarchies?: ColumnHierarchy[];
1350
+ }
1351
+ export interface VisualSubtitleLabelOptions {
1352
+ Visibility?: Visibility;
1353
+ FormatText?: LongFormatText;
1354
+ }
1355
+ export interface LongFormatText {
1356
+ RichText?: string;
1357
+ PlainText?: string;
1358
+ }
1359
+ export interface FunnelChartConfiguration {
1360
+ SortConfiguration?: FunnelChartSortConfiguration;
1361
+ DataLabelOptions?: FunnelChartDataLabelOptions;
1362
+ CategoryLabelOptions?: ChartAxisLabelOptions;
1363
+ FieldWells?: FunnelChartFieldWells;
1364
+ Tooltip?: TooltipOptions;
1365
+ ValueLabelOptions?: ChartAxisLabelOptions;
1366
+ VisualPalette?: VisualPalette;
1367
+ }
1368
+ export interface FunnelChartSortConfiguration {
1369
+ CategoryItemsLimit?: ItemsLimitConfiguration;
1370
+ /**
1371
+ * @minItems 0
1372
+ * @maxItems 100
1373
+ */
1374
+ CategorySort?: FieldSortOptions[];
1375
+ }
1376
+ export interface ItemsLimitConfiguration {
1377
+ ItemsLimit?: number;
1378
+ OtherCategories?: OtherCategories;
1379
+ }
1380
+ export interface FieldSortOptions {
1381
+ FieldSort?: FieldSort;
1382
+ ColumnSort?: ColumnSort;
1383
+ }
1384
+ export interface FieldSort {
1385
+ FieldId: string;
1386
+ Direction: SortDirection;
1387
+ }
1388
+ export interface ColumnSort {
1389
+ AggregationFunction?: AggregationFunction;
1390
+ SortBy: ColumnIdentifier;
1391
+ Direction: SortDirection;
1392
+ }
1393
+ export interface FunnelChartDataLabelOptions {
1394
+ MeasureLabelVisibility?: Visibility;
1395
+ Position?: DataLabelPosition;
1396
+ Visibility?: Visibility;
1397
+ CategoryLabelVisibility?: Visibility;
1398
+ LabelColor?: string;
1399
+ MeasureDataLabelStyle?: FunnelChartMeasureDataLabelStyle;
1400
+ LabelFontConfiguration?: FontConfiguration;
1401
+ }
1402
+ export interface ChartAxisLabelOptions {
1403
+ Visibility?: Visibility;
1404
+ SortIconVisibility?: Visibility;
1405
+ /**
1406
+ * @minItems 0
1407
+ * @maxItems 100
1408
+ */
1409
+ AxisLabelOptions?: AxisLabelOptions[];
1410
+ }
1411
+ export interface AxisLabelOptions {
1412
+ CustomLabel?: string;
1413
+ ApplyTo?: AxisLabelReferenceOptions;
1414
+ FontConfiguration?: FontConfiguration;
1415
+ }
1416
+ export interface AxisLabelReferenceOptions {
1417
+ Column: ColumnIdentifier;
1418
+ FieldId: string;
1419
+ }
1420
+ export interface FunnelChartFieldWells {
1421
+ FunnelChartAggregatedFieldWells?: FunnelChartAggregatedFieldWells;
1422
+ }
1423
+ export interface FunnelChartAggregatedFieldWells {
1424
+ /**
1425
+ * @minItems 0
1426
+ * @maxItems 1
1427
+ */
1428
+ Category?: DimensionField[];
1429
+ /**
1430
+ * @minItems 0
1431
+ * @maxItems 1
1432
+ */
1433
+ Values?: MeasureField[];
1434
+ }
1435
+ export interface DimensionField {
1436
+ DateDimensionField?: DateDimensionField;
1437
+ NumericalDimensionField?: NumericalDimensionField;
1438
+ CategoricalDimensionField?: CategoricalDimensionField;
1439
+ }
1440
+ export interface DateDimensionField {
1441
+ HierarchyId?: string;
1442
+ FormatConfiguration?: DateTimeFormatConfiguration;
1443
+ Column: ColumnIdentifier;
1444
+ FieldId: string;
1445
+ DateGranularity?: TimeGranularity;
1446
+ }
1447
+ export interface NumericalDimensionField {
1448
+ HierarchyId?: string;
1449
+ FormatConfiguration?: NumberFormatConfiguration;
1450
+ Column: ColumnIdentifier;
1451
+ FieldId: string;
1452
+ }
1453
+ export interface CategoricalDimensionField {
1454
+ HierarchyId?: string;
1455
+ FormatConfiguration?: StringFormatConfiguration;
1456
+ Column: ColumnIdentifier;
1457
+ FieldId: string;
1458
+ }
1459
+ export interface MeasureField {
1460
+ DateMeasureField?: DateMeasureField;
1461
+ NumericalMeasureField?: NumericalMeasureField;
1462
+ CategoricalMeasureField?: CategoricalMeasureField;
1463
+ CalculatedMeasureField?: CalculatedMeasureField;
1464
+ }
1465
+ export interface DateMeasureField {
1466
+ AggregationFunction?: DateAggregationFunction;
1467
+ FormatConfiguration?: DateTimeFormatConfiguration;
1468
+ Column: ColumnIdentifier;
1469
+ FieldId: string;
1470
+ }
1471
+ export interface NumericalMeasureField {
1472
+ AggregationFunction?: NumericalAggregationFunction;
1473
+ FormatConfiguration?: NumberFormatConfiguration;
1474
+ Column: ColumnIdentifier;
1475
+ FieldId: string;
1476
+ }
1477
+ export interface CategoricalMeasureField {
1478
+ AggregationFunction?: CategoricalAggregationFunction;
1479
+ FormatConfiguration?: StringFormatConfiguration;
1480
+ Column: ColumnIdentifier;
1481
+ FieldId: string;
1482
+ }
1483
+ export interface CalculatedMeasureField {
1484
+ Expression: string;
1485
+ FieldId: string;
1486
+ }
1487
+ export interface TooltipOptions {
1488
+ SelectedTooltipType?: SelectedTooltipType;
1489
+ TooltipVisibility?: Visibility;
1490
+ FieldBasedTooltip?: FieldBasedTooltip;
1491
+ }
1492
+ export interface FieldBasedTooltip {
1493
+ /**
1494
+ * @minItems 0
1495
+ * @maxItems 100
1496
+ */
1497
+ TooltipFields?: TooltipItem[];
1498
+ AggregationVisibility?: Visibility;
1499
+ TooltipTitleType?: TooltipTitleType;
1500
+ }
1501
+ export interface TooltipItem {
1502
+ FieldTooltipItem?: FieldTooltipItem;
1503
+ ColumnTooltipItem?: ColumnTooltipItem;
1504
+ }
1505
+ export interface FieldTooltipItem {
1506
+ TooltipTarget?: TooltipTarget;
1507
+ FieldId: string;
1508
+ Label?: string;
1509
+ Visibility?: Visibility;
1510
+ }
1511
+ export interface ColumnTooltipItem {
1512
+ Aggregation?: AggregationFunction;
1513
+ TooltipTarget?: TooltipTarget;
1514
+ Column: ColumnIdentifier;
1515
+ Label?: string;
1516
+ Visibility?: Visibility;
1517
+ }
1518
+ export interface VisualPalette {
1519
+ ChartColor?: string;
1520
+ /**
1521
+ * @minItems 0
1522
+ * @maxItems 5000
1523
+ */
1524
+ ColorMap?: DataPathColor[];
1525
+ }
1526
+ export interface DataPathColor {
1527
+ Element: DataPathValue;
1528
+ Color: string;
1529
+ TimeGranularity?: TimeGranularity;
1530
+ }
1531
+ export interface DataPathValue {
1532
+ DataPathType?: DataPathType;
1533
+ FieldId?: string;
1534
+ FieldValue?: string;
1535
+ }
1536
+ export interface DataPathType {
1537
+ PivotTableDataPathType?: PivotTableDataPathType;
1538
+ }
1539
+ export interface VisualCustomAction {
1540
+ Status?: WidgetStatus;
1541
+ Trigger: VisualCustomActionTrigger;
1542
+ CustomActionId: string;
1543
+ Name: string;
1544
+ /**
1545
+ * @minItems 1
1546
+ * @maxItems 2
1547
+ */
1548
+ ActionOperations: VisualCustomActionOperation[];
1549
+ }
1550
+ export interface VisualCustomActionOperation {
1551
+ NavigationOperation?: CustomActionNavigationOperation;
1552
+ SetParametersOperation?: CustomActionSetParametersOperation;
1553
+ FilterOperation?: CustomActionFilterOperation;
1554
+ URLOperation?: CustomActionURLOperation;
1555
+ }
1556
+ export interface CustomActionFilterOperation {
1557
+ SelectedFieldsConfiguration: FilterOperationSelectedFieldsConfiguration;
1558
+ TargetVisualsConfiguration: FilterOperationTargetVisualsConfiguration;
1559
+ }
1560
+ export interface FilterOperationSelectedFieldsConfiguration {
1561
+ /**
1562
+ * <p>The selected columns of a dataset.</p>
1563
+ *
1564
+ * @minItems 0
1565
+ * @maxItems 10
1566
+ */
1567
+ SelectedColumns?: ColumnIdentifier[];
1568
+ /**
1569
+ * @minItems 1
1570
+ * @maxItems 20
1571
+ */
1572
+ SelectedFields?: string[];
1573
+ SelectedFieldOptions?: SelectedFieldOptions;
1574
+ }
1575
+ export interface FilterOperationTargetVisualsConfiguration {
1576
+ SameSheetTargetVisualConfiguration?: SameSheetTargetVisualConfiguration;
1577
+ }
1578
+ export interface SameSheetTargetVisualConfiguration {
1579
+ TargetVisualOptions?: TargetVisualOptions;
1580
+ /**
1581
+ * @minItems 1
1582
+ * @maxItems 50
1583
+ */
1584
+ TargetVisuals?: string[];
1585
+ }
1586
+ export interface VisualTitleLabelOptions {
1587
+ Visibility?: Visibility;
1588
+ FormatText?: ShortFormatText;
1589
+ }
1590
+ export interface ShortFormatText {
1591
+ RichText?: string;
1592
+ PlainText?: string;
1593
+ }
1594
+ export interface ColumnHierarchy {
1595
+ DateTimeHierarchy?: DateTimeHierarchy;
1596
+ ExplicitHierarchy?: ExplicitHierarchy;
1597
+ PredefinedHierarchy?: PredefinedHierarchy;
1598
+ }
1599
+ export interface DateTimeHierarchy {
1600
+ HierarchyId: string;
1601
+ /**
1602
+ * @minItems 0
1603
+ * @maxItems 10
1604
+ */
1605
+ DrillDownFilters?: DrillDownFilter[];
1606
+ }
1607
+ export interface DrillDownFilter {
1608
+ NumericEqualityFilter?: NumericEqualityDrillDownFilter;
1609
+ TimeRangeFilter?: TimeRangeDrillDownFilter;
1610
+ CategoryFilter?: CategoryDrillDownFilter;
1611
+ }
1612
+ export interface NumericEqualityDrillDownFilter {
1613
+ Column: ColumnIdentifier;
1614
+ Value: number;
1615
+ }
1616
+ export interface TimeRangeDrillDownFilter {
1617
+ Column: ColumnIdentifier;
1618
+ RangeMinimum: string;
1619
+ TimeGranularity: TimeGranularity;
1620
+ RangeMaximum: string;
1621
+ }
1622
+ export interface CategoryDrillDownFilter {
1623
+ Column: ColumnIdentifier;
1624
+ /**
1625
+ * @minItems 0
1626
+ * @maxItems 100000
1627
+ */
1628
+ CategoryValues: string[];
1629
+ }
1630
+ export interface ExplicitHierarchy {
1631
+ HierarchyId: string;
1632
+ /**
1633
+ * @minItems 0
1634
+ * @maxItems 10
1635
+ */
1636
+ DrillDownFilters?: DrillDownFilter[];
1637
+ /**
1638
+ * @minItems 2
1639
+ * @maxItems 10
1640
+ */
1641
+ Columns: ColumnIdentifier[];
1642
+ }
1643
+ export interface PredefinedHierarchy {
1644
+ HierarchyId: string;
1645
+ /**
1646
+ * @minItems 0
1647
+ * @maxItems 10
1648
+ */
1649
+ DrillDownFilters?: DrillDownFilter[];
1650
+ /**
1651
+ * @minItems 1
1652
+ * @maxItems 10
1653
+ */
1654
+ Columns: ColumnIdentifier[];
1655
+ }
1656
+ export interface BoxPlotVisual {
1657
+ Subtitle?: VisualSubtitleLabelOptions;
1658
+ VisualId: string;
1659
+ ChartConfiguration?: BoxPlotChartConfiguration;
1660
+ /**
1661
+ * @minItems 0
1662
+ * @maxItems 10
1663
+ */
1664
+ Actions?: VisualCustomAction[];
1665
+ Title?: VisualTitleLabelOptions;
1666
+ VisualContentAltText?: string;
1667
+ /**
1668
+ * @minItems 0
1669
+ * @maxItems 2
1670
+ */
1671
+ ColumnHierarchies?: ColumnHierarchy[];
1672
+ }
1673
+ export interface BoxPlotChartConfiguration {
1674
+ SortConfiguration?: BoxPlotSortConfiguration;
1675
+ Legend?: LegendOptions;
1676
+ /**
1677
+ * @minItems 0
1678
+ * @maxItems 20
1679
+ */
1680
+ ReferenceLines?: ReferenceLine[];
1681
+ CategoryAxis?: AxisDisplayOptions;
1682
+ PrimaryYAxisLabelOptions?: ChartAxisLabelOptions;
1683
+ CategoryLabelOptions?: ChartAxisLabelOptions;
1684
+ FieldWells?: BoxPlotFieldWells;
1685
+ Tooltip?: TooltipOptions;
1686
+ BoxPlotOptions?: BoxPlotOptions;
1687
+ PrimaryYAxisDisplayOptions?: AxisDisplayOptions;
1688
+ VisualPalette?: VisualPalette;
1689
+ }
1690
+ export interface BoxPlotSortConfiguration {
1691
+ /**
1692
+ * @minItems 0
1693
+ * @maxItems 100
1694
+ */
1695
+ CategorySort?: FieldSortOptions[];
1696
+ PaginationConfiguration?: PaginationConfiguration;
1697
+ }
1698
+ export interface PaginationConfiguration {
1699
+ PageSize: number;
1700
+ PageNumber: number;
1701
+ }
1702
+ export interface LegendOptions {
1703
+ Position?: LegendPosition;
1704
+ ValueFontConfiguration?: FontConfiguration;
1705
+ Title?: LabelOptions;
1706
+ Visibility?: Visibility;
1707
+ /**
1708
+ * String based length that is composed of value and unit in px
1709
+ */
1710
+ Height?: string;
1711
+ /**
1712
+ * String based length that is composed of value and unit in px
1713
+ */
1714
+ Width?: string;
1715
+ }
1716
+ export interface ReferenceLine {
1717
+ Status?: WidgetStatus;
1718
+ DataConfiguration: ReferenceLineDataConfiguration;
1719
+ LabelConfiguration?: ReferenceLineLabelConfiguration;
1720
+ StyleConfiguration?: ReferenceLineStyleConfiguration;
1721
+ }
1722
+ export interface ReferenceLineDataConfiguration {
1723
+ DynamicConfiguration?: ReferenceLineDynamicDataConfiguration;
1724
+ AxisBinding?: AxisBinding;
1725
+ SeriesType?: ReferenceLineSeriesType;
1726
+ StaticConfiguration?: ReferenceLineStaticDataConfiguration;
1727
+ }
1728
+ export interface ReferenceLineDynamicDataConfiguration {
1729
+ Column: ColumnIdentifier;
1730
+ MeasureAggregationFunction?: AggregationFunction;
1731
+ Calculation: NumericalAggregationFunction;
1732
+ }
1733
+ export interface ReferenceLineStaticDataConfiguration {
1734
+ Value: number;
1735
+ }
1736
+ export interface ReferenceLineLabelConfiguration {
1737
+ HorizontalPosition?: ReferenceLineLabelHorizontalPosition;
1738
+ ValueLabelConfiguration?: ReferenceLineValueLabelConfiguration;
1739
+ CustomLabelConfiguration?: ReferenceLineCustomLabelConfiguration;
1740
+ FontColor?: string;
1741
+ FontConfiguration?: FontConfiguration;
1742
+ VerticalPosition?: ReferenceLineLabelVerticalPosition;
1743
+ }
1744
+ export interface ReferenceLineValueLabelConfiguration {
1745
+ FormatConfiguration?: NumericFormatConfiguration;
1746
+ RelativePosition?: ReferenceLineValueLabelRelativePosition;
1747
+ }
1748
+ export interface ReferenceLineCustomLabelConfiguration {
1749
+ CustomLabel: string;
1750
+ }
1751
+ export interface ReferenceLineStyleConfiguration {
1752
+ Pattern?: ReferenceLinePatternType;
1753
+ Color?: string;
1754
+ }
1755
+ export interface AxisDisplayOptions {
1756
+ DataOptions?: AxisDataOptions;
1757
+ TickLabelOptions?: AxisTickLabelOptions;
1758
+ /**
1759
+ * String based length that is composed of value and unit in px
1760
+ */
1761
+ AxisOffset?: string;
1762
+ AxisLineVisibility?: Visibility;
1763
+ GridLineVisibility?: Visibility;
1764
+ ScrollbarOptions?: ScrollBarOptions;
1765
+ }
1766
+ export interface AxisDataOptions {
1767
+ DateAxisOptions?: DateAxisOptions;
1768
+ NumericAxisOptions?: NumericAxisOptions;
1769
+ }
1770
+ export interface DateAxisOptions {
1771
+ MissingDateVisibility?: Visibility;
1772
+ }
1773
+ export interface NumericAxisOptions {
1774
+ Scale?: AxisScale;
1775
+ Range?: AxisDisplayRange;
1776
+ }
1777
+ export interface AxisScale {
1778
+ Logarithmic?: AxisLogarithmicScale;
1779
+ Linear?: AxisLinearScale;
1780
+ }
1781
+ export interface AxisLogarithmicScale {
1782
+ Base?: number;
1783
+ }
1784
+ export interface AxisLinearScale {
1785
+ StepSize?: number;
1786
+ StepCount?: number;
1787
+ }
1788
+ export interface AxisDisplayRange {
1789
+ DataDriven?: AxisDisplayDataDrivenRange;
1790
+ MinMax?: AxisDisplayMinMaxRange;
1791
+ }
1792
+ export interface AxisDisplayDataDrivenRange {
1793
+ }
1794
+ export interface AxisDisplayMinMaxRange {
1795
+ Minimum?: number;
1796
+ Maximum?: number;
1797
+ }
1798
+ export interface AxisTickLabelOptions {
1799
+ RotationAngle?: number;
1800
+ LabelOptions?: LabelOptions;
1801
+ }
1802
+ export interface ScrollBarOptions {
1803
+ VisibleRange?: VisibleRangeOptions;
1804
+ Visibility?: Visibility;
1805
+ }
1806
+ export interface VisibleRangeOptions {
1807
+ PercentRange?: PercentVisibleRange;
1808
+ }
1809
+ export interface PercentVisibleRange {
1810
+ From?: number;
1811
+ To?: number;
1812
+ }
1813
+ export interface BoxPlotFieldWells {
1814
+ BoxPlotAggregatedFieldWells?: BoxPlotAggregatedFieldWells;
1815
+ }
1816
+ export interface BoxPlotAggregatedFieldWells {
1817
+ /**
1818
+ * @minItems 0
1819
+ * @maxItems 1
1820
+ */
1821
+ GroupBy?: DimensionField[];
1822
+ /**
1823
+ * @minItems 0
1824
+ * @maxItems 5
1825
+ */
1826
+ Values?: MeasureField[];
1827
+ }
1828
+ export interface BoxPlotOptions {
1829
+ StyleOptions?: BoxPlotStyleOptions;
1830
+ OutlierVisibility?: Visibility;
1831
+ AllDataPointsVisibility?: Visibility;
1832
+ }
1833
+ export interface BoxPlotStyleOptions {
1834
+ FillStyle?: BoxPlotFillStyle;
1835
+ }
1836
+ export interface LayerMapVisual {
1837
+ Subtitle?: VisualSubtitleLabelOptions;
1838
+ VisualId: string;
1839
+ ChartConfiguration?: GeospatialLayerMapConfiguration;
1840
+ DataSetIdentifier: string;
1841
+ Title?: VisualTitleLabelOptions;
1842
+ VisualContentAltText?: string;
1843
+ }
1844
+ export interface GeospatialLayerMapConfiguration {
1845
+ Legend?: LegendOptions;
1846
+ MapState?: GeospatialMapState;
1847
+ MapStyle?: GeospatialMapStyle;
1848
+ Interactions?: unknown;
1849
+ MapLayers?: GeospatialLayerItem[];
1850
+ }
1851
+ export interface GeospatialMapState {
1852
+ Bounds?: GeospatialCoordinateBounds;
1853
+ MapNavigation?: GeospatialMapNavigation;
1854
+ }
1855
+ export interface GeospatialCoordinateBounds {
1856
+ West: number;
1857
+ South: number;
1858
+ North: number;
1859
+ East: number;
1860
+ }
1861
+ export interface GeospatialMapStyle {
1862
+ BaseMapStyle?: BaseMapStyleType;
1863
+ BaseMapVisibility?: Visibility;
1864
+ BackgroundColor?: string;
1865
+ }
1866
+ export interface GeospatialLayerItem {
1867
+ LayerId: string;
1868
+ JoinDefinition?: GeospatialLayerJoinDefinition;
1869
+ /**
1870
+ * @minItems 0
1871
+ * @maxItems 10
1872
+ */
1873
+ Actions?: LayerCustomAction[];
1874
+ LayerType?: GeospatialLayerType;
1875
+ LayerDefinition?: GeospatialLayerDefinition;
1876
+ Tooltip?: TooltipOptions;
1877
+ Label?: string;
1878
+ Visibility?: Visibility;
1879
+ DataSource?: GeospatialDataSourceItem;
1880
+ }
1881
+ export interface GeospatialLayerJoinDefinition {
1882
+ ColorField?: GeospatialLayerColorField;
1883
+ ShapeKeyField?: string;
1884
+ DatasetKeyField?: UnaggregatedField;
1885
+ }
1886
+ export interface GeospatialLayerColorField {
1887
+ /**
1888
+ * @minItems 0
1889
+ * @maxItems 1
1890
+ */
1891
+ ColorValuesFields?: MeasureField[];
1892
+ /**
1893
+ * @minItems 0
1894
+ * @maxItems 1
1895
+ */
1896
+ ColorDimensionsFields?: DimensionField[];
1897
+ }
1898
+ export interface UnaggregatedField {
1899
+ FormatConfiguration?: FormatConfiguration;
1900
+ Column: ColumnIdentifier;
1901
+ FieldId: string;
1902
+ }
1903
+ export interface LayerCustomAction {
1904
+ Status?: WidgetStatus;
1905
+ Trigger: LayerCustomActionTrigger;
1906
+ CustomActionId: string;
1907
+ Name: string;
1908
+ /**
1909
+ * @minItems 1
1910
+ * @maxItems 2
1911
+ */
1912
+ ActionOperations: LayerCustomActionOperation[];
1913
+ }
1914
+ export interface LayerCustomActionOperation {
1915
+ NavigationOperation?: CustomActionNavigationOperation;
1916
+ SetParametersOperation?: CustomActionSetParametersOperation;
1917
+ FilterOperation?: CustomActionFilterOperation;
1918
+ URLOperation?: CustomActionURLOperation;
1919
+ }
1920
+ export interface GeospatialLayerDefinition {
1921
+ PointLayer?: GeospatialPointLayer;
1922
+ PolygonLayer?: GeospatialPolygonLayer;
1923
+ LineLayer?: GeospatialLineLayer;
1924
+ }
1925
+ export interface GeospatialPointLayer {
1926
+ Style: GeospatialPointStyle;
1927
+ }
1928
+ export interface GeospatialPointStyle {
1929
+ CircleSymbolStyle?: GeospatialCircleSymbolStyle;
1930
+ }
1931
+ export interface GeospatialCircleSymbolStyle {
1932
+ FillColor?: GeospatialColor;
1933
+ StrokeWidth?: GeospatialLineWidth;
1934
+ StrokeColor?: GeospatialColor;
1935
+ CircleRadius?: GeospatialCircleRadius;
1936
+ }
1937
+ export interface GeospatialColor {
1938
+ Gradient?: GeospatialGradientColor;
1939
+ Categorical?: GeospatialCategoricalColor;
1940
+ Solid?: GeospatialSolidColor;
1941
+ }
1942
+ export interface GeospatialGradientColor {
1943
+ DefaultOpacity?: number;
1944
+ /**
1945
+ * @minItems 2
1946
+ * @maxItems 3
1947
+ */
1948
+ StepColors: GeospatialGradientStepColor[];
1949
+ NullDataVisibility?: Visibility;
1950
+ NullDataSettings?: GeospatialNullDataSettings;
1951
+ }
1952
+ export interface GeospatialGradientStepColor {
1953
+ DataValue: number;
1954
+ Color: string;
1955
+ }
1956
+ export interface GeospatialNullDataSettings {
1957
+ SymbolStyle: GeospatialNullSymbolStyle;
1958
+ }
1959
+ export interface GeospatialNullSymbolStyle {
1960
+ FillColor?: string;
1961
+ StrokeWidth?: number;
1962
+ StrokeColor?: string;
1963
+ }
1964
+ export interface GeospatialCategoricalColor {
1965
+ CategoryDataColors: GeospatialCategoricalDataColor[];
1966
+ DefaultOpacity?: number;
1967
+ NullDataVisibility?: Visibility;
1968
+ NullDataSettings?: GeospatialNullDataSettings;
1969
+ }
1970
+ export interface GeospatialCategoricalDataColor {
1971
+ DataValue: string;
1972
+ Color: string;
1973
+ }
1974
+ /**
1975
+ * Describes the properties for a solid color
1976
+ */
1977
+ export interface GeospatialSolidColor {
1978
+ State?: GeospatialColorState;
1979
+ Color: string;
1980
+ }
1981
+ export interface GeospatialLineWidth {
1982
+ LineWidth?: number;
1983
+ }
1984
+ export interface GeospatialCircleRadius {
1985
+ Radius?: number;
1986
+ }
1987
+ export interface GeospatialPolygonLayer {
1988
+ Style: GeospatialPolygonStyle;
1989
+ }
1990
+ export interface GeospatialPolygonStyle {
1991
+ PolygonSymbolStyle?: GeospatialPolygonSymbolStyle;
1992
+ }
1993
+ export interface GeospatialPolygonSymbolStyle {
1994
+ FillColor?: GeospatialColor;
1995
+ StrokeWidth?: GeospatialLineWidth;
1996
+ StrokeColor?: GeospatialColor;
1997
+ }
1998
+ export interface GeospatialLineLayer {
1999
+ Style: GeospatialLineStyle;
2000
+ }
2001
+ export interface GeospatialLineStyle {
2002
+ LineSymbolStyle?: GeospatialLineSymbolStyle;
2003
+ }
2004
+ export interface GeospatialLineSymbolStyle {
2005
+ FillColor?: GeospatialColor;
2006
+ LineWidth?: GeospatialLineWidth;
2007
+ }
2008
+ export interface GeospatialDataSourceItem {
2009
+ StaticFileDataSource?: GeospatialStaticFileSource;
2010
+ }
2011
+ export interface GeospatialStaticFileSource {
2012
+ StaticFileId: string;
2013
+ }
2014
+ export interface GeospatialMapVisual {
2015
+ Subtitle?: VisualSubtitleLabelOptions;
2016
+ VisualId: string;
2017
+ ChartConfiguration?: GeospatialMapConfiguration;
2018
+ /**
2019
+ * @minItems 0
2020
+ * @maxItems 10
2021
+ */
2022
+ Actions?: VisualCustomAction[];
2023
+ Title?: VisualTitleLabelOptions;
2024
+ VisualContentAltText?: string;
2025
+ /**
2026
+ * @minItems 0
2027
+ * @maxItems 2
2028
+ */
2029
+ ColumnHierarchies?: ColumnHierarchy[];
2030
+ }
2031
+ export interface GeospatialMapConfiguration {
2032
+ Legend?: LegendOptions;
2033
+ MapStyleOptions?: GeospatialMapStyleOptions;
2034
+ FieldWells?: GeospatialMapFieldWells;
2035
+ Tooltip?: TooltipOptions;
2036
+ Interactions?: unknown;
2037
+ WindowOptions?: GeospatialWindowOptions;
2038
+ PointStyleOptions?: GeospatialPointStyleOptions;
2039
+ VisualPalette?: VisualPalette;
2040
+ }
2041
+ export interface GeospatialMapStyleOptions {
2042
+ BaseMapStyle?: BaseMapStyleType;
2043
+ }
2044
+ export interface GeospatialMapFieldWells {
2045
+ GeospatialMapAggregatedFieldWells?: GeospatialMapAggregatedFieldWells;
2046
+ }
2047
+ export interface GeospatialMapAggregatedFieldWells {
2048
+ /**
2049
+ * @minItems 0
2050
+ * @maxItems 200
2051
+ */
2052
+ Colors?: DimensionField[];
2053
+ /**
2054
+ * @minItems 0
2055
+ * @maxItems 200
2056
+ */
2057
+ Values?: MeasureField[];
2058
+ /**
2059
+ * @minItems 0
2060
+ * @maxItems 200
2061
+ */
2062
+ Geospatial?: DimensionField[];
2063
+ }
2064
+ export interface GeospatialWindowOptions {
2065
+ Bounds?: GeospatialCoordinateBounds;
2066
+ MapZoomMode?: MapZoomMode;
2067
+ }
2068
+ export interface GeospatialPointStyleOptions {
2069
+ SelectedPointStyle?: GeospatialSelectedPointStyle;
2070
+ ClusterMarkerConfiguration?: ClusterMarkerConfiguration;
2071
+ HeatmapConfiguration?: GeospatialHeatmapConfiguration;
2072
+ }
2073
+ export interface ClusterMarkerConfiguration {
2074
+ ClusterMarker?: ClusterMarker;
2075
+ }
2076
+ export interface ClusterMarker {
2077
+ SimpleClusterMarker?: SimpleClusterMarker;
2078
+ }
2079
+ export interface SimpleClusterMarker {
2080
+ Color?: string;
2081
+ }
2082
+ export interface GeospatialHeatmapConfiguration {
2083
+ HeatmapColor?: GeospatialHeatmapColorScale;
2084
+ }
2085
+ export interface GeospatialHeatmapColorScale {
2086
+ /**
2087
+ * @minItems 2
2088
+ * @maxItems 2
2089
+ */
2090
+ Colors?: GeospatialHeatmapDataColor[];
2091
+ }
2092
+ export interface GeospatialHeatmapDataColor {
2093
+ Color: string;
2094
+ }
2095
+ export interface ScatterPlotVisual {
2096
+ Subtitle?: VisualSubtitleLabelOptions;
2097
+ VisualId: string;
2098
+ ChartConfiguration?: ScatterPlotConfiguration;
2099
+ /**
2100
+ * @minItems 0
2101
+ * @maxItems 10
2102
+ */
2103
+ Actions?: VisualCustomAction[];
2104
+ Title?: VisualTitleLabelOptions;
2105
+ VisualContentAltText?: string;
2106
+ /**
2107
+ * @minItems 0
2108
+ * @maxItems 2
2109
+ */
2110
+ ColumnHierarchies?: ColumnHierarchy[];
2111
+ }
2112
+ export interface ScatterPlotConfiguration {
2113
+ YAxisLabelOptions?: ChartAxisLabelOptions;
2114
+ Legend?: LegendOptions;
2115
+ YAxisDisplayOptions?: AxisDisplayOptions;
2116
+ DataLabels?: DataLabelOptions;
2117
+ FieldWells?: ScatterPlotFieldWells;
2118
+ Tooltip?: TooltipOptions;
2119
+ XAxisLabelOptions?: ChartAxisLabelOptions;
2120
+ VisualPalette?: VisualPalette;
2121
+ XAxisDisplayOptions?: AxisDisplayOptions;
2122
+ }
2123
+ export interface DataLabelOptions {
2124
+ /**
2125
+ * @minItems 0
2126
+ * @maxItems 100
2127
+ */
2128
+ DataLabelTypes?: DataLabelType[];
2129
+ MeasureLabelVisibility?: Visibility;
2130
+ Position?: DataLabelPosition;
2131
+ LabelContent?: DataLabelContent;
2132
+ Visibility?: Visibility;
2133
+ TotalsVisibility?: Visibility;
2134
+ Overlap?: DataLabelOverlap;
2135
+ CategoryLabelVisibility?: Visibility;
2136
+ LabelColor?: string;
2137
+ LabelFontConfiguration?: FontConfiguration;
2138
+ }
2139
+ export interface DataLabelType {
2140
+ MaximumLabelType?: MaximumLabelType;
2141
+ DataPathLabelType?: DataPathLabelType;
2142
+ RangeEndsLabelType?: RangeEndsLabelType;
2143
+ FieldLabelType?: FieldLabelType;
2144
+ MinimumLabelType?: MinimumLabelType;
2145
+ }
2146
+ export interface MaximumLabelType {
2147
+ Visibility?: Visibility;
2148
+ }
2149
+ export interface DataPathLabelType {
2150
+ FieldId?: string;
2151
+ Visibility?: Visibility;
2152
+ FieldValue?: string;
2153
+ }
2154
+ export interface RangeEndsLabelType {
2155
+ Visibility?: Visibility;
2156
+ }
2157
+ export interface FieldLabelType {
2158
+ FieldId?: string;
2159
+ Visibility?: Visibility;
2160
+ }
2161
+ export interface MinimumLabelType {
2162
+ Visibility?: Visibility;
2163
+ }
2164
+ export interface ScatterPlotFieldWells {
2165
+ ScatterPlotUnaggregatedFieldWells?: ScatterPlotUnaggregatedFieldWells;
2166
+ ScatterPlotCategoricallyAggregatedFieldWells?: ScatterPlotCategoricallyAggregatedFieldWells;
2167
+ }
2168
+ export interface ScatterPlotUnaggregatedFieldWells {
2169
+ /**
2170
+ * @minItems 0
2171
+ * @maxItems 200
2172
+ */
2173
+ Category?: DimensionField[];
2174
+ /**
2175
+ * @minItems 0
2176
+ * @maxItems 200
2177
+ */
2178
+ Size?: MeasureField[];
2179
+ /**
2180
+ * @minItems 0
2181
+ * @maxItems 200
2182
+ */
2183
+ Label?: DimensionField[];
2184
+ /**
2185
+ * @minItems 0
2186
+ * @maxItems 200
2187
+ */
2188
+ XAxis?: DimensionField[];
2189
+ /**
2190
+ * @minItems 0
2191
+ * @maxItems 200
2192
+ */
2193
+ YAxis?: DimensionField[];
2194
+ }
2195
+ export interface ScatterPlotCategoricallyAggregatedFieldWells {
2196
+ /**
2197
+ * @minItems 0
2198
+ * @maxItems 200
2199
+ */
2200
+ Category?: DimensionField[];
2201
+ /**
2202
+ * @minItems 0
2203
+ * @maxItems 200
2204
+ */
2205
+ Size?: MeasureField[];
2206
+ /**
2207
+ * @minItems 0
2208
+ * @maxItems 200
2209
+ */
2210
+ Label?: DimensionField[];
2211
+ /**
2212
+ * @minItems 0
2213
+ * @maxItems 200
2214
+ */
2215
+ XAxis?: MeasureField[];
2216
+ /**
2217
+ * @minItems 0
2218
+ * @maxItems 200
2219
+ */
2220
+ YAxis?: MeasureField[];
2221
+ }
2222
+ export interface RadarChartVisual {
2223
+ Subtitle?: VisualSubtitleLabelOptions;
2224
+ VisualId: string;
2225
+ ChartConfiguration?: RadarChartConfiguration;
2226
+ /**
2227
+ * @minItems 0
2228
+ * @maxItems 10
2229
+ */
2230
+ Actions?: VisualCustomAction[];
2231
+ Title?: VisualTitleLabelOptions;
2232
+ VisualContentAltText?: string;
2233
+ /**
2234
+ * @minItems 0
2235
+ * @maxItems 2
2236
+ */
2237
+ ColumnHierarchies?: ColumnHierarchy[];
2238
+ }
2239
+ export interface RadarChartConfiguration {
2240
+ SortConfiguration?: RadarChartSortConfiguration;
2241
+ Legend?: LegendOptions;
2242
+ Shape?: RadarChartShape;
2243
+ BaseSeriesSettings?: RadarChartSeriesSettings;
2244
+ ColorLabelOptions?: ChartAxisLabelOptions;
2245
+ CategoryLabelOptions?: ChartAxisLabelOptions;
2246
+ AxesRangeScale?: RadarChartAxesRangeScale;
2247
+ VisualPalette?: VisualPalette;
2248
+ AlternateBandColorsVisibility?: Visibility;
2249
+ StartAngle?: number;
2250
+ CategoryAxis?: AxisDisplayOptions;
2251
+ FieldWells?: RadarChartFieldWells;
2252
+ ColorAxis?: AxisDisplayOptions;
2253
+ AlternateBandOddColor?: string;
2254
+ AlternateBandEvenColor?: string;
2255
+ }
2256
+ export interface RadarChartSortConfiguration {
2257
+ /**
2258
+ * @minItems 0
2259
+ * @maxItems 100
2260
+ */
2261
+ ColorSort?: FieldSortOptions[];
2262
+ ColorItemsLimit?: ItemsLimitConfiguration;
2263
+ CategoryItemsLimit?: ItemsLimitConfiguration;
2264
+ /**
2265
+ * @minItems 0
2266
+ * @maxItems 100
2267
+ */
2268
+ CategorySort?: FieldSortOptions[];
2269
+ }
2270
+ export interface RadarChartSeriesSettings {
2271
+ AreaStyleSettings?: RadarChartAreaStyleSettings;
2272
+ }
2273
+ export interface RadarChartAreaStyleSettings {
2274
+ Visibility?: Visibility;
2275
+ }
2276
+ export interface RadarChartFieldWells {
2277
+ RadarChartAggregatedFieldWells?: RadarChartAggregatedFieldWells;
2278
+ }
2279
+ export interface RadarChartAggregatedFieldWells {
2280
+ /**
2281
+ * @minItems 0
2282
+ * @maxItems 1
2283
+ */
2284
+ Category?: DimensionField[];
2285
+ /**
2286
+ * @minItems 0
2287
+ * @maxItems 1
2288
+ */
2289
+ Color?: DimensionField[];
2290
+ /**
2291
+ * @minItems 0
2292
+ * @maxItems 20
2293
+ */
2294
+ Values?: MeasureField[];
2295
+ }
2296
+ export interface ComboChartVisual {
2297
+ Subtitle?: VisualSubtitleLabelOptions;
2298
+ VisualId: string;
2299
+ ChartConfiguration?: ComboChartConfiguration;
2300
+ /**
2301
+ * @minItems 0
2302
+ * @maxItems 10
2303
+ */
2304
+ Actions?: VisualCustomAction[];
2305
+ Title?: VisualTitleLabelOptions;
2306
+ VisualContentAltText?: string;
2307
+ /**
2308
+ * @minItems 0
2309
+ * @maxItems 2
2310
+ */
2311
+ ColumnHierarchies?: ColumnHierarchy[];
2312
+ }
2313
+ export interface ComboChartConfiguration {
2314
+ SortConfiguration?: ComboChartSortConfiguration;
2315
+ Legend?: LegendOptions;
2316
+ /**
2317
+ * @minItems 0
2318
+ * @maxItems 20
2319
+ */
2320
+ ReferenceLines?: ReferenceLine[];
2321
+ ColorLabelOptions?: ChartAxisLabelOptions;
2322
+ BarDataLabels?: DataLabelOptions;
2323
+ CategoryLabelOptions?: ChartAxisLabelOptions;
2324
+ Tooltip?: TooltipOptions;
2325
+ SingleAxisOptions?: SingleAxisOptions;
2326
+ PrimaryYAxisDisplayOptions?: AxisDisplayOptions;
2327
+ VisualPalette?: VisualPalette;
2328
+ BarsArrangement?: BarsArrangement;
2329
+ SecondaryYAxisLabelOptions?: ChartAxisLabelOptions;
2330
+ LineDataLabels?: DataLabelOptions;
2331
+ CategoryAxis?: AxisDisplayOptions;
2332
+ PrimaryYAxisLabelOptions?: ChartAxisLabelOptions;
2333
+ FieldWells?: ComboChartFieldWells;
2334
+ SecondaryYAxisDisplayOptions?: AxisDisplayOptions;
2335
+ }
2336
+ export interface ComboChartSortConfiguration {
2337
+ /**
2338
+ * @minItems 0
2339
+ * @maxItems 100
2340
+ */
2341
+ ColorSort?: FieldSortOptions[];
2342
+ ColorItemsLimit?: ItemsLimitConfiguration;
2343
+ CategoryItemsLimit?: ItemsLimitConfiguration;
2344
+ /**
2345
+ * @minItems 0
2346
+ * @maxItems 100
2347
+ */
2348
+ CategorySort?: FieldSortOptions[];
2349
+ }
2350
+ export interface SingleAxisOptions {
2351
+ YAxisOptions?: YAxisOptions;
2352
+ }
2353
+ export interface YAxisOptions {
2354
+ YAxis: SingleYAxisOption;
2355
+ }
2356
+ export interface ComboChartFieldWells {
2357
+ ComboChartAggregatedFieldWells?: ComboChartAggregatedFieldWells;
2358
+ }
2359
+ export interface ComboChartAggregatedFieldWells {
2360
+ /**
2361
+ * @minItems 0
2362
+ * @maxItems 200
2363
+ */
2364
+ BarValues?: MeasureField[];
2365
+ /**
2366
+ * @minItems 0
2367
+ * @maxItems 200
2368
+ */
2369
+ Category?: DimensionField[];
2370
+ /**
2371
+ * @minItems 0
2372
+ * @maxItems 200
2373
+ */
2374
+ Colors?: DimensionField[];
2375
+ /**
2376
+ * @minItems 0
2377
+ * @maxItems 200
2378
+ */
2379
+ LineValues?: MeasureField[];
2380
+ }
2381
+ export interface WordCloudVisual {
2382
+ Subtitle?: VisualSubtitleLabelOptions;
2383
+ VisualId: string;
2384
+ ChartConfiguration?: WordCloudChartConfiguration;
2385
+ /**
2386
+ * @minItems 0
2387
+ * @maxItems 10
2388
+ */
2389
+ Actions?: VisualCustomAction[];
2390
+ Title?: VisualTitleLabelOptions;
2391
+ VisualContentAltText?: string;
2392
+ /**
2393
+ * @minItems 0
2394
+ * @maxItems 2
2395
+ */
2396
+ ColumnHierarchies?: ColumnHierarchy[];
2397
+ }
2398
+ export interface WordCloudChartConfiguration {
2399
+ SortConfiguration?: WordCloudSortConfiguration;
2400
+ CategoryLabelOptions?: ChartAxisLabelOptions;
2401
+ FieldWells?: WordCloudFieldWells;
2402
+ WordCloudOptions?: WordCloudOptions;
2403
+ }
2404
+ export interface WordCloudSortConfiguration {
2405
+ CategoryItemsLimit?: ItemsLimitConfiguration;
2406
+ /**
2407
+ * @minItems 0
2408
+ * @maxItems 100
2409
+ */
2410
+ CategorySort?: FieldSortOptions[];
2411
+ }
2412
+ export interface WordCloudFieldWells {
2413
+ WordCloudAggregatedFieldWells?: WordCloudAggregatedFieldWells;
2414
+ }
2415
+ export interface WordCloudAggregatedFieldWells {
2416
+ /**
2417
+ * @minItems 0
2418
+ * @maxItems 10
2419
+ */
2420
+ GroupBy?: DimensionField[];
2421
+ /**
2422
+ * @minItems 0
2423
+ * @maxItems 1
2424
+ */
2425
+ Size?: MeasureField[];
2426
+ }
2427
+ export interface WordCloudOptions {
2428
+ WordOrientation?: WordCloudWordOrientation;
2429
+ WordScaling?: WordCloudWordScaling;
2430
+ CloudLayout?: WordCloudCloudLayout;
2431
+ MaximumStringLength?: number;
2432
+ WordCasing?: WordCloudWordCasing;
2433
+ WordPadding?: WordCloudWordPadding;
2434
+ }
2435
+ export interface SankeyDiagramVisual {
2436
+ Subtitle?: VisualSubtitleLabelOptions;
2437
+ VisualId: string;
2438
+ ChartConfiguration?: SankeyDiagramChartConfiguration;
2439
+ /**
2440
+ * @minItems 0
2441
+ * @maxItems 10
2442
+ */
2443
+ Actions?: VisualCustomAction[];
2444
+ Title?: VisualTitleLabelOptions;
2445
+ VisualContentAltText?: string;
2446
+ }
2447
+ export interface SankeyDiagramChartConfiguration {
2448
+ SortConfiguration?: SankeyDiagramSortConfiguration;
2449
+ DataLabels?: DataLabelOptions;
2450
+ FieldWells?: SankeyDiagramFieldWells;
2451
+ }
2452
+ export interface SankeyDiagramSortConfiguration {
2453
+ /**
2454
+ * @minItems 0
2455
+ * @maxItems 100
2456
+ */
2457
+ WeightSort?: FieldSortOptions[];
2458
+ SourceItemsLimit?: ItemsLimitConfiguration;
2459
+ DestinationItemsLimit?: ItemsLimitConfiguration;
2460
+ }
2461
+ export interface SankeyDiagramFieldWells {
2462
+ SankeyDiagramAggregatedFieldWells?: SankeyDiagramAggregatedFieldWells;
2463
+ }
2464
+ export interface SankeyDiagramAggregatedFieldWells {
2465
+ /**
2466
+ * @minItems 0
2467
+ * @maxItems 200
2468
+ */
2469
+ Destination?: DimensionField[];
2470
+ /**
2471
+ * @minItems 0
2472
+ * @maxItems 200
2473
+ */
2474
+ Source?: DimensionField[];
2475
+ /**
2476
+ * @minItems 0
2477
+ * @maxItems 200
2478
+ */
2479
+ Weight?: MeasureField[];
2480
+ }
2481
+ export interface GaugeChartVisual {
2482
+ Subtitle?: VisualSubtitleLabelOptions;
2483
+ ConditionalFormatting?: GaugeChartConditionalFormatting;
2484
+ VisualId: string;
2485
+ ChartConfiguration?: GaugeChartConfiguration;
2486
+ /**
2487
+ * @minItems 0
2488
+ * @maxItems 10
2489
+ */
2490
+ Actions?: VisualCustomAction[];
2491
+ Title?: VisualTitleLabelOptions;
2492
+ VisualContentAltText?: string;
2493
+ }
2494
+ export interface GaugeChartConditionalFormatting {
2495
+ /**
2496
+ * @minItems 0
2497
+ * @maxItems 100
2498
+ */
2499
+ ConditionalFormattingOptions?: GaugeChartConditionalFormattingOption[];
2500
+ }
2501
+ export interface GaugeChartConditionalFormattingOption {
2502
+ Arc?: GaugeChartArcConditionalFormatting;
2503
+ PrimaryValue?: GaugeChartPrimaryValueConditionalFormatting;
2504
+ }
2505
+ export interface GaugeChartArcConditionalFormatting {
2506
+ ForegroundColor?: ConditionalFormattingColor;
2507
+ }
2508
+ export interface ConditionalFormattingColor {
2509
+ Gradient?: ConditionalFormattingGradientColor;
2510
+ Solid?: ConditionalFormattingSolidColor;
2511
+ }
2512
+ export interface ConditionalFormattingGradientColor {
2513
+ Expression: string;
2514
+ Color: GradientColor;
2515
+ }
2516
+ export interface GradientColor {
2517
+ /**
2518
+ * @minItems 0
2519
+ * @maxItems 100
2520
+ */
2521
+ Stops?: GradientStop[];
2522
+ }
2523
+ export interface GradientStop {
2524
+ GradientOffset: number;
2525
+ DataValue?: number;
2526
+ Color?: string;
2527
+ }
2528
+ export interface ConditionalFormattingSolidColor {
2529
+ Expression: string;
2530
+ Color?: string;
2531
+ }
2532
+ export interface GaugeChartPrimaryValueConditionalFormatting {
2533
+ TextColor?: ConditionalFormattingColor;
2534
+ Icon?: ConditionalFormattingIcon;
2535
+ }
2536
+ export interface ConditionalFormattingIcon {
2537
+ CustomCondition?: ConditionalFormattingCustomIconCondition;
2538
+ IconSet?: ConditionalFormattingIconSet;
2539
+ }
2540
+ export interface ConditionalFormattingCustomIconCondition {
2541
+ Expression: string;
2542
+ Color?: string;
2543
+ DisplayConfiguration?: ConditionalFormattingIconDisplayConfiguration;
2544
+ IconOptions: ConditionalFormattingCustomIconOptions;
2545
+ }
2546
+ export interface ConditionalFormattingIconDisplayConfiguration {
2547
+ IconDisplayOption?: ConditionalFormattingIconDisplayOption;
2548
+ }
2549
+ export interface ConditionalFormattingCustomIconOptions {
2550
+ UnicodeIcon?: string;
2551
+ Icon?: Icon;
2552
+ }
2553
+ export interface ConditionalFormattingIconSet {
2554
+ Expression: string;
2555
+ IconSetType?: ConditionalFormattingIconSetType;
2556
+ }
2557
+ export interface GaugeChartConfiguration {
2558
+ DataLabels?: DataLabelOptions;
2559
+ FieldWells?: GaugeChartFieldWells;
2560
+ TooltipOptions?: TooltipOptions;
2561
+ GaugeChartOptions?: GaugeChartOptions;
2562
+ VisualPalette?: VisualPalette;
2563
+ }
2564
+ export interface GaugeChartFieldWells {
2565
+ /**
2566
+ * @minItems 0
2567
+ * @maxItems 200
2568
+ */
2569
+ TargetValues?: MeasureField[];
2570
+ /**
2571
+ * @minItems 0
2572
+ * @maxItems 200
2573
+ */
2574
+ Values?: MeasureField[];
2575
+ }
2576
+ export interface GaugeChartOptions {
2577
+ Arc?: ArcConfiguration;
2578
+ Comparison?: ComparisonConfiguration;
2579
+ PrimaryValueDisplayType?: PrimaryValueDisplayType;
2580
+ ArcAxis?: ArcAxisConfiguration;
2581
+ PrimaryValueFontConfiguration?: FontConfiguration;
2582
+ }
2583
+ export interface ArcConfiguration {
2584
+ ArcAngle?: number;
2585
+ ArcThickness?: ArcThicknessOptions;
2586
+ }
2587
+ export interface ComparisonConfiguration {
2588
+ ComparisonMethod?: ComparisonMethod;
2589
+ ComparisonFormat?: ComparisonFormatConfiguration;
2590
+ }
2591
+ export interface ComparisonFormatConfiguration {
2592
+ NumberDisplayFormatConfiguration?: NumberDisplayFormatConfiguration;
2593
+ PercentageDisplayFormatConfiguration?: PercentageDisplayFormatConfiguration;
2594
+ }
2595
+ export interface ArcAxisConfiguration {
2596
+ Range?: ArcAxisDisplayRange;
2597
+ ReserveRange?: number;
2598
+ }
2599
+ export interface ArcAxisDisplayRange {
2600
+ Min?: number;
2601
+ Max?: number;
2602
+ }
2603
+ export interface FilledMapVisual {
2604
+ Subtitle?: VisualSubtitleLabelOptions;
2605
+ ConditionalFormatting?: FilledMapConditionalFormatting;
2606
+ VisualId: string;
2607
+ ChartConfiguration?: FilledMapConfiguration;
2608
+ /**
2609
+ * @minItems 0
2610
+ * @maxItems 10
2611
+ */
2612
+ Actions?: VisualCustomAction[];
2613
+ Title?: VisualTitleLabelOptions;
2614
+ VisualContentAltText?: string;
2615
+ /**
2616
+ * @minItems 0
2617
+ * @maxItems 2
2618
+ */
2619
+ ColumnHierarchies?: ColumnHierarchy[];
2620
+ }
2621
+ export interface FilledMapConditionalFormatting {
2622
+ /**
2623
+ * @minItems 0
2624
+ * @maxItems 200
2625
+ */
2626
+ ConditionalFormattingOptions: FilledMapConditionalFormattingOption[];
2627
+ }
2628
+ export interface FilledMapConditionalFormattingOption {
2629
+ Shape: FilledMapShapeConditionalFormatting;
2630
+ }
2631
+ export interface FilledMapShapeConditionalFormatting {
2632
+ Format?: ShapeConditionalFormat;
2633
+ FieldId: string;
2634
+ }
2635
+ export interface ShapeConditionalFormat {
2636
+ BackgroundColor: ConditionalFormattingColor;
2637
+ }
2638
+ export interface FilledMapConfiguration {
2639
+ SortConfiguration?: FilledMapSortConfiguration;
2640
+ Legend?: LegendOptions;
2641
+ MapStyleOptions?: GeospatialMapStyleOptions;
2642
+ FieldWells?: FilledMapFieldWells;
2643
+ Tooltip?: TooltipOptions;
2644
+ WindowOptions?: GeospatialWindowOptions;
2645
+ }
2646
+ export interface FilledMapSortConfiguration {
2647
+ /**
2648
+ * @minItems 0
2649
+ * @maxItems 100
2650
+ */
2651
+ CategorySort?: FieldSortOptions[];
2652
+ }
2653
+ export interface FilledMapFieldWells {
2654
+ FilledMapAggregatedFieldWells?: FilledMapAggregatedFieldWells;
2655
+ }
2656
+ export interface FilledMapAggregatedFieldWells {
2657
+ /**
2658
+ * @minItems 0
2659
+ * @maxItems 1
2660
+ */
2661
+ Values?: MeasureField[];
2662
+ /**
2663
+ * @minItems 0
2664
+ * @maxItems 1
2665
+ */
2666
+ Geospatial?: DimensionField[];
2667
+ }
2668
+ export interface WaterfallVisual {
2669
+ Subtitle?: VisualSubtitleLabelOptions;
2670
+ VisualId: string;
2671
+ ChartConfiguration?: WaterfallChartConfiguration;
2672
+ /**
2673
+ * @minItems 0
2674
+ * @maxItems 10
2675
+ */
2676
+ Actions?: VisualCustomAction[];
2677
+ Title?: VisualTitleLabelOptions;
2678
+ VisualContentAltText?: string;
2679
+ /**
2680
+ * @minItems 0
2681
+ * @maxItems 2
2682
+ */
2683
+ ColumnHierarchies?: ColumnHierarchy[];
2684
+ }
2685
+ export interface WaterfallChartConfiguration {
2686
+ CategoryAxisLabelOptions?: ChartAxisLabelOptions;
2687
+ SortConfiguration?: WaterfallChartSortConfiguration;
2688
+ Legend?: LegendOptions;
2689
+ DataLabels?: DataLabelOptions;
2690
+ PrimaryYAxisLabelOptions?: ChartAxisLabelOptions;
2691
+ FieldWells?: WaterfallChartFieldWells;
2692
+ WaterfallChartOptions?: WaterfallChartOptions;
2693
+ ColorConfiguration?: WaterfallChartColorConfiguration;
2694
+ CategoryAxisDisplayOptions?: AxisDisplayOptions;
2695
+ PrimaryYAxisDisplayOptions?: AxisDisplayOptions;
2696
+ VisualPalette?: VisualPalette;
2697
+ }
2698
+ export interface WaterfallChartSortConfiguration {
2699
+ BreakdownItemsLimit?: ItemsLimitConfiguration;
2700
+ /**
2701
+ * @minItems 0
2702
+ * @maxItems 100
2703
+ */
2704
+ CategorySort?: FieldSortOptions[];
2705
+ }
2706
+ export interface WaterfallChartFieldWells {
2707
+ WaterfallChartAggregatedFieldWells?: WaterfallChartAggregatedFieldWells;
2708
+ }
2709
+ export interface WaterfallChartAggregatedFieldWells {
2710
+ /**
2711
+ * @minItems 0
2712
+ * @maxItems 200
2713
+ */
2714
+ Categories?: DimensionField[];
2715
+ /**
2716
+ * @minItems 0
2717
+ * @maxItems 200
2718
+ */
2719
+ Breakdowns?: DimensionField[];
2720
+ /**
2721
+ * @minItems 0
2722
+ * @maxItems 200
2723
+ */
2724
+ Values?: MeasureField[];
2725
+ }
2726
+ export interface WaterfallChartOptions {
2727
+ TotalBarLabel?: string;
2728
+ }
2729
+ export interface WaterfallChartColorConfiguration {
2730
+ GroupColorConfiguration?: WaterfallChartGroupColorConfiguration;
2731
+ }
2732
+ export interface WaterfallChartGroupColorConfiguration {
2733
+ NegativeBarColor?: string;
2734
+ TotalBarColor?: string;
2735
+ PositiveBarColor?: string;
2736
+ }
2737
+ export interface CustomContentVisual {
2738
+ Subtitle?: VisualSubtitleLabelOptions;
2739
+ VisualId: string;
2740
+ ChartConfiguration?: CustomContentConfiguration;
2741
+ /**
2742
+ * @minItems 0
2743
+ * @maxItems 10
2744
+ */
2745
+ Actions?: VisualCustomAction[];
2746
+ DataSetIdentifier: string;
2747
+ Title?: VisualTitleLabelOptions;
2748
+ VisualContentAltText?: string;
2749
+ }
2750
+ export interface CustomContentConfiguration {
2751
+ ContentUrl?: string;
2752
+ ContentType?: CustomContentType;
2753
+ ImageScaling?: CustomContentImageScalingConfiguration;
2754
+ }
2755
+ export interface PieChartVisual {
2756
+ Subtitle?: VisualSubtitleLabelOptions;
2757
+ VisualId: string;
2758
+ ChartConfiguration?: PieChartConfiguration;
2759
+ /**
2760
+ * @minItems 0
2761
+ * @maxItems 10
2762
+ */
2763
+ Actions?: VisualCustomAction[];
2764
+ Title?: VisualTitleLabelOptions;
2765
+ VisualContentAltText?: string;
2766
+ /**
2767
+ * @minItems 0
2768
+ * @maxItems 2
2769
+ */
2770
+ ColumnHierarchies?: ColumnHierarchy[];
2771
+ }
2772
+ export interface PieChartConfiguration {
2773
+ SortConfiguration?: PieChartSortConfiguration;
2774
+ Legend?: LegendOptions;
2775
+ DataLabels?: DataLabelOptions;
2776
+ /**
2777
+ * @minItems 1
2778
+ * @maxItems 200
2779
+ */
2780
+ ContributionAnalysisDefaults?: ContributionAnalysisDefault[];
2781
+ CategoryLabelOptions?: ChartAxisLabelOptions;
2782
+ FieldWells?: PieChartFieldWells;
2783
+ Tooltip?: TooltipOptions;
2784
+ DonutOptions?: DonutOptions;
2785
+ SmallMultiplesOptions?: SmallMultiplesOptions;
2786
+ ValueLabelOptions?: ChartAxisLabelOptions;
2787
+ VisualPalette?: VisualPalette;
2788
+ }
2789
+ export interface PieChartSortConfiguration {
2790
+ /**
2791
+ * @minItems 0
2792
+ * @maxItems 100
2793
+ */
2794
+ SmallMultiplesSort?: FieldSortOptions[];
2795
+ CategoryItemsLimit?: ItemsLimitConfiguration;
2796
+ /**
2797
+ * @minItems 0
2798
+ * @maxItems 100
2799
+ */
2800
+ CategorySort?: FieldSortOptions[];
2801
+ SmallMultiplesLimitConfiguration?: ItemsLimitConfiguration;
2802
+ }
2803
+ export interface ContributionAnalysisDefault {
2804
+ MeasureFieldId: string;
2805
+ /**
2806
+ * @minItems 1
2807
+ * @maxItems 4
2808
+ */
2809
+ ContributorDimensions: ColumnIdentifier[];
2810
+ }
2811
+ export interface PieChartFieldWells {
2812
+ PieChartAggregatedFieldWells?: PieChartAggregatedFieldWells;
2813
+ }
2814
+ export interface PieChartAggregatedFieldWells {
2815
+ /**
2816
+ * @minItems 0
2817
+ * @maxItems 200
2818
+ */
2819
+ Category?: DimensionField[];
2820
+ /**
2821
+ * @minItems 0
2822
+ * @maxItems 200
2823
+ */
2824
+ Values?: MeasureField[];
2825
+ /**
2826
+ * @minItems 0
2827
+ * @maxItems 1
2828
+ */
2829
+ SmallMultiples?: DimensionField[];
2830
+ }
2831
+ export interface DonutOptions {
2832
+ DonutCenterOptions?: DonutCenterOptions;
2833
+ ArcOptions?: ArcOptions;
2834
+ }
2835
+ export interface DonutCenterOptions {
2836
+ LabelVisibility?: Visibility;
2837
+ }
2838
+ export interface ArcOptions {
2839
+ ArcThickness?: ArcThickness;
2840
+ }
2841
+ export interface SmallMultiplesOptions {
2842
+ MaxVisibleRows?: number;
2843
+ PanelConfiguration?: PanelConfiguration;
2844
+ MaxVisibleColumns?: number;
2845
+ XAxis?: SmallMultiplesAxisProperties;
2846
+ YAxis?: SmallMultiplesAxisProperties;
2847
+ }
2848
+ export interface PanelConfiguration {
2849
+ /**
2850
+ * String based length that is composed of value and unit in px
2851
+ */
2852
+ BorderThickness?: string;
2853
+ BorderStyle?: PanelBorderStyle;
2854
+ /**
2855
+ * String based length that is composed of value and unit in px
2856
+ */
2857
+ GutterSpacing?: string;
2858
+ BackgroundVisibility?: Visibility;
2859
+ BorderVisibility?: Visibility;
2860
+ BorderColor?: string;
2861
+ Title?: PanelTitleOptions;
2862
+ GutterVisibility?: Visibility;
2863
+ BackgroundColor?: string;
2864
+ }
2865
+ export interface PanelTitleOptions {
2866
+ Visibility?: Visibility;
2867
+ FontConfiguration?: FontConfiguration;
2868
+ HorizontalTextAlignment?: HorizontalTextAlignment;
2869
+ }
2870
+ export interface SmallMultiplesAxisProperties {
2871
+ Placement?: SmallMultiplesAxisPlacement;
2872
+ Scale?: SmallMultiplesAxisScale;
2873
+ }
2874
+ export interface KPIVisual {
2875
+ Subtitle?: VisualSubtitleLabelOptions;
2876
+ ConditionalFormatting?: KPIConditionalFormatting;
2877
+ VisualId: string;
2878
+ ChartConfiguration?: KPIConfiguration;
2879
+ /**
2880
+ * @minItems 0
2881
+ * @maxItems 10
2882
+ */
2883
+ Actions?: VisualCustomAction[];
2884
+ Title?: VisualTitleLabelOptions;
2885
+ VisualContentAltText?: string;
2886
+ /**
2887
+ * @minItems 0
2888
+ * @maxItems 2
2889
+ */
2890
+ ColumnHierarchies?: ColumnHierarchy[];
2891
+ }
2892
+ export interface KPIConditionalFormatting {
2893
+ /**
2894
+ * @minItems 0
2895
+ * @maxItems 100
2896
+ */
2897
+ ConditionalFormattingOptions?: KPIConditionalFormattingOption[];
2898
+ }
2899
+ export interface KPIConditionalFormattingOption {
2900
+ PrimaryValue?: KPIPrimaryValueConditionalFormatting;
2901
+ ActualValue?: KPIActualValueConditionalFormatting;
2902
+ ComparisonValue?: KPIComparisonValueConditionalFormatting;
2903
+ ProgressBar?: KPIProgressBarConditionalFormatting;
2904
+ }
2905
+ export interface KPIPrimaryValueConditionalFormatting {
2906
+ TextColor?: ConditionalFormattingColor;
2907
+ Icon?: ConditionalFormattingIcon;
2908
+ }
2909
+ export interface KPIActualValueConditionalFormatting {
2910
+ TextColor?: ConditionalFormattingColor;
2911
+ Icon?: ConditionalFormattingIcon;
2912
+ }
2913
+ export interface KPIComparisonValueConditionalFormatting {
2914
+ TextColor?: ConditionalFormattingColor;
2915
+ Icon?: ConditionalFormattingIcon;
2916
+ }
2917
+ export interface KPIProgressBarConditionalFormatting {
2918
+ ForegroundColor?: ConditionalFormattingColor;
2919
+ }
2920
+ export interface KPIConfiguration {
2921
+ SortConfiguration?: KPISortConfiguration;
2922
+ KPIOptions?: KPIOptions;
2923
+ FieldWells?: KPIFieldWells;
2924
+ }
2925
+ export interface KPISortConfiguration {
2926
+ /**
2927
+ * @minItems 0
2928
+ * @maxItems 100
2929
+ */
2930
+ TrendGroupSort?: FieldSortOptions[];
2931
+ }
2932
+ export interface KPIOptions {
2933
+ SecondaryValueFontConfiguration?: FontConfiguration;
2934
+ VisualLayoutOptions?: KPIVisualLayoutOptions;
2935
+ TrendArrows?: TrendArrowOptions;
2936
+ SecondaryValue?: SecondaryValueOptions;
2937
+ Comparison?: ComparisonConfiguration;
2938
+ PrimaryValueDisplayType?: PrimaryValueDisplayType;
2939
+ ProgressBar?: ProgressBarOptions;
2940
+ PrimaryValueFontConfiguration?: FontConfiguration;
2941
+ Sparkline?: KPISparklineOptions;
2942
+ }
2943
+ export interface KPIVisualLayoutOptions {
2944
+ StandardLayout?: KPIVisualStandardLayout;
2945
+ }
2946
+ export interface KPIVisualStandardLayout {
2947
+ Type: KPIVisualStandardLayoutType;
2948
+ }
2949
+ export interface TrendArrowOptions {
2950
+ Visibility?: Visibility;
2951
+ }
2952
+ export interface SecondaryValueOptions {
2953
+ Visibility?: Visibility;
2954
+ }
2955
+ export interface ProgressBarOptions {
2956
+ Visibility?: Visibility;
2957
+ }
2958
+ export interface KPISparklineOptions {
2959
+ Type: KPISparklineType;
2960
+ Color?: string;
2961
+ TooltipVisibility?: Visibility;
2962
+ Visibility?: Visibility;
2963
+ }
2964
+ export interface KPIFieldWells {
2965
+ /**
2966
+ * @minItems 0
2967
+ * @maxItems 200
2968
+ */
2969
+ TargetValues?: MeasureField[];
2970
+ /**
2971
+ * @minItems 0
2972
+ * @maxItems 200
2973
+ */
2974
+ TrendGroups?: DimensionField[];
2975
+ /**
2976
+ * @minItems 0
2977
+ * @maxItems 200
2978
+ */
2979
+ Values?: MeasureField[];
2980
+ }
2981
+ export interface HistogramVisual {
2982
+ Subtitle?: VisualSubtitleLabelOptions;
2983
+ VisualId: string;
2984
+ ChartConfiguration?: HistogramConfiguration;
2985
+ /**
2986
+ * @minItems 0
2987
+ * @maxItems 10
2988
+ */
2989
+ Actions?: VisualCustomAction[];
2990
+ Title?: VisualTitleLabelOptions;
2991
+ VisualContentAltText?: string;
2992
+ }
2993
+ export interface HistogramConfiguration {
2994
+ YAxisDisplayOptions?: AxisDisplayOptions;
2995
+ DataLabels?: DataLabelOptions;
2996
+ BinOptions?: HistogramBinOptions;
2997
+ FieldWells?: HistogramFieldWells;
2998
+ Tooltip?: TooltipOptions;
2999
+ XAxisLabelOptions?: ChartAxisLabelOptions;
3000
+ VisualPalette?: VisualPalette;
3001
+ XAxisDisplayOptions?: AxisDisplayOptions;
3002
+ }
3003
+ export interface HistogramBinOptions {
3004
+ BinWidth?: BinWidthOptions;
3005
+ StartValue?: number;
3006
+ SelectedBinType?: HistogramBinType;
3007
+ BinCount?: BinCountOptions;
3008
+ }
3009
+ export interface BinWidthOptions {
3010
+ BinCountLimit?: number;
3011
+ Value?: number;
3012
+ }
3013
+ export interface BinCountOptions {
3014
+ Value?: number;
3015
+ }
3016
+ export interface HistogramFieldWells {
3017
+ HistogramAggregatedFieldWells?: HistogramAggregatedFieldWells;
3018
+ }
3019
+ export interface HistogramAggregatedFieldWells {
3020
+ /**
3021
+ * @minItems 0
3022
+ * @maxItems 1
3023
+ */
3024
+ Values?: MeasureField[];
3025
+ }
3026
+ export interface PluginVisual {
3027
+ Subtitle?: VisualSubtitleLabelOptions;
3028
+ PluginArn: string;
3029
+ VisualId: string;
3030
+ ChartConfiguration?: PluginVisualConfiguration;
3031
+ Title?: VisualTitleLabelOptions;
3032
+ VisualContentAltText?: string;
3033
+ }
3034
+ export interface PluginVisualConfiguration {
3035
+ SortConfiguration?: PluginVisualSortConfiguration;
3036
+ VisualOptions?: PluginVisualOptions;
3037
+ /**
3038
+ * @minItems 0
3039
+ * @maxItems 10
3040
+ */
3041
+ FieldWells?: PluginVisualFieldWell[];
3042
+ }
3043
+ export interface PluginVisualSortConfiguration {
3044
+ PluginVisualTableQuerySort?: PluginVisualTableQuerySort;
3045
+ }
3046
+ export interface PluginVisualTableQuerySort {
3047
+ ItemsLimitConfiguration?: PluginVisualItemsLimitConfiguration;
3048
+ /**
3049
+ * @minItems 0
3050
+ * @maxItems 100
3051
+ */
3052
+ RowSort?: FieldSortOptions[];
3053
+ }
3054
+ export interface PluginVisualItemsLimitConfiguration {
3055
+ ItemsLimit?: number;
3056
+ }
3057
+ export interface PluginVisualOptions {
3058
+ VisualProperties?: PluginVisualProperty[];
3059
+ }
3060
+ export interface PluginVisualProperty {
3061
+ Value?: string;
3062
+ Name?: string;
3063
+ }
3064
+ export interface PluginVisualFieldWell {
3065
+ /**
3066
+ * @minItems 0
3067
+ * @maxItems 200
3068
+ */
3069
+ Unaggregated?: UnaggregatedField[];
3070
+ AxisName?: PluginVisualAxisName;
3071
+ /**
3072
+ * @minItems 0
3073
+ * @maxItems 200
3074
+ */
3075
+ Measures?: MeasureField[];
3076
+ /**
3077
+ * @minItems 0
3078
+ * @maxItems 200
3079
+ */
3080
+ Dimensions?: DimensionField[];
3081
+ }
3082
+ export interface TableVisual {
3083
+ Subtitle?: VisualSubtitleLabelOptions;
3084
+ ConditionalFormatting?: TableConditionalFormatting;
3085
+ VisualId: string;
3086
+ ChartConfiguration?: TableConfiguration;
3087
+ /**
3088
+ * @minItems 0
3089
+ * @maxItems 10
3090
+ */
3091
+ Actions?: VisualCustomAction[];
3092
+ Title?: VisualTitleLabelOptions;
3093
+ VisualContentAltText?: string;
3094
+ }
3095
+ export interface TableConditionalFormatting {
3096
+ /**
3097
+ * @minItems 0
3098
+ * @maxItems 500
3099
+ */
3100
+ ConditionalFormattingOptions?: TableConditionalFormattingOption[];
3101
+ }
3102
+ export interface TableConditionalFormattingOption {
3103
+ Row?: TableRowConditionalFormatting;
3104
+ Cell?: TableCellConditionalFormatting;
3105
+ }
3106
+ export interface TableRowConditionalFormatting {
3107
+ TextColor?: ConditionalFormattingColor;
3108
+ BackgroundColor?: ConditionalFormattingColor;
3109
+ }
3110
+ export interface TableCellConditionalFormatting {
3111
+ FieldId: string;
3112
+ TextFormat?: TextConditionalFormat;
3113
+ }
3114
+ export interface TextConditionalFormat {
3115
+ TextColor?: ConditionalFormattingColor;
3116
+ Icon?: ConditionalFormattingIcon;
3117
+ BackgroundColor?: ConditionalFormattingColor;
3118
+ }
3119
+ export interface TableConfiguration {
3120
+ SortConfiguration?: TableSortConfiguration;
3121
+ PaginatedReportOptions?: TablePaginatedReportOptions;
3122
+ TableOptions?: TableOptions;
3123
+ /**
3124
+ * @minItems 0
3125
+ * @maxItems 200
3126
+ */
3127
+ TableInlineVisualizations?: TableInlineVisualization[];
3128
+ FieldWells?: TableFieldWells;
3129
+ FieldOptions?: TableFieldOptions;
3130
+ TotalOptions?: TotalOptions;
3131
+ }
3132
+ export interface TableSortConfiguration {
3133
+ /**
3134
+ * @minItems 0
3135
+ * @maxItems 100
3136
+ */
3137
+ RowSort?: FieldSortOptions[];
3138
+ PaginationConfiguration?: PaginationConfiguration;
3139
+ }
3140
+ export interface TablePaginatedReportOptions {
3141
+ OverflowColumnHeaderVisibility?: Visibility;
3142
+ VerticalOverflowVisibility?: Visibility;
3143
+ }
3144
+ export interface TableOptions {
3145
+ HeaderStyle?: TableCellStyle;
3146
+ CellStyle?: TableCellStyle;
3147
+ Orientation?: TableOrientation;
3148
+ RowAlternateColorOptions?: RowAlternateColorOptions;
3149
+ }
3150
+ export interface TableCellStyle {
3151
+ VerticalTextAlignment?: VerticalTextAlignment;
3152
+ Visibility?: Visibility;
3153
+ Height?: number;
3154
+ FontConfiguration?: FontConfiguration;
3155
+ Border?: GlobalTableBorderOptions;
3156
+ TextWrap?: TextWrap;
3157
+ HorizontalTextAlignment?: HorizontalTextAlignment;
3158
+ BackgroundColor?: string;
3159
+ }
3160
+ export interface GlobalTableBorderOptions {
3161
+ UniformBorder?: TableBorderOptions;
3162
+ SideSpecificBorder?: TableSideBorderOptions;
3163
+ }
3164
+ export interface TableBorderOptions {
3165
+ Thickness?: number;
3166
+ Color?: string;
3167
+ Style?: TableBorderStyle;
3168
+ }
3169
+ export interface TableSideBorderOptions {
3170
+ Left?: TableBorderOptions;
3171
+ Top?: TableBorderOptions;
3172
+ InnerHorizontal?: TableBorderOptions;
3173
+ Right?: TableBorderOptions;
3174
+ Bottom?: TableBorderOptions;
3175
+ InnerVertical?: TableBorderOptions;
3176
+ }
3177
+ export interface RowAlternateColorOptions {
3178
+ Status?: WidgetStatus;
3179
+ UsePrimaryBackgroundColor?: WidgetStatus;
3180
+ /**
3181
+ * @minItems 0
3182
+ * @maxItems 1
3183
+ */
3184
+ RowAlternateColors?: string[];
3185
+ }
3186
+ export interface TableInlineVisualization {
3187
+ DataBars?: DataBarsOptions;
3188
+ }
3189
+ export interface DataBarsOptions {
3190
+ PositiveColor?: string;
3191
+ FieldId: string;
3192
+ NegativeColor?: string;
3193
+ }
3194
+ export interface TableFieldWells {
3195
+ TableUnaggregatedFieldWells?: TableUnaggregatedFieldWells;
3196
+ TableAggregatedFieldWells?: TableAggregatedFieldWells;
3197
+ }
3198
+ export interface TableUnaggregatedFieldWells {
3199
+ /**
3200
+ * @minItems 0
3201
+ * @maxItems 200
3202
+ */
3203
+ Values?: UnaggregatedField[];
3204
+ }
3205
+ export interface TableAggregatedFieldWells {
3206
+ /**
3207
+ * @minItems 0
3208
+ * @maxItems 200
3209
+ */
3210
+ GroupBy?: DimensionField[];
3211
+ /**
3212
+ * @minItems 0
3213
+ * @maxItems 200
3214
+ */
3215
+ Values?: MeasureField[];
3216
+ }
3217
+ export interface TableFieldOptions {
3218
+ /**
3219
+ * @minItems 0
3220
+ * @maxItems 200
3221
+ */
3222
+ Order?: string[];
3223
+ PinnedFieldOptions?: TablePinnedFieldOptions;
3224
+ /**
3225
+ * @minItems 0
3226
+ * @maxItems 100
3227
+ */
3228
+ SelectedFieldOptions?: TableFieldOption[];
3229
+ }
3230
+ export interface TablePinnedFieldOptions {
3231
+ /**
3232
+ * @minItems 0
3233
+ * @maxItems 201
3234
+ */
3235
+ PinnedLeftFields?: string[];
3236
+ }
3237
+ export interface TableFieldOption {
3238
+ CustomLabel?: string;
3239
+ URLStyling?: TableFieldURLConfiguration;
3240
+ FieldId: string;
3241
+ Visibility?: Visibility;
3242
+ /**
3243
+ * String based length that is composed of value and unit in px
3244
+ */
3245
+ Width?: string;
3246
+ }
3247
+ export interface TableFieldURLConfiguration {
3248
+ LinkConfiguration?: TableFieldLinkConfiguration;
3249
+ ImageConfiguration?: TableFieldImageConfiguration;
3250
+ }
3251
+ export interface TableFieldLinkConfiguration {
3252
+ Target: URLTargetConfiguration;
3253
+ Content: TableFieldLinkContentConfiguration;
3254
+ }
3255
+ export interface TableFieldLinkContentConfiguration {
3256
+ CustomIconContent?: TableFieldCustomIconContent;
3257
+ CustomTextContent?: TableFieldCustomTextContent;
3258
+ }
3259
+ export interface TableFieldCustomIconContent {
3260
+ Icon?: TableFieldIconSetType;
3261
+ }
3262
+ export interface TableFieldCustomTextContent {
3263
+ Value?: string;
3264
+ FontConfiguration: FontConfiguration;
3265
+ }
3266
+ export interface TableFieldImageConfiguration {
3267
+ SizingOptions?: TableCellImageSizingConfiguration;
3268
+ }
3269
+ export interface TableCellImageSizingConfiguration {
3270
+ TableCellImageScalingConfiguration?: TableCellImageScalingConfiguration;
3271
+ }
3272
+ export interface TotalOptions {
3273
+ /**
3274
+ * @minItems 0
3275
+ * @maxItems 200
3276
+ */
3277
+ TotalAggregationOptions?: TotalAggregationOption[];
3278
+ CustomLabel?: string;
3279
+ ScrollStatus?: TableTotalsScrollStatus;
3280
+ Placement?: TableTotalsPlacement;
3281
+ TotalCellStyle?: TableCellStyle;
3282
+ TotalsVisibility?: Visibility;
3283
+ }
3284
+ export interface TotalAggregationOption {
3285
+ TotalAggregationFunction: TotalAggregationFunction;
3286
+ FieldId: string;
3287
+ }
3288
+ export interface TotalAggregationFunction {
3289
+ SimpleTotalAggregationFunction?: SimpleTotalAggregationFunction;
3290
+ }
3291
+ export interface PivotTableVisual {
3292
+ Subtitle?: VisualSubtitleLabelOptions;
3293
+ ConditionalFormatting?: PivotTableConditionalFormatting;
3294
+ VisualId: string;
3295
+ ChartConfiguration?: PivotTableConfiguration;
3296
+ /**
3297
+ * @minItems 0
3298
+ * @maxItems 10
3299
+ */
3300
+ Actions?: VisualCustomAction[];
3301
+ Title?: VisualTitleLabelOptions;
3302
+ VisualContentAltText?: string;
3303
+ }
3304
+ export interface PivotTableConditionalFormatting {
3305
+ /**
3306
+ * @minItems 0
3307
+ * @maxItems 500
3308
+ */
3309
+ ConditionalFormattingOptions?: PivotTableConditionalFormattingOption[];
3310
+ }
3311
+ export interface PivotTableConditionalFormattingOption {
3312
+ Cell?: PivotTableCellConditionalFormatting;
3313
+ }
3314
+ export interface PivotTableCellConditionalFormatting {
3315
+ Scope?: PivotTableConditionalFormattingScope;
3316
+ /**
3317
+ * @minItems 0
3318
+ * @maxItems 3
3319
+ */
3320
+ Scopes?: PivotTableConditionalFormattingScope[];
3321
+ FieldId: string;
3322
+ TextFormat?: TextConditionalFormat;
3323
+ }
3324
+ export interface PivotTableConditionalFormattingScope {
3325
+ Role?: PivotTableConditionalFormattingScopeRole;
3326
+ }
3327
+ export interface PivotTableConfiguration {
3328
+ SortConfiguration?: PivotTableSortConfiguration;
3329
+ PaginatedReportOptions?: PivotTablePaginatedReportOptions;
3330
+ TableOptions?: PivotTableOptions;
3331
+ FieldWells?: PivotTableFieldWells;
3332
+ FieldOptions?: PivotTableFieldOptions;
3333
+ TotalOptions?: PivotTableTotalOptions;
3334
+ }
3335
+ export interface PivotTableSortConfiguration {
3336
+ /**
3337
+ * @minItems 0
3338
+ * @maxItems 200
3339
+ */
3340
+ FieldSortOptions?: PivotFieldSortOptions[];
3341
+ }
3342
+ export interface PivotFieldSortOptions {
3343
+ SortBy: PivotTableSortBy;
3344
+ FieldId: string;
3345
+ }
3346
+ export interface PivotTableSortBy {
3347
+ Field?: FieldSort;
3348
+ DataPath?: DataPathSort;
3349
+ Column?: ColumnSort;
3350
+ }
3351
+ export interface DataPathSort {
3352
+ /**
3353
+ * @minItems 0
3354
+ * @maxItems 20
3355
+ */
3356
+ SortPaths: DataPathValue[];
3357
+ Direction: SortDirection;
3358
+ }
3359
+ export interface PivotTablePaginatedReportOptions {
3360
+ OverflowColumnHeaderVisibility?: Visibility;
3361
+ VerticalOverflowVisibility?: Visibility;
3362
+ }
3363
+ export interface PivotTableOptions {
3364
+ RowFieldNamesStyle?: TableCellStyle;
3365
+ RowHeaderStyle?: TableCellStyle;
3366
+ CollapsedRowDimensionsVisibility?: Visibility;
3367
+ RowsLayout?: PivotTableRowsLayout;
3368
+ MetricPlacement?: PivotTableMetricPlacement;
3369
+ /**
3370
+ * String based length that is composed of value and unit in px
3371
+ */
3372
+ DefaultCellWidth?: string;
3373
+ ColumnNamesVisibility?: Visibility;
3374
+ RowsLabelOptions?: PivotTableRowsLabelOptions;
3375
+ SingleMetricVisibility?: Visibility;
3376
+ ColumnHeaderStyle?: TableCellStyle;
3377
+ ToggleButtonsVisibility?: Visibility;
3378
+ CellStyle?: TableCellStyle;
3379
+ RowAlternateColorOptions?: RowAlternateColorOptions;
3380
+ }
3381
+ export interface PivotTableRowsLabelOptions {
3382
+ CustomLabel?: string;
3383
+ Visibility?: Visibility;
3384
+ }
3385
+ export interface PivotTableFieldWells {
3386
+ PivotTableAggregatedFieldWells?: PivotTableAggregatedFieldWells;
3387
+ }
3388
+ export interface PivotTableAggregatedFieldWells {
3389
+ /**
3390
+ * @minItems 0
3391
+ * @maxItems 40
3392
+ */
3393
+ Values?: MeasureField[];
3394
+ /**
3395
+ * @minItems 0
3396
+ * @maxItems 40
3397
+ */
3398
+ Columns?: DimensionField[];
3399
+ /**
3400
+ * @minItems 0
3401
+ * @maxItems 40
3402
+ */
3403
+ Rows?: DimensionField[];
3404
+ }
3405
+ export interface PivotTableFieldOptions {
3406
+ CollapseStateOptions?: PivotTableFieldCollapseStateOption[];
3407
+ /**
3408
+ * @minItems 0
3409
+ * @maxItems 100
3410
+ */
3411
+ DataPathOptions?: PivotTableDataPathOption[];
3412
+ /**
3413
+ * @minItems 0
3414
+ * @maxItems 100
3415
+ */
3416
+ SelectedFieldOptions?: PivotTableFieldOption[];
3417
+ }
3418
+ export interface PivotTableFieldCollapseStateOption {
3419
+ Target: PivotTableFieldCollapseStateTarget;
3420
+ State?: PivotTableFieldCollapseState;
3421
+ }
3422
+ export interface PivotTableFieldCollapseStateTarget {
3423
+ FieldId?: string;
3424
+ /**
3425
+ * @minItems 0
3426
+ * @maxItems 20
3427
+ */
3428
+ FieldDataPathValues?: DataPathValue[];
3429
+ }
3430
+ export interface PivotTableDataPathOption {
3431
+ /**
3432
+ * @minItems 0
3433
+ * @maxItems 20
3434
+ */
3435
+ DataPathList: DataPathValue[];
3436
+ /**
3437
+ * String based length that is composed of value and unit in px
3438
+ */
3439
+ Width?: string;
3440
+ }
3441
+ export interface PivotTableFieldOption {
3442
+ CustomLabel?: string;
3443
+ FieldId: string;
3444
+ Visibility?: Visibility;
3445
+ }
3446
+ export interface PivotTableTotalOptions {
3447
+ ColumnSubtotalOptions?: SubtotalOptions;
3448
+ RowSubtotalOptions?: SubtotalOptions;
3449
+ RowTotalOptions?: PivotTotalOptions;
3450
+ ColumnTotalOptions?: PivotTotalOptions;
3451
+ }
3452
+ export interface SubtotalOptions {
3453
+ CustomLabel?: string;
3454
+ /**
3455
+ * @minItems 0
3456
+ * @maxItems 100
3457
+ */
3458
+ FieldLevelOptions?: PivotTableFieldSubtotalOptions[];
3459
+ ValueCellStyle?: TableCellStyle;
3460
+ TotalCellStyle?: TableCellStyle;
3461
+ TotalsVisibility?: Visibility;
3462
+ FieldLevel?: PivotTableSubtotalLevel;
3463
+ MetricHeaderCellStyle?: TableCellStyle;
3464
+ /**
3465
+ * @minItems 0
3466
+ * @maxItems 3
3467
+ */
3468
+ StyleTargets?: TableStyleTarget[];
3469
+ }
3470
+ export interface PivotTableFieldSubtotalOptions {
3471
+ FieldId?: string;
3472
+ }
3473
+ export interface TableStyleTarget {
3474
+ CellType: StyledCellType;
3475
+ }
3476
+ export interface PivotTotalOptions {
3477
+ /**
3478
+ * @minItems 0
3479
+ * @maxItems 200
3480
+ */
3481
+ TotalAggregationOptions?: TotalAggregationOption[];
3482
+ CustomLabel?: string;
3483
+ ValueCellStyle?: TableCellStyle;
3484
+ ScrollStatus?: TableTotalsScrollStatus;
3485
+ Placement?: TableTotalsPlacement;
3486
+ TotalCellStyle?: TableCellStyle;
3487
+ TotalsVisibility?: Visibility;
3488
+ MetricHeaderCellStyle?: TableCellStyle;
3489
+ }
3490
+ export interface BarChartVisual {
3491
+ Subtitle?: VisualSubtitleLabelOptions;
3492
+ VisualId: string;
3493
+ ChartConfiguration?: BarChartConfiguration;
3494
+ /**
3495
+ * @minItems 0
3496
+ * @maxItems 10
3497
+ */
3498
+ Actions?: VisualCustomAction[];
3499
+ Title?: VisualTitleLabelOptions;
3500
+ VisualContentAltText?: string;
3501
+ /**
3502
+ * @minItems 0
3503
+ * @maxItems 2
3504
+ */
3505
+ ColumnHierarchies?: ColumnHierarchy[];
3506
+ }
3507
+ export interface BarChartConfiguration {
3508
+ SortConfiguration?: BarChartSortConfiguration;
3509
+ Legend?: LegendOptions;
3510
+ /**
3511
+ * @minItems 0
3512
+ * @maxItems 20
3513
+ */
3514
+ ReferenceLines?: ReferenceLine[];
3515
+ DataLabels?: DataLabelOptions;
3516
+ ColorLabelOptions?: ChartAxisLabelOptions;
3517
+ CategoryLabelOptions?: ChartAxisLabelOptions;
3518
+ Tooltip?: TooltipOptions;
3519
+ SmallMultiplesOptions?: SmallMultiplesOptions;
3520
+ Orientation?: BarChartOrientation;
3521
+ VisualPalette?: VisualPalette;
3522
+ ValueLabelOptions?: ChartAxisLabelOptions;
3523
+ BarsArrangement?: BarsArrangement;
3524
+ CategoryAxis?: AxisDisplayOptions;
3525
+ /**
3526
+ * @minItems 1
3527
+ * @maxItems 200
3528
+ */
3529
+ ContributionAnalysisDefaults?: ContributionAnalysisDefault[];
3530
+ FieldWells?: BarChartFieldWells;
3531
+ ValueAxis?: AxisDisplayOptions;
3532
+ }
3533
+ export interface BarChartSortConfiguration {
3534
+ /**
3535
+ * @minItems 0
3536
+ * @maxItems 100
3537
+ */
3538
+ SmallMultiplesSort?: FieldSortOptions[];
3539
+ /**
3540
+ * @minItems 0
3541
+ * @maxItems 100
3542
+ */
3543
+ ColorSort?: FieldSortOptions[];
3544
+ ColorItemsLimit?: ItemsLimitConfiguration;
3545
+ CategoryItemsLimit?: ItemsLimitConfiguration;
3546
+ /**
3547
+ * @minItems 0
3548
+ * @maxItems 100
3549
+ */
3550
+ CategorySort?: FieldSortOptions[];
3551
+ SmallMultiplesLimitConfiguration?: ItemsLimitConfiguration;
3552
+ }
3553
+ export interface BarChartFieldWells {
3554
+ BarChartAggregatedFieldWells?: BarChartAggregatedFieldWells;
3555
+ }
3556
+ export interface BarChartAggregatedFieldWells {
3557
+ /**
3558
+ * @minItems 0
3559
+ * @maxItems 200
3560
+ */
3561
+ Category?: DimensionField[];
3562
+ /**
3563
+ * @minItems 0
3564
+ * @maxItems 200
3565
+ */
3566
+ Colors?: DimensionField[];
3567
+ /**
3568
+ * @minItems 0
3569
+ * @maxItems 200
3570
+ */
3571
+ Values?: MeasureField[];
3572
+ /**
3573
+ * @minItems 0
3574
+ * @maxItems 1
3575
+ */
3576
+ SmallMultiples?: DimensionField[];
3577
+ }
3578
+ export interface HeatMapVisual {
3579
+ Subtitle?: VisualSubtitleLabelOptions;
3580
+ VisualId: string;
3581
+ ChartConfiguration?: HeatMapConfiguration;
3582
+ /**
3583
+ * @minItems 0
3584
+ * @maxItems 10
3585
+ */
3586
+ Actions?: VisualCustomAction[];
3587
+ Title?: VisualTitleLabelOptions;
3588
+ VisualContentAltText?: string;
3589
+ /**
3590
+ * @minItems 0
3591
+ * @maxItems 2
3592
+ */
3593
+ ColumnHierarchies?: ColumnHierarchy[];
3594
+ }
3595
+ export interface HeatMapConfiguration {
3596
+ SortConfiguration?: HeatMapSortConfiguration;
3597
+ ColumnLabelOptions?: ChartAxisLabelOptions;
3598
+ Legend?: LegendOptions;
3599
+ DataLabels?: DataLabelOptions;
3600
+ FieldWells?: HeatMapFieldWells;
3601
+ Tooltip?: TooltipOptions;
3602
+ ColorScale?: ColorScale;
3603
+ RowLabelOptions?: ChartAxisLabelOptions;
3604
+ }
3605
+ export interface HeatMapSortConfiguration {
3606
+ /**
3607
+ * @minItems 0
3608
+ * @maxItems 100
3609
+ */
3610
+ HeatMapRowSort?: FieldSortOptions[];
3611
+ HeatMapRowItemsLimitConfiguration?: ItemsLimitConfiguration;
3612
+ HeatMapColumnItemsLimitConfiguration?: ItemsLimitConfiguration;
3613
+ /**
3614
+ * @minItems 0
3615
+ * @maxItems 100
3616
+ */
3617
+ HeatMapColumnSort?: FieldSortOptions[];
3618
+ }
3619
+ export interface HeatMapFieldWells {
3620
+ HeatMapAggregatedFieldWells?: HeatMapAggregatedFieldWells;
3621
+ }
3622
+ export interface HeatMapAggregatedFieldWells {
3623
+ /**
3624
+ * @minItems 0
3625
+ * @maxItems 1
3626
+ */
3627
+ Values?: MeasureField[];
3628
+ /**
3629
+ * @minItems 0
3630
+ * @maxItems 1
3631
+ */
3632
+ Columns?: DimensionField[];
3633
+ /**
3634
+ * @minItems 0
3635
+ * @maxItems 1
3636
+ */
3637
+ Rows?: DimensionField[];
3638
+ }
3639
+ export interface ColorScale {
3640
+ /**
3641
+ * @minItems 2
3642
+ * @maxItems 3
3643
+ */
3644
+ Colors: DataColor[];
3645
+ ColorFillType: ColorFillType;
3646
+ NullValueColor?: DataColor;
3647
+ }
3648
+ export interface DataColor {
3649
+ DataValue?: number;
3650
+ Color?: string;
3651
+ }
3652
+ export interface TreeMapVisual {
3653
+ Subtitle?: VisualSubtitleLabelOptions;
3654
+ VisualId: string;
3655
+ ChartConfiguration?: TreeMapConfiguration;
3656
+ /**
3657
+ * @minItems 0
3658
+ * @maxItems 10
3659
+ */
3660
+ Actions?: VisualCustomAction[];
3661
+ Title?: VisualTitleLabelOptions;
3662
+ VisualContentAltText?: string;
3663
+ /**
3664
+ * @minItems 0
3665
+ * @maxItems 2
3666
+ */
3667
+ ColumnHierarchies?: ColumnHierarchy[];
3668
+ }
3669
+ export interface TreeMapConfiguration {
3670
+ SortConfiguration?: TreeMapSortConfiguration;
3671
+ Legend?: LegendOptions;
3672
+ DataLabels?: DataLabelOptions;
3673
+ ColorLabelOptions?: ChartAxisLabelOptions;
3674
+ SizeLabelOptions?: ChartAxisLabelOptions;
3675
+ FieldWells?: TreeMapFieldWells;
3676
+ Tooltip?: TooltipOptions;
3677
+ ColorScale?: ColorScale;
3678
+ GroupLabelOptions?: ChartAxisLabelOptions;
3679
+ }
3680
+ export interface TreeMapSortConfiguration {
3681
+ /**
3682
+ * @minItems 0
3683
+ * @maxItems 100
3684
+ */
3685
+ TreeMapSort?: FieldSortOptions[];
3686
+ TreeMapGroupItemsLimitConfiguration?: ItemsLimitConfiguration;
3687
+ }
3688
+ export interface TreeMapFieldWells {
3689
+ TreeMapAggregatedFieldWells?: TreeMapAggregatedFieldWells;
3690
+ }
3691
+ export interface TreeMapAggregatedFieldWells {
3692
+ /**
3693
+ * @minItems 0
3694
+ * @maxItems 1
3695
+ */
3696
+ Sizes?: MeasureField[];
3697
+ /**
3698
+ * @minItems 0
3699
+ * @maxItems 1
3700
+ */
3701
+ Colors?: MeasureField[];
3702
+ /**
3703
+ * @minItems 0
3704
+ * @maxItems 1
3705
+ */
3706
+ Groups?: DimensionField[];
3707
+ }
3708
+ export interface InsightVisual {
3709
+ Subtitle?: VisualSubtitleLabelOptions;
3710
+ VisualId: string;
3711
+ /**
3712
+ * @minItems 0
3713
+ * @maxItems 10
3714
+ */
3715
+ Actions?: VisualCustomAction[];
3716
+ DataSetIdentifier: string;
3717
+ InsightConfiguration?: InsightConfiguration;
3718
+ Title?: VisualTitleLabelOptions;
3719
+ VisualContentAltText?: string;
3720
+ }
3721
+ export interface InsightConfiguration {
3722
+ /**
3723
+ * @minItems 0
3724
+ * @maxItems 100
3725
+ */
3726
+ Computations?: Computation[];
3727
+ CustomNarrative?: CustomNarrativeOptions;
3728
+ }
3729
+ export interface Computation {
3730
+ PeriodToDate?: PeriodToDateComputation;
3731
+ GrowthRate?: GrowthRateComputation;
3732
+ TopBottomRanked?: TopBottomRankedComputation;
3733
+ TotalAggregation?: TotalAggregationComputation;
3734
+ Forecast?: ForecastComputation;
3735
+ MaximumMinimum?: MaximumMinimumComputation;
3736
+ PeriodOverPeriod?: PeriodOverPeriodComputation;
3737
+ MetricComparison?: MetricComparisonComputation;
3738
+ TopBottomMovers?: TopBottomMoversComputation;
3739
+ UniqueValues?: UniqueValuesComputation;
3740
+ }
3741
+ export interface PeriodToDateComputation {
3742
+ PeriodTimeGranularity?: TimeGranularity;
3743
+ Value?: MeasureField;
3744
+ Time?: DimensionField;
3745
+ ComputationId: string;
3746
+ Name?: string;
3747
+ }
3748
+ export interface GrowthRateComputation {
3749
+ Value?: MeasureField;
3750
+ Time?: DimensionField;
3751
+ PeriodSize?: number;
3752
+ ComputationId: string;
3753
+ Name?: string;
3754
+ }
3755
+ export interface TopBottomRankedComputation {
3756
+ Type: TopBottomComputationType;
3757
+ Category?: DimensionField;
3758
+ ResultSize?: number;
3759
+ Value?: MeasureField;
3760
+ ComputationId: string;
3761
+ Name?: string;
3762
+ }
3763
+ export interface TotalAggregationComputation {
3764
+ Value?: MeasureField;
3765
+ ComputationId: string;
3766
+ Name?: string;
3767
+ }
3768
+ export interface ForecastComputation {
3769
+ PeriodsBackward?: number;
3770
+ PeriodsForward?: number;
3771
+ PredictionInterval?: number;
3772
+ Seasonality?: ForecastComputationSeasonality;
3773
+ CustomSeasonalityValue?: number;
3774
+ Value?: MeasureField;
3775
+ Time?: DimensionField;
3776
+ UpperBoundary?: number;
3777
+ ComputationId: string;
3778
+ Name?: string;
3779
+ LowerBoundary?: number;
3780
+ }
3781
+ export interface MaximumMinimumComputation {
3782
+ Type: MaximumMinimumComputationType;
3783
+ Value?: MeasureField;
3784
+ Time?: DimensionField;
3785
+ ComputationId: string;
3786
+ Name?: string;
3787
+ }
3788
+ export interface PeriodOverPeriodComputation {
3789
+ Value?: MeasureField;
3790
+ Time?: DimensionField;
3791
+ ComputationId: string;
3792
+ Name?: string;
3793
+ }
3794
+ export interface MetricComparisonComputation {
3795
+ TargetValue?: MeasureField;
3796
+ Time?: DimensionField;
3797
+ ComputationId: string;
3798
+ FromValue?: MeasureField;
3799
+ Name?: string;
3800
+ }
3801
+ export interface TopBottomMoversComputation {
3802
+ Type: TopBottomComputationType;
3803
+ Category?: DimensionField;
3804
+ Value?: MeasureField;
3805
+ SortOrder?: TopBottomSortOrder;
3806
+ Time?: DimensionField;
3807
+ MoverSize?: number;
3808
+ ComputationId: string;
3809
+ Name?: string;
3810
+ }
3811
+ export interface UniqueValuesComputation {
3812
+ Category?: DimensionField;
3813
+ ComputationId: string;
3814
+ Name?: string;
3815
+ }
3816
+ export interface CustomNarrativeOptions {
3817
+ Narrative: string;
3818
+ }
3819
+ export interface LineChartVisual {
3820
+ Subtitle?: VisualSubtitleLabelOptions;
3821
+ VisualId: string;
3822
+ ChartConfiguration?: LineChartConfiguration;
3823
+ /**
3824
+ * @minItems 0
3825
+ * @maxItems 10
3826
+ */
3827
+ Actions?: VisualCustomAction[];
3828
+ Title?: VisualTitleLabelOptions;
3829
+ VisualContentAltText?: string;
3830
+ /**
3831
+ * @minItems 0
3832
+ * @maxItems 2
3833
+ */
3834
+ ColumnHierarchies?: ColumnHierarchy[];
3835
+ }
3836
+ export interface LineChartConfiguration {
3837
+ SortConfiguration?: LineChartSortConfiguration;
3838
+ Legend?: LegendOptions;
3839
+ /**
3840
+ * @minItems 0
3841
+ * @maxItems 20
3842
+ */
3843
+ ReferenceLines?: ReferenceLine[];
3844
+ DataLabels?: DataLabelOptions;
3845
+ Tooltip?: TooltipOptions;
3846
+ SingleAxisOptions?: SingleAxisOptions;
3847
+ SmallMultiplesOptions?: SmallMultiplesOptions;
3848
+ PrimaryYAxisDisplayOptions?: LineSeriesAxisDisplayOptions;
3849
+ VisualPalette?: VisualPalette;
3850
+ XAxisDisplayOptions?: AxisDisplayOptions;
3851
+ DefaultSeriesSettings?: LineChartDefaultSeriesSettings;
3852
+ SecondaryYAxisLabelOptions?: ChartAxisLabelOptions;
3853
+ /**
3854
+ * @minItems 0
3855
+ * @maxItems 10
3856
+ */
3857
+ ForecastConfigurations?: ForecastConfiguration[];
3858
+ /**
3859
+ * @minItems 0
3860
+ * @maxItems 2000
3861
+ */
3862
+ Series?: SeriesItem[];
3863
+ Type?: LineChartType;
3864
+ PrimaryYAxisLabelOptions?: ChartAxisLabelOptions;
3865
+ /**
3866
+ * @minItems 1
3867
+ * @maxItems 200
3868
+ */
3869
+ ContributionAnalysisDefaults?: ContributionAnalysisDefault[];
3870
+ FieldWells?: LineChartFieldWells;
3871
+ SecondaryYAxisDisplayOptions?: LineSeriesAxisDisplayOptions;
3872
+ XAxisLabelOptions?: ChartAxisLabelOptions;
3873
+ }
3874
+ export interface LineChartSortConfiguration {
3875
+ CategoryItemsLimitConfiguration?: ItemsLimitConfiguration;
3876
+ ColorItemsLimitConfiguration?: ItemsLimitConfiguration;
3877
+ /**
3878
+ * @minItems 0
3879
+ * @maxItems 100
3880
+ */
3881
+ SmallMultiplesSort?: FieldSortOptions[];
3882
+ /**
3883
+ * @minItems 0
3884
+ * @maxItems 100
3885
+ */
3886
+ CategorySort?: FieldSortOptions[];
3887
+ SmallMultiplesLimitConfiguration?: ItemsLimitConfiguration;
3888
+ }
3889
+ export interface LineSeriesAxisDisplayOptions {
3890
+ /**
3891
+ * @minItems 0
3892
+ * @maxItems 100
3893
+ */
3894
+ MissingDataConfigurations?: MissingDataConfiguration[];
3895
+ AxisOptions?: AxisDisplayOptions;
3896
+ }
3897
+ export interface MissingDataConfiguration {
3898
+ TreatmentOption?: MissingDataTreatmentOption;
3899
+ }
3900
+ export interface LineChartDefaultSeriesSettings {
3901
+ LineStyleSettings?: LineChartLineStyleSettings;
3902
+ AxisBinding?: AxisBinding;
3903
+ MarkerStyleSettings?: LineChartMarkerStyleSettings;
3904
+ }
3905
+ export interface LineChartLineStyleSettings {
3906
+ LineInterpolation?: LineInterpolation;
3907
+ LineStyle?: LineChartLineStyle;
3908
+ LineVisibility?: Visibility;
3909
+ /**
3910
+ * String based length that is composed of value and unit in px
3911
+ */
3912
+ LineWidth?: string;
3913
+ }
3914
+ export interface LineChartMarkerStyleSettings {
3915
+ MarkerShape?: LineChartMarkerShape;
3916
+ /**
3917
+ * String based length that is composed of value and unit in px
3918
+ */
3919
+ MarkerSize?: string;
3920
+ MarkerVisibility?: Visibility;
3921
+ MarkerColor?: string;
3922
+ }
3923
+ export interface ForecastConfiguration {
3924
+ ForecastProperties?: TimeBasedForecastProperties;
3925
+ Scenario?: ForecastScenario;
3926
+ }
3927
+ export interface TimeBasedForecastProperties {
3928
+ PeriodsBackward?: number;
3929
+ PeriodsForward?: number;
3930
+ PredictionInterval?: number;
3931
+ Seasonality?: number;
3932
+ UpperBoundary?: number;
3933
+ LowerBoundary?: number;
3934
+ }
3935
+ export interface ForecastScenario {
3936
+ WhatIfRangeScenario?: WhatIfRangeScenario;
3937
+ WhatIfPointScenario?: WhatIfPointScenario;
3938
+ }
3939
+ export interface WhatIfRangeScenario {
3940
+ StartDate: string;
3941
+ Value: number;
3942
+ EndDate: string;
3943
+ }
3944
+ export interface WhatIfPointScenario {
3945
+ Value: number;
3946
+ Date: string;
3947
+ }
3948
+ export interface SeriesItem {
3949
+ FieldSeriesItem?: FieldSeriesItem;
3950
+ DataFieldSeriesItem?: DataFieldSeriesItem;
3951
+ }
3952
+ export interface FieldSeriesItem {
3953
+ FieldId: string;
3954
+ AxisBinding: AxisBinding;
3955
+ Settings?: LineChartSeriesSettings;
3956
+ }
3957
+ export interface LineChartSeriesSettings {
3958
+ LineStyleSettings?: LineChartLineStyleSettings;
3959
+ MarkerStyleSettings?: LineChartMarkerStyleSettings;
3960
+ }
3961
+ export interface DataFieldSeriesItem {
3962
+ FieldId: string;
3963
+ AxisBinding: AxisBinding;
3964
+ FieldValue?: string;
3965
+ Settings?: LineChartSeriesSettings;
3966
+ }
3967
+ export interface LineChartFieldWells {
3968
+ LineChartAggregatedFieldWells?: LineChartAggregatedFieldWells;
3969
+ }
3970
+ export interface LineChartAggregatedFieldWells {
3971
+ /**
3972
+ * @minItems 0
3973
+ * @maxItems 200
3974
+ */
3975
+ Category?: DimensionField[];
3976
+ /**
3977
+ * @minItems 0
3978
+ * @maxItems 200
3979
+ */
3980
+ Colors?: DimensionField[];
3981
+ /**
3982
+ * @minItems 0
3983
+ * @maxItems 200
3984
+ */
3985
+ Values?: MeasureField[];
3986
+ /**
3987
+ * @minItems 0
3988
+ * @maxItems 1
3989
+ */
3990
+ SmallMultiples?: DimensionField[];
3991
+ }
3992
+ export interface EmptyVisual {
3993
+ VisualId: string;
3994
+ /**
3995
+ * @minItems 0
3996
+ * @maxItems 10
3997
+ */
3998
+ Actions?: VisualCustomAction[];
3999
+ DataSetIdentifier: string;
4000
+ }
4001
+ export interface ParameterDeclaration {
4002
+ StringParameterDeclaration?: StringParameterDeclaration;
4003
+ DateTimeParameterDeclaration?: DateTimeParameterDeclaration;
4004
+ DecimalParameterDeclaration?: DecimalParameterDeclaration;
4005
+ IntegerParameterDeclaration?: IntegerParameterDeclaration;
4006
+ }
4007
+ export interface StringParameterDeclaration {
4008
+ /**
4009
+ * @minItems 0
4010
+ * @maxItems 150
4011
+ */
4012
+ MappedDataSetParameters?: MappedDataSetParameter[];
4013
+ DefaultValues?: StringDefaultValues;
4014
+ ParameterValueType: ParameterValueType;
4015
+ ValueWhenUnset?: StringValueWhenUnsetConfiguration;
4016
+ Name: string;
4017
+ }
4018
+ export interface MappedDataSetParameter {
4019
+ DataSetParameterName: string;
4020
+ DataSetIdentifier: string;
4021
+ }
4022
+ export interface StringDefaultValues {
4023
+ DynamicValue?: DynamicDefaultValue;
4024
+ /**
4025
+ * @minItems 0
4026
+ * @maxItems 50000
4027
+ */
4028
+ StaticValues?: string[];
4029
+ }
4030
+ export interface DynamicDefaultValue {
4031
+ GroupNameColumn?: ColumnIdentifier;
4032
+ DefaultValueColumn: ColumnIdentifier;
4033
+ UserNameColumn?: ColumnIdentifier;
4034
+ }
4035
+ export interface StringValueWhenUnsetConfiguration {
4036
+ ValueWhenUnsetOption?: ValueWhenUnsetOption;
4037
+ CustomValue?: string;
4038
+ }
4039
+ export interface DateTimeParameterDeclaration {
4040
+ /**
4041
+ * @minItems 0
4042
+ * @maxItems 150
4043
+ */
4044
+ MappedDataSetParameters?: MappedDataSetParameter[];
4045
+ DefaultValues?: DateTimeDefaultValues;
4046
+ TimeGranularity?: TimeGranularity;
4047
+ ValueWhenUnset?: DateTimeValueWhenUnsetConfiguration;
4048
+ Name: string;
4049
+ }
4050
+ export interface DateTimeDefaultValues {
4051
+ RollingDate?: RollingDateConfiguration;
4052
+ DynamicValue?: DynamicDefaultValue;
4053
+ /**
4054
+ * @minItems 0
4055
+ * @maxItems 50000
4056
+ */
4057
+ StaticValues?: string[];
4058
+ }
4059
+ export interface DateTimeValueWhenUnsetConfiguration {
4060
+ ValueWhenUnsetOption?: ValueWhenUnsetOption;
4061
+ CustomValue?: string;
4062
+ }
4063
+ export interface DecimalParameterDeclaration {
4064
+ /**
4065
+ * @minItems 0
4066
+ * @maxItems 150
4067
+ */
4068
+ MappedDataSetParameters?: MappedDataSetParameter[];
4069
+ DefaultValues?: DecimalDefaultValues;
4070
+ ParameterValueType: ParameterValueType;
4071
+ ValueWhenUnset?: DecimalValueWhenUnsetConfiguration;
4072
+ Name: string;
4073
+ }
4074
+ export interface DecimalDefaultValues {
4075
+ DynamicValue?: DynamicDefaultValue;
4076
+ /**
4077
+ * @minItems 0
4078
+ * @maxItems 50000
4079
+ */
4080
+ StaticValues?: number[];
4081
+ }
4082
+ export interface DecimalValueWhenUnsetConfiguration {
4083
+ ValueWhenUnsetOption?: ValueWhenUnsetOption;
4084
+ CustomValue?: number;
4085
+ }
4086
+ export interface IntegerParameterDeclaration {
4087
+ /**
4088
+ * @minItems 0
4089
+ * @maxItems 150
4090
+ */
4091
+ MappedDataSetParameters?: MappedDataSetParameter[];
4092
+ DefaultValues?: IntegerDefaultValues;
4093
+ ParameterValueType: ParameterValueType;
4094
+ ValueWhenUnset?: IntegerValueWhenUnsetConfiguration;
4095
+ Name: string;
4096
+ }
4097
+ export interface IntegerDefaultValues {
4098
+ DynamicValue?: DynamicDefaultValue;
4099
+ /**
4100
+ * @minItems 0
4101
+ * @maxItems 50000
4102
+ */
4103
+ StaticValues?: number[];
4104
+ }
4105
+ export interface IntegerValueWhenUnsetConfiguration {
4106
+ ValueWhenUnsetOption?: ValueWhenUnsetOption;
4107
+ CustomValue?: number;
4108
+ }
4109
+ /**
4110
+ * <p>The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to <code>LENIENT</code>, validation is skipped for specific errors.</p>
4111
+ */
4112
+ export interface ValidationStrategy {
4113
+ Mode: ValidationStrategyMode;
4114
+ }
4115
+ export interface LinkSharingConfiguration {
4116
+ /**
4117
+ * @minItems 1
4118
+ * @maxItems 64
4119
+ */
4120
+ Permissions?: ResourcePermission[];
4121
+ }
4122
+ /**
4123
+ * <p>Permission for the resource.</p>
4124
+ */
4125
+ export interface ResourcePermission {
4126
+ /**
4127
+ * <p>The IAM action to grant or revoke permissions on.</p>
4128
+ *
4129
+ * @minItems 1
4130
+ * @maxItems 20
4131
+ */
4132
+ Actions: string[];
4133
+ /**
4134
+ * <p>The Amazon Resource Name (ARN) of the principal. This can be one of the
4135
+ * following:</p>
4136
+ * <ul>
4137
+ * <li>
4138
+ * <p>The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)</p>
4139
+ * </li>
4140
+ * <li>
4141
+ * <p>The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)</p>
4142
+ * </li>
4143
+ * <li>
4144
+ * <p>The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight
4145
+ * ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.
4146
+ * (This is less common.) </p>
4147
+ * </li>
4148
+ * </ul>
4149
+ */
4150
+ Principal: string;
4151
+ }
4152
+ /**
4153
+ * <p>Dashboard publish options.</p>
4154
+ */
4155
+ export interface DashboardPublishOptions {
4156
+ SheetControlsOption?: SheetControlsOption;
4157
+ ExportToCSVOption?: ExportToCSVOption;
4158
+ DataPointMenuLabelOption?: DataPointMenuLabelOption;
4159
+ DataPointDrillUpDownOption?: DataPointDrillUpDownOption;
4160
+ AdHocFilteringOption?: AdHocFilteringOption;
4161
+ VisualPublishOptions?: DashboardVisualPublishOptions;
4162
+ VisualMenuOption?: unknown;
4163
+ DataPointTooltipOption?: DataPointTooltipOption;
4164
+ VisualAxisSortOption?: VisualAxisSortOption;
4165
+ ExportWithHiddenFieldsOption?: ExportWithHiddenFieldsOption;
4166
+ SheetLayoutElementMaximizationOption?: SheetLayoutElementMaximizationOption;
4167
+ }
4168
+ /**
4169
+ * <p>Sheet controls option.</p>
4170
+ */
4171
+ export interface SheetControlsOption {
4172
+ VisibilityState?: DashboardUIState;
4173
+ }
4174
+ /**
4175
+ * <p>Export to .csv option.</p>
4176
+ */
4177
+ export interface ExportToCSVOption {
4178
+ AvailabilityStatus?: DashboardBehavior;
4179
+ }
4180
+ /**
4181
+ * <p>The data point menu options of a dashboard.</p>
4182
+ */
4183
+ export interface DataPointMenuLabelOption {
4184
+ AvailabilityStatus?: DashboardBehavior;
4185
+ }
4186
+ /**
4187
+ * <p>The drill down options for data points in a dashbaord.</p>
4188
+ */
4189
+ export interface DataPointDrillUpDownOption {
4190
+ AvailabilityStatus?: DashboardBehavior;
4191
+ }
4192
+ /**
4193
+ * <p>An ad hoc (one-time) filtering option.</p>
4194
+ */
4195
+ export interface AdHocFilteringOption {
4196
+ AvailabilityStatus?: DashboardBehavior;
4197
+ }
4198
+ /**
4199
+ * <p>The visual publish options of a visual in a dashboard</p>
4200
+ */
4201
+ export interface DashboardVisualPublishOptions {
4202
+ ExportHiddenFieldsOption?: ExportHiddenFieldsOption;
4203
+ }
4204
+ /**
4205
+ * <p>Determines if hidden fields are included in an exported dashboard.</p>
4206
+ */
4207
+ export interface ExportHiddenFieldsOption {
4208
+ AvailabilityStatus?: DashboardBehavior;
4209
+ }
4210
+ /**
4211
+ * <p>The data point tooltip options.</p>
4212
+ */
4213
+ export interface DataPointTooltipOption {
4214
+ AvailabilityStatus?: DashboardBehavior;
4215
+ }
4216
+ export interface VisualAxisSortOption {
4217
+ AvailabilityStatus?: DashboardBehavior;
4218
+ }
4219
+ /**
4220
+ * <p>Determines whether or not hidden fields are visible on exported dashbaords.</p>
4221
+ */
4222
+ export interface ExportWithHiddenFieldsOption {
4223
+ AvailabilityStatus?: DashboardBehavior;
4224
+ }
4225
+ /**
4226
+ * <p>The sheet layout maximization options of a dashbaord.</p>
4227
+ */
4228
+ export interface SheetLayoutElementMaximizationOption {
4229
+ AvailabilityStatus?: DashboardBehavior;
4230
+ }
4231
+ /**
4232
+ * <p>Dashboard version.</p>
4233
+ */
4234
+ export interface DashboardVersion {
4235
+ Status?: ResourceStatus;
4236
+ /**
4237
+ * <p>Errors associated with this dashboard version.</p>
4238
+ *
4239
+ * @minItems 1
4240
+ */
4241
+ Errors?: DashboardError[];
4242
+ /**
4243
+ * <p>The time that this dashboard version was created.</p>
4244
+ */
4245
+ CreatedTime?: string;
4246
+ /**
4247
+ * <p>Description.</p>
4248
+ */
4249
+ Description?: string;
4250
+ /**
4251
+ * <p>The Amazon Resource Numbers (ARNs) for the datasets that are associated with this
4252
+ * version of the dashboard.</p>
4253
+ *
4254
+ * @minItems 0
4255
+ * @maxItems 100
4256
+ */
4257
+ DataSetArns?: string[];
4258
+ /**
4259
+ * <p>The ARN of the theme associated with a version of the dashboard.</p>
4260
+ */
4261
+ ThemeArn?: string;
4262
+ /**
4263
+ * <p>The Amazon Resource Name (ARN) of the resource.</p>
4264
+ */
4265
+ Arn?: string;
4266
+ /**
4267
+ * <p>Source entity ARN.</p>
4268
+ */
4269
+ SourceEntityArn?: string;
4270
+ /**
4271
+ * <p>Version number for this version of the dashboard.</p>
4272
+ */
4273
+ VersionNumber?: number;
4274
+ /**
4275
+ * <p>A list of the associated sheets with the unique identifier and name of each sheet.</p>
4276
+ *
4277
+ * @minItems 0
4278
+ * @maxItems 20
4279
+ */
4280
+ Sheets?: Sheet[];
4281
+ }
4282
+ /**
4283
+ * <p>Dashboard error.</p>
4284
+ */
4285
+ export interface DashboardError {
4286
+ Type?: DashboardErrorType;
4287
+ /**
4288
+ * <p>Message.</p>
4289
+ */
4290
+ Message?: string;
4291
+ /**
4292
+ * <p>Lists the violated entities that caused the dashboard error.</p>
4293
+ *
4294
+ * @minItems 0
4295
+ * @maxItems 200
4296
+ */
4297
+ ViolatedEntities?: Entity[];
4298
+ }
4299
+ export interface Entity {
4300
+ Path?: string;
4301
+ }
4302
+ /**
4303
+ * <p>A <i>sheet</i>, which is an object that contains a set of visuals that
4304
+ * are viewed together on one page in Amazon QuickSight. Every analysis and dashboard
4305
+ * contains at least one sheet. Each sheet contains at least one visualization widget, for
4306
+ * example a chart, pivot table, or narrative insight. Sheets can be associated with other
4307
+ * components, such as controls, filters, and so on.</p>
4308
+ */
4309
+ export interface Sheet {
4310
+ /**
4311
+ * <p>The unique identifier associated with a sheet.</p>
4312
+ */
4313
+ SheetId?: string;
4314
+ /**
4315
+ * @minItems 0
4316
+ * @maxItems 10
4317
+ */
4318
+ Images?: SheetImage[];
4319
+ /**
4320
+ * <p>The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight
4321
+ * console.</p>
4322
+ */
4323
+ Name?: string;
4324
+ }
4325
+ /**
4326
+ * <p>The key or keys of the key-value pairs for the resource tag or tags assigned to the
4327
+ * resource.</p>
4328
+ */
4329
+ export interface Tag {
4330
+ /**
4331
+ * <p>Tag value.</p>
4332
+ */
4333
+ Value: string;
4334
+ /**
4335
+ * <p>Tag key.</p>
4336
+ */
4337
+ Key: string;
4338
+ }