@aws-sdk/client-quicksight 3.369.0 → 3.376.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (139) hide show
  1. package/README.md +24 -0
  2. package/dist-cjs/QuickSight.js +6 -0
  3. package/dist-cjs/commands/DescribeDashboardSnapshotJobCommand.js +47 -0
  4. package/dist-cjs/commands/DescribeDashboardSnapshotJobResultCommand.js +47 -0
  5. package/dist-cjs/commands/StartDashboardSnapshotJobCommand.js +47 -0
  6. package/dist-cjs/commands/UpdateDataSetCommand.js +2 -2
  7. package/dist-cjs/commands/UpdateDataSourceCommand.js +2 -2
  8. package/dist-cjs/commands/UpdateTemplateCommand.js +2 -2
  9. package/dist-cjs/commands/index.js +3 -0
  10. package/dist-cjs/models/models_0.js +6 -12
  11. package/dist-cjs/models/models_1.js +35 -26
  12. package/dist-cjs/models/models_2.js +25 -3
  13. package/dist-cjs/models/models_3.js +39 -24
  14. package/dist-cjs/models/models_4.js +26 -1
  15. package/dist-cjs/pagination/ListGroupMembershipsPaginator.js +29 -0
  16. package/dist-cjs/pagination/ListGroupsPaginator.js +29 -0
  17. package/dist-cjs/pagination/ListIAMPolicyAssignmentsForUserPaginator.js +29 -0
  18. package/dist-cjs/pagination/ListIAMPolicyAssignmentsPaginator.js +29 -0
  19. package/dist-cjs/pagination/ListUserGroupsPaginator.js +29 -0
  20. package/dist-cjs/pagination/ListUsersPaginator.js +29 -0
  21. package/dist-cjs/pagination/SearchGroupsPaginator.js +29 -0
  22. package/dist-cjs/pagination/index.js +7 -0
  23. package/dist-cjs/protocols/Aws_restJson1.js +326 -6
  24. package/dist-es/QuickSight.js +6 -0
  25. package/dist-es/commands/DescribeDashboardSnapshotJobCommand.js +43 -0
  26. package/dist-es/commands/DescribeDashboardSnapshotJobResultCommand.js +43 -0
  27. package/dist-es/commands/StartDashboardSnapshotJobCommand.js +43 -0
  28. package/dist-es/commands/UpdateDataSetCommand.js +1 -1
  29. package/dist-es/commands/UpdateDataSourceCommand.js +1 -1
  30. package/dist-es/commands/UpdateTemplateCommand.js +1 -1
  31. package/dist-es/commands/index.js +3 -0
  32. package/dist-es/models/models_0.js +3 -7
  33. package/dist-es/models/models_1.js +26 -22
  34. package/dist-es/models/models_2.js +22 -0
  35. package/dist-es/models/models_3.js +30 -19
  36. package/dist-es/models/models_4.js +22 -0
  37. package/dist-es/pagination/ListGroupMembershipsPaginator.js +25 -0
  38. package/dist-es/pagination/ListGroupsPaginator.js +25 -0
  39. package/dist-es/pagination/ListIAMPolicyAssignmentsForUserPaginator.js +25 -0
  40. package/dist-es/pagination/ListIAMPolicyAssignmentsPaginator.js +25 -0
  41. package/dist-es/pagination/ListUserGroupsPaginator.js +25 -0
  42. package/dist-es/pagination/ListUsersPaginator.js +25 -0
  43. package/dist-es/pagination/SearchGroupsPaginator.js +25 -0
  44. package/dist-es/pagination/index.js +7 -0
  45. package/dist-es/protocols/Aws_restJson1.js +314 -0
  46. package/dist-types/QuickSight.d.ts +21 -0
  47. package/dist-types/QuickSightClient.d.ts +5 -2
  48. package/dist-types/commands/CreateAnalysisCommand.d.ts +48 -0
  49. package/dist-types/commands/CreateDashboardCommand.d.ts +48 -0
  50. package/dist-types/commands/CreateTemplateCommand.d.ts +48 -0
  51. package/dist-types/commands/DeleteAccountCustomizationCommand.d.ts +6 -0
  52. package/dist-types/commands/DeleteAccountSubscriptionCommand.d.ts +1 -1
  53. package/dist-types/commands/DeleteAnalysisCommand.d.ts +1 -1
  54. package/dist-types/commands/DeleteDashboardCommand.d.ts +1 -1
  55. package/dist-types/commands/DeleteDataSetCommand.d.ts +1 -1
  56. package/dist-types/commands/DeleteDataSetRefreshPropertiesCommand.d.ts +1 -1
  57. package/dist-types/commands/DeleteDataSourceCommand.d.ts +1 -1
  58. package/dist-types/commands/DeleteFolderCommand.d.ts +1 -2
  59. package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +48 -0
  60. package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +48 -0
  61. package/dist-types/commands/DescribeDashboardSnapshotJobCommand.d.ts +179 -0
  62. package/dist-types/commands/DescribeDashboardSnapshotJobResultCommand.d.ts +155 -0
  63. package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +48 -0
  64. package/dist-types/commands/StartDashboardSnapshotJobCommand.d.ts +197 -0
  65. package/dist-types/commands/UpdateAnalysisCommand.d.ts +48 -0
  66. package/dist-types/commands/UpdateDashboardCommand.d.ts +48 -0
  67. package/dist-types/commands/UpdateDashboardPermissionsCommand.d.ts +1 -1
  68. package/dist-types/commands/UpdateDashboardPublishedVersionCommand.d.ts +1 -1
  69. package/dist-types/commands/UpdateDataSetCommand.d.ts +1 -1
  70. package/dist-types/commands/UpdateDataSetPermissionsCommand.d.ts +1 -1
  71. package/dist-types/commands/UpdateDataSourceCommand.d.ts +1 -1
  72. package/dist-types/commands/UpdateDataSourcePermissionsCommand.d.ts +1 -1
  73. package/dist-types/commands/UpdateFolderCommand.d.ts +1 -1
  74. package/dist-types/commands/UpdateFolderPermissionsCommand.d.ts +1 -1
  75. package/dist-types/commands/UpdateGroupCommand.d.ts +1 -1
  76. package/dist-types/commands/UpdateIAMPolicyAssignmentCommand.d.ts +1 -1
  77. package/dist-types/commands/UpdateIpRestrictionCommand.d.ts +1 -1
  78. package/dist-types/commands/UpdatePublicSharingSettingsCommand.d.ts +1 -1
  79. package/dist-types/commands/UpdateRefreshScheduleCommand.d.ts +1 -1
  80. package/dist-types/commands/UpdateTemplateAliasCommand.d.ts +1 -2
  81. package/dist-types/commands/UpdateTemplateCommand.d.ts +49 -1
  82. package/dist-types/commands/index.d.ts +3 -0
  83. package/dist-types/models/models_0.d.ts +77 -47
  84. package/dist-types/models/models_1.d.ts +208 -213
  85. package/dist-types/models/models_2.d.ts +219 -220
  86. package/dist-types/models/models_3.d.ts +602 -805
  87. package/dist-types/models/models_4.d.ts +770 -2
  88. package/dist-types/pagination/ListGroupMembershipsPaginator.d.ts +7 -0
  89. package/dist-types/pagination/ListGroupsPaginator.d.ts +7 -0
  90. package/dist-types/pagination/ListIAMPolicyAssignmentsForUserPaginator.d.ts +7 -0
  91. package/dist-types/pagination/ListIAMPolicyAssignmentsPaginator.d.ts +7 -0
  92. package/dist-types/pagination/ListUserGroupsPaginator.d.ts +7 -0
  93. package/dist-types/pagination/ListUsersPaginator.d.ts +7 -0
  94. package/dist-types/pagination/SearchGroupsPaginator.d.ts +7 -0
  95. package/dist-types/pagination/index.d.ts +7 -0
  96. package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
  97. package/dist-types/ts3.4/QuickSight.d.ts +57 -0
  98. package/dist-types/ts3.4/QuickSightClient.d.ts +18 -0
  99. package/dist-types/ts3.4/commands/DeleteAccountSubscriptionCommand.d.ts +1 -1
  100. package/dist-types/ts3.4/commands/DeleteAnalysisCommand.d.ts +1 -1
  101. package/dist-types/ts3.4/commands/DeleteDashboardCommand.d.ts +1 -1
  102. package/dist-types/ts3.4/commands/DeleteDataSetCommand.d.ts +1 -1
  103. package/dist-types/ts3.4/commands/DeleteDataSetRefreshPropertiesCommand.d.ts +1 -1
  104. package/dist-types/ts3.4/commands/DeleteDataSourceCommand.d.ts +1 -1
  105. package/dist-types/ts3.4/commands/DeleteFolderCommand.d.ts +1 -2
  106. package/dist-types/ts3.4/commands/DescribeDashboardSnapshotJobCommand.d.ts +42 -0
  107. package/dist-types/ts3.4/commands/DescribeDashboardSnapshotJobResultCommand.d.ts +42 -0
  108. package/dist-types/ts3.4/commands/StartDashboardSnapshotJobCommand.d.ts +42 -0
  109. package/dist-types/ts3.4/commands/UpdateDashboardPermissionsCommand.d.ts +1 -1
  110. package/dist-types/ts3.4/commands/UpdateDashboardPublishedVersionCommand.d.ts +1 -1
  111. package/dist-types/ts3.4/commands/UpdateDataSetCommand.d.ts +1 -1
  112. package/dist-types/ts3.4/commands/UpdateDataSetPermissionsCommand.d.ts +1 -1
  113. package/dist-types/ts3.4/commands/UpdateDataSourceCommand.d.ts +1 -1
  114. package/dist-types/ts3.4/commands/UpdateDataSourcePermissionsCommand.d.ts +1 -1
  115. package/dist-types/ts3.4/commands/UpdateFolderCommand.d.ts +1 -1
  116. package/dist-types/ts3.4/commands/UpdateFolderPermissionsCommand.d.ts +1 -1
  117. package/dist-types/ts3.4/commands/UpdateGroupCommand.d.ts +1 -1
  118. package/dist-types/ts3.4/commands/UpdateIAMPolicyAssignmentCommand.d.ts +1 -1
  119. package/dist-types/ts3.4/commands/UpdateIpRestrictionCommand.d.ts +1 -1
  120. package/dist-types/ts3.4/commands/UpdatePublicSharingSettingsCommand.d.ts +1 -1
  121. package/dist-types/ts3.4/commands/UpdateRefreshScheduleCommand.d.ts +1 -1
  122. package/dist-types/ts3.4/commands/UpdateTemplateAliasCommand.d.ts +4 -2
  123. package/dist-types/ts3.4/commands/UpdateTemplateCommand.d.ts +1 -1
  124. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  125. package/dist-types/ts3.4/models/models_0.d.ts +21 -17
  126. package/dist-types/ts3.4/models/models_1.d.ts +71 -81
  127. package/dist-types/ts3.4/models/models_2.d.ts +85 -67
  128. package/dist-types/ts3.4/models/models_3.d.ts +176 -222
  129. package/dist-types/ts3.4/models/models_4.d.ts +222 -1
  130. package/dist-types/ts3.4/pagination/ListGroupMembershipsPaginator.d.ts +11 -0
  131. package/dist-types/ts3.4/pagination/ListGroupsPaginator.d.ts +11 -0
  132. package/dist-types/ts3.4/pagination/ListIAMPolicyAssignmentsForUserPaginator.d.ts +11 -0
  133. package/dist-types/ts3.4/pagination/ListIAMPolicyAssignmentsPaginator.d.ts +11 -0
  134. package/dist-types/ts3.4/pagination/ListUserGroupsPaginator.d.ts +11 -0
  135. package/dist-types/ts3.4/pagination/ListUsersPaginator.d.ts +11 -0
  136. package/dist-types/ts3.4/pagination/SearchGroupsPaginator.d.ts +11 -0
  137. package/dist-types/ts3.4/pagination/index.d.ts +7 -0
  138. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
  139. package/package.json +16 -17
package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts CHANGED
@@ -96,6 +96,10 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi
96
96
  * // CustomLabel: "STRING_VALUE",
97
97
  * // },
98
98
  * // DateTimeFormat: "STRING_VALUE",
99
+ * // InfoIconLabelOptions: { // SheetControlInfoIconLabelOptions
100
+ * // Visibility: "HIDDEN" || "VISIBLE",
101
+ * // InfoIconText: "STRING_VALUE",
102
+ * // },
99
103
  * // },
100
104
  * // },
101
105
  * // List: { // ParameterListControl
@@ -124,6 +128,10 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi
124
128
  * // },
125
129
  * // CustomLabel: "STRING_VALUE",
126
130
  * // },
131
+ * // InfoIconLabelOptions: {
132
+ * // Visibility: "HIDDEN" || "VISIBLE",
133
+ * // InfoIconText: "STRING_VALUE",
134
+ * // },
127
135
  * // },
128
136
  * // Type: "MULTI_SELECT" || "SINGLE_SELECT",
129
137
  * // SelectableValues: { // ParameterSelectableValues
@@ -170,6 +178,10 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi
170
178
  * // },
171
179
  * // CustomLabel: "STRING_VALUE",
172
180
  * // },
181
+ * // InfoIconLabelOptions: {
182
+ * // Visibility: "HIDDEN" || "VISIBLE",
183
+ * // InfoIconText: "STRING_VALUE",
184
+ * // },
173
185
  * // },
174
186
  * // Type: "MULTI_SELECT" || "SINGLE_SELECT",
175
187
  * // SelectableValues: {
@@ -216,6 +228,10 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi
216
228
  * // PlaceholderOptions: { // TextControlPlaceholderOptions
217
229
  * // Visibility: "HIDDEN" || "VISIBLE",
218
230
  * // },
231
+ * // InfoIconLabelOptions: {
232
+ * // Visibility: "HIDDEN" || "VISIBLE",
233
+ * // InfoIconText: "STRING_VALUE",
234
+ * // },
219
235
  * // },
220
236
  * // },
221
237
  * // TextArea: { // ParameterTextAreaControl
@@ -242,6 +258,10 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi
242
258
  * // PlaceholderOptions: {
243
259
  * // Visibility: "HIDDEN" || "VISIBLE",
244
260
  * // },
261
+ * // InfoIconLabelOptions: {
262
+ * // Visibility: "HIDDEN" || "VISIBLE",
263
+ * // InfoIconText: "STRING_VALUE",
264
+ * // },
245
265
  * // },
246
266
  * // },
247
267
  * // Slider: { // ParameterSliderControl
@@ -250,6 +270,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi
250
270
  * // SourceParameterName: "STRING_VALUE", // required
251
271
  * // DisplayOptions: { // SliderControlDisplayOptions
252
272
  * // TitleOptions: "<LabelOptions>",
273
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
253
274
  * // },
254
275
  * // MaximumValue: Number("double"), // required
255
276
  * // MinimumValue: Number("double"), // required
@@ -266,6 +287,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi
266
287
  * // DisplayOptions: {
267
288
  * // TitleOptions: "<LabelOptions>",
268
289
  * // DateTimeFormat: "STRING_VALUE",
290
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
269
291
  * // },
270
292
  * // Type: "SINGLE_VALUED" || "DATE_RANGE",
271
293
  * // },
@@ -281,6 +303,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi
281
303
  * // Visibility: "HIDDEN" || "VISIBLE",
282
304
  * // },
283
305
  * // TitleOptions: "<LabelOptions>",
306
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
284
307
  * // },
285
308
  * // Type: "MULTI_SELECT" || "SINGLE_SELECT",
286
309
  * // SelectableValues: { // FilterSelectableValues
@@ -309,6 +332,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi
309
332
  * // Visibility: "HIDDEN" || "VISIBLE",
310
333
  * // },
311
334
  * // TitleOptions: "<LabelOptions>",
335
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
312
336
  * // },
313
337
  * // Type: "MULTI_SELECT" || "SINGLE_SELECT",
314
338
  * // SelectableValues: {
@@ -334,6 +358,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi
334
358
  * // PlaceholderOptions: {
335
359
  * // Visibility: "HIDDEN" || "VISIBLE",
336
360
  * // },
361
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
337
362
  * // },
338
363
  * // },
339
364
  * // TextArea: { // FilterTextAreaControl
@@ -346,6 +371,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi
346
371
  * // PlaceholderOptions: {
347
372
  * // Visibility: "HIDDEN" || "VISIBLE",
348
373
  * // },
374
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
349
375
  * // },
350
376
  * // },
351
377
  * // Slider: { // FilterSliderControl
@@ -354,6 +380,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi
354
380
  * // SourceFilterId: "STRING_VALUE", // required
355
381
  * // DisplayOptions: {
356
382
  * // TitleOptions: "<LabelOptions>",
383
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
357
384
  * // },
358
385
  * // Type: "SINGLE_POINT" || "RANGE",
359
386
  * // MaximumValue: Number("double"), // required
@@ -367,6 +394,7 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi
367
394
  * // DisplayOptions: { // RelativeDateTimeControlDisplayOptions
368
395
  * // TitleOptions: "<LabelOptions>",
369
396
  * // DateTimeFormat: "STRING_VALUE",
397
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
370
398
  * // },
371
399
  * // },
372
400
  * // },
@@ -707,6 +735,10 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi
707
735
  * // },
708
736
  * // CategoricalAggregationFunction: "COUNT" || "DISTINCT_COUNT",
709
737
  * // DateAggregationFunction: "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX",
738
+ * // AttributeAggregationFunction: { // AttributeAggregationFunction
739
+ * // SimpleAttributeAggregation: "UNIQUE_VALUE",
740
+ * // ValueForMultipleValues: "STRING_VALUE",
741
+ * // },
710
742
  * // },
711
743
  * // },
712
744
  * // },
@@ -1167,6 +1199,10 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi
1167
1199
  * // },
1168
1200
  * // CategoricalAggregationFunction: "COUNT" || "DISTINCT_COUNT",
1169
1201
  * // DateAggregationFunction: "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX",
1202
+ * // AttributeAggregationFunction: {
1203
+ * // SimpleAttributeAggregation: "UNIQUE_VALUE",
1204
+ * // ValueForMultipleValues: "STRING_VALUE",
1205
+ * // },
1170
1206
  * // },
1171
1207
  * // },
1172
1208
  * // DataPath: { // DataPathSort
@@ -1558,6 +1594,10 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi
1558
1594
  * // NumericalAggregationFunction: "<NumericalAggregationFunction>",
1559
1595
  * // CategoricalAggregationFunction: "COUNT" || "DISTINCT_COUNT",
1560
1596
  * // DateAggregationFunction: "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX",
1597
+ * // AttributeAggregationFunction: {
1598
+ * // SimpleAttributeAggregation: "UNIQUE_VALUE",
1599
+ * // ValueForMultipleValues: "STRING_VALUE",
1600
+ * // },
1561
1601
  * // },
1562
1602
  * // },
1563
1603
  * // },
@@ -1579,6 +1619,10 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi
1579
1619
  * // NumericalAggregationFunction: "<NumericalAggregationFunction>",
1580
1620
  * // CategoricalAggregationFunction: "COUNT" || "DISTINCT_COUNT",
1581
1621
  * // DateAggregationFunction: "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX",
1622
+ * // AttributeAggregationFunction: {
1623
+ * // SimpleAttributeAggregation: "UNIQUE_VALUE",
1624
+ * // ValueForMultipleValues: "STRING_VALUE",
1625
+ * // },
1582
1626
  * // },
1583
1627
  * // },
1584
1628
  * // },
@@ -1600,6 +1644,10 @@ export interface DescribeAnalysisDefinitionCommandOutput extends DescribeAnalysi
1600
1644
  * // NumericalAggregationFunction: "<NumericalAggregationFunction>",
1601
1645
  * // CategoricalAggregationFunction: "COUNT" || "DISTINCT_COUNT",
1602
1646
  * // DateAggregationFunction: "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX",
1647
+ * // AttributeAggregationFunction: {
1648
+ * // SimpleAttributeAggregation: "UNIQUE_VALUE",
1649
+ * // ValueForMultipleValues: "STRING_VALUE",
1650
+ * // },
1603
1651
  * // },
1604
1652
  * // },
1605
1653
  * // },
package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts CHANGED
@@ -98,6 +98,10 @@ export interface DescribeDashboardDefinitionCommandOutput extends DescribeDashbo
98
98
  * // CustomLabel: "STRING_VALUE",
99
99
  * // },
100
100
  * // DateTimeFormat: "STRING_VALUE",
101
+ * // InfoIconLabelOptions: { // SheetControlInfoIconLabelOptions
102
+ * // Visibility: "HIDDEN" || "VISIBLE",
103
+ * // InfoIconText: "STRING_VALUE",
104
+ * // },
101
105
  * // },
102
106
  * // },
103
107
  * // List: { // ParameterListControl
@@ -126,6 +130,10 @@ export interface DescribeDashboardDefinitionCommandOutput extends DescribeDashbo
126
130
  * // },
127
131
  * // CustomLabel: "STRING_VALUE",
128
132
  * // },
133
+ * // InfoIconLabelOptions: {
134
+ * // Visibility: "HIDDEN" || "VISIBLE",
135
+ * // InfoIconText: "STRING_VALUE",
136
+ * // },
129
137
  * // },
130
138
  * // Type: "MULTI_SELECT" || "SINGLE_SELECT",
131
139
  * // SelectableValues: { // ParameterSelectableValues
@@ -172,6 +180,10 @@ export interface DescribeDashboardDefinitionCommandOutput extends DescribeDashbo
172
180
  * // },
173
181
  * // CustomLabel: "STRING_VALUE",
174
182
  * // },
183
+ * // InfoIconLabelOptions: {
184
+ * // Visibility: "HIDDEN" || "VISIBLE",
185
+ * // InfoIconText: "STRING_VALUE",
186
+ * // },
175
187
  * // },
176
188
  * // Type: "MULTI_SELECT" || "SINGLE_SELECT",
177
189
  * // SelectableValues: {
@@ -218,6 +230,10 @@ export interface DescribeDashboardDefinitionCommandOutput extends DescribeDashbo
218
230
  * // PlaceholderOptions: { // TextControlPlaceholderOptions
219
231
  * // Visibility: "HIDDEN" || "VISIBLE",
220
232
  * // },
233
+ * // InfoIconLabelOptions: {
234
+ * // Visibility: "HIDDEN" || "VISIBLE",
235
+ * // InfoIconText: "STRING_VALUE",
236
+ * // },
221
237
  * // },
222
238
  * // },
223
239
  * // TextArea: { // ParameterTextAreaControl
@@ -244,6 +260,10 @@ export interface DescribeDashboardDefinitionCommandOutput extends DescribeDashbo
244
260
  * // PlaceholderOptions: {
245
261
  * // Visibility: "HIDDEN" || "VISIBLE",
246
262
  * // },
263
+ * // InfoIconLabelOptions: {
264
+ * // Visibility: "HIDDEN" || "VISIBLE",
265
+ * // InfoIconText: "STRING_VALUE",
266
+ * // },
247
267
  * // },
248
268
  * // },
249
269
  * // Slider: { // ParameterSliderControl
@@ -252,6 +272,7 @@ export interface DescribeDashboardDefinitionCommandOutput extends DescribeDashbo
252
272
  * // SourceParameterName: "STRING_VALUE", // required
253
273
  * // DisplayOptions: { // SliderControlDisplayOptions
254
274
  * // TitleOptions: "<LabelOptions>",
275
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
255
276
  * // },
256
277
  * // MaximumValue: Number("double"), // required
257
278
  * // MinimumValue: Number("double"), // required
@@ -268,6 +289,7 @@ export interface DescribeDashboardDefinitionCommandOutput extends DescribeDashbo
268
289
  * // DisplayOptions: {
269
290
  * // TitleOptions: "<LabelOptions>",
270
291
  * // DateTimeFormat: "STRING_VALUE",
292
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
271
293
  * // },
272
294
  * // Type: "SINGLE_VALUED" || "DATE_RANGE",
273
295
  * // },
@@ -283,6 +305,7 @@ export interface DescribeDashboardDefinitionCommandOutput extends DescribeDashbo
283
305
  * // Visibility: "HIDDEN" || "VISIBLE",
284
306
  * // },
285
307
  * // TitleOptions: "<LabelOptions>",
308
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
286
309
  * // },
287
310
  * // Type: "MULTI_SELECT" || "SINGLE_SELECT",
288
311
  * // SelectableValues: { // FilterSelectableValues
@@ -311,6 +334,7 @@ export interface DescribeDashboardDefinitionCommandOutput extends DescribeDashbo
311
334
  * // Visibility: "HIDDEN" || "VISIBLE",
312
335
  * // },
313
336
  * // TitleOptions: "<LabelOptions>",
337
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
314
338
  * // },
315
339
  * // Type: "MULTI_SELECT" || "SINGLE_SELECT",
316
340
  * // SelectableValues: {
@@ -336,6 +360,7 @@ export interface DescribeDashboardDefinitionCommandOutput extends DescribeDashbo
336
360
  * // PlaceholderOptions: {
337
361
  * // Visibility: "HIDDEN" || "VISIBLE",
338
362
  * // },
363
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
339
364
  * // },
340
365
  * // },
341
366
  * // TextArea: { // FilterTextAreaControl
@@ -348,6 +373,7 @@ export interface DescribeDashboardDefinitionCommandOutput extends DescribeDashbo
348
373
  * // PlaceholderOptions: {
349
374
  * // Visibility: "HIDDEN" || "VISIBLE",
350
375
  * // },
376
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
351
377
  * // },
352
378
  * // },
353
379
  * // Slider: { // FilterSliderControl
@@ -356,6 +382,7 @@ export interface DescribeDashboardDefinitionCommandOutput extends DescribeDashbo
356
382
  * // SourceFilterId: "STRING_VALUE", // required
357
383
  * // DisplayOptions: {
358
384
  * // TitleOptions: "<LabelOptions>",
385
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
359
386
  * // },
360
387
  * // Type: "SINGLE_POINT" || "RANGE",
361
388
  * // MaximumValue: Number("double"), // required
@@ -369,6 +396,7 @@ export interface DescribeDashboardDefinitionCommandOutput extends DescribeDashbo
369
396
  * // DisplayOptions: { // RelativeDateTimeControlDisplayOptions
370
397
  * // TitleOptions: "<LabelOptions>",
371
398
  * // DateTimeFormat: "STRING_VALUE",
399
+ * // InfoIconLabelOptions: "<SheetControlInfoIconLabelOptions>",
372
400
  * // },
373
401
  * // },
374
402
  * // },
@@ -709,6 +737,10 @@ export interface DescribeDashboardDefinitionCommandOutput extends DescribeDashbo
709
737
  * // },
710
738
  * // CategoricalAggregationFunction: "COUNT" || "DISTINCT_COUNT",
711
739
  * // DateAggregationFunction: "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX",
740
+ * // AttributeAggregationFunction: { // AttributeAggregationFunction
741
+ * // SimpleAttributeAggregation: "UNIQUE_VALUE",
742
+ * // ValueForMultipleValues: "STRING_VALUE",
743
+ * // },
712
744
  * // },
713
745
  * // },
714
746
  * // },
@@ -1169,6 +1201,10 @@ export interface DescribeDashboardDefinitionCommandOutput extends DescribeDashbo
1169
1201
  * // },
1170
1202
  * // CategoricalAggregationFunction: "COUNT" || "DISTINCT_COUNT",
1171
1203
  * // DateAggregationFunction: "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX",
1204
+ * // AttributeAggregationFunction: {
1205
+ * // SimpleAttributeAggregation: "UNIQUE_VALUE",
1206
+ * // ValueForMultipleValues: "STRING_VALUE",
1207
+ * // },
1172
1208
  * // },
1173
1209
  * // },
1174
1210
  * // DataPath: { // DataPathSort
@@ -1560,6 +1596,10 @@ export interface DescribeDashboardDefinitionCommandOutput extends DescribeDashbo
1560
1596
  * // NumericalAggregationFunction: "<NumericalAggregationFunction>",
1561
1597
  * // CategoricalAggregationFunction: "COUNT" || "DISTINCT_COUNT",
1562
1598
  * // DateAggregationFunction: "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX",
1599
+ * // AttributeAggregationFunction: {
1600
+ * // SimpleAttributeAggregation: "UNIQUE_VALUE",
1601
+ * // ValueForMultipleValues: "STRING_VALUE",
1602
+ * // },
1563
1603
  * // },
1564
1604
  * // },
1565
1605
  * // },
@@ -1581,6 +1621,10 @@ export interface DescribeDashboardDefinitionCommandOutput extends DescribeDashbo
1581
1621
  * // NumericalAggregationFunction: "<NumericalAggregationFunction>",
1582
1622
  * // CategoricalAggregationFunction: "COUNT" || "DISTINCT_COUNT",
1583
1623
  * // DateAggregationFunction: "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX",
1624
+ * // AttributeAggregationFunction: {
1625
+ * // SimpleAttributeAggregation: "UNIQUE_VALUE",
1626
+ * // ValueForMultipleValues: "STRING_VALUE",
1627
+ * // },
1584
1628
  * // },
1585
1629
  * // },
1586
1630
  * // },
@@ -1602,6 +1646,10 @@ export interface DescribeDashboardDefinitionCommandOutput extends DescribeDashbo
1602
1646
  * // NumericalAggregationFunction: "<NumericalAggregationFunction>",
1603
1647
  * // CategoricalAggregationFunction: "COUNT" || "DISTINCT_COUNT",
1604
1648
  * // DateAggregationFunction: "COUNT" || "DISTINCT_COUNT" || "MIN" || "MAX",
1649
+ * // AttributeAggregationFunction: {
1650
+ * // SimpleAttributeAggregation: "UNIQUE_VALUE",
1651
+ * // ValueForMultipleValues: "STRING_VALUE",
1652
+ * // },
1605
1653
  * // },
1606
1654
  * // },
1607
1655
  * // },
package/dist-types/commands/DescribeDashboardSnapshotJobCommand.d.ts ADDED
@@ -0,0 +1,179 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { DescribeDashboardSnapshotJobRequest, DescribeDashboardSnapshotJobResponse } from "../models/models_3";
5
+ import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DescribeDashboardSnapshotJobCommand}.
14
+ */
15
+ export interface DescribeDashboardSnapshotJobCommandInput extends DescribeDashboardSnapshotJobRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DescribeDashboardSnapshotJobCommand}.
21
+ */
22
+ export interface DescribeDashboardSnapshotJobCommandOutput extends DescribeDashboardSnapshotJobResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Describes an existing snapshot job.</p>
27
+ * <p>Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see <code>JobStatus</code>.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { QuickSightClient, DescribeDashboardSnapshotJobCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
32
+ * // const { QuickSightClient, DescribeDashboardSnapshotJobCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
33
+ * const client = new QuickSightClient(config);
34
+ * const input = { // DescribeDashboardSnapshotJobRequest
35
+ * AwsAccountId: "STRING_VALUE", // required
36
+ * DashboardId: "STRING_VALUE", // required
37
+ * SnapshotJobId: "STRING_VALUE", // required
38
+ * };
39
+ * const command = new DescribeDashboardSnapshotJobCommand(input);
40
+ * const response = await client.send(command);
41
+ * // { // DescribeDashboardSnapshotJobResponse
42
+ * // AwsAccountId: "STRING_VALUE",
43
+ * // DashboardId: "STRING_VALUE",
44
+ * // SnapshotJobId: "STRING_VALUE",
45
+ * // UserConfiguration: { // SnapshotUserConfigurationRedacted
46
+ * // AnonymousUsers: [ // SnapshotAnonymousUserRedactedList
47
+ * // { // SnapshotAnonymousUserRedacted
48
+ * // RowLevelPermissionTagKeys: [ // SessionTagKeyList
49
+ * // "STRING_VALUE",
50
+ * // ],
51
+ * // },
52
+ * // ],
53
+ * // },
54
+ * // SnapshotConfiguration: { // SnapshotConfiguration
55
+ * // FileGroups: [ // SnapshotFileGroupList // required
56
+ * // { // SnapshotFileGroup
57
+ * // Files: [ // SnapshotFileList
58
+ * // { // SnapshotFile
59
+ * // SheetSelections: [ // SnapshotFileSheetSelectionList // required
60
+ * // { // SnapshotFileSheetSelection
61
+ * // SheetId: "STRING_VALUE", // required
62
+ * // SelectionScope: "ALL_VISUALS" || "SELECTED_VISUALS", // required
63
+ * // VisualIds: [ // SnapshotFileSheetSelectionVisualIdList
64
+ * // "STRING_VALUE",
65
+ * // ],
66
+ * // },
67
+ * // ],
68
+ * // FormatType: "CSV" || "PDF", // required
69
+ * // },
70
+ * // ],
71
+ * // },
72
+ * // ],
73
+ * // DestinationConfiguration: { // SnapshotDestinationConfiguration
74
+ * // S3Destinations: [ // SnapshotS3DestinationConfigurationList
75
+ * // { // SnapshotS3DestinationConfiguration
76
+ * // BucketConfiguration: { // S3BucketConfiguration
77
+ * // BucketName: "STRING_VALUE", // required
78
+ * // BucketPrefix: "STRING_VALUE", // required
79
+ * // BucketRegion: "STRING_VALUE", // required
80
+ * // },
81
+ * // },
82
+ * // ],
83
+ * // },
84
+ * // Parameters: { // Parameters
85
+ * // StringParameters: [ // StringParameterList
86
+ * // { // StringParameter
87
+ * // Name: "STRING_VALUE", // required
88
+ * // Values: [ // SensitiveStringList // required
89
+ * // "STRING_VALUE",
90
+ * // ],
91
+ * // },
92
+ * // ],
93
+ * // IntegerParameters: [ // IntegerParameterList
94
+ * // { // IntegerParameter
95
+ * // Name: "STRING_VALUE", // required
96
+ * // Values: [ // SensitiveLongList // required
97
+ * // Number("long"),
98
+ * // ],
99
+ * // },
100
+ * // ],
101
+ * // DecimalParameters: [ // DecimalParameterList
102
+ * // { // DecimalParameter
103
+ * // Name: "STRING_VALUE", // required
104
+ * // Values: [ // SensitiveDoubleList // required
105
+ * // Number("double"),
106
+ * // ],
107
+ * // },
108
+ * // ],
109
+ * // DateTimeParameters: [ // DateTimeParameterList
110
+ * // { // DateTimeParameter
111
+ * // Name: "STRING_VALUE", // required
112
+ * // Values: [ // SensitiveTimestampList // required
113
+ * // new Date("TIMESTAMP"),
114
+ * // ],
115
+ * // },
116
+ * // ],
117
+ * // },
118
+ * // },
119
+ * // Arn: "STRING_VALUE",
120
+ * // JobStatus: "QUEUED" || "RUNNING" || "COMPLETED" || "FAILED",
121
+ * // CreatedTime: new Date("TIMESTAMP"),
122
+ * // LastUpdatedTime: new Date("TIMESTAMP"),
123
+ * // RequestId: "STRING_VALUE",
124
+ * // Status: Number("int"),
125
+ * // };
126
+ *
127
+ * ```
128
+ *
129
+ * @param DescribeDashboardSnapshotJobCommandInput - {@link DescribeDashboardSnapshotJobCommandInput}
130
+ * @returns {@link DescribeDashboardSnapshotJobCommandOutput}
131
+ * @see {@link DescribeDashboardSnapshotJobCommandInput} for command's `input` shape.
132
+ * @see {@link DescribeDashboardSnapshotJobCommandOutput} for command's `response` shape.
133
+ * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
134
+ *
135
+ * @throws {@link AccessDeniedException} (client fault)
136
+ * <p>You don't have access to this item. The provided credentials couldn't be
137
+ * validated. You might not be authorized to carry out the request. Make sure that your
138
+ * account is authorized to use the Amazon QuickSight service, that your policies have the
139
+ * correct permissions, and that you are using the correct credentials.</p>
140
+ *
141
+ * @throws {@link InternalFailureException} (server fault)
142
+ * <p>An internal failure occurred.</p>
143
+ *
144
+ * @throws {@link ResourceNotFoundException} (client fault)
145
+ * <p>One or more resources can't be found.</p>
146
+ *
147
+ * @throws {@link ThrottlingException} (client fault)
148
+ * <p>Access is throttled.</p>
149
+ *
150
+ * @throws {@link UnsupportedUserEditionException} (client fault)
151
+ * <p>This error indicates that you are calling an operation on an Amazon QuickSight
152
+ * subscription where the edition doesn't include support for that operation. Amazon
153
+ * Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
154
+ * capability is available in every edition.</p>
155
+ *
156
+ * @throws {@link QuickSightServiceException}
157
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
158
+ *
159
+ */
160
+ export declare class DescribeDashboardSnapshotJobCommand extends $Command<DescribeDashboardSnapshotJobCommandInput, DescribeDashboardSnapshotJobCommandOutput, QuickSightClientResolvedConfig> {
161
+ readonly input: DescribeDashboardSnapshotJobCommandInput;
162
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
163
+ /**
164
+ * @public
165
+ */
166
+ constructor(input: DescribeDashboardSnapshotJobCommandInput);
167
+ /**
168
+ * @internal
169
+ */
170
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: QuickSightClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDashboardSnapshotJobCommandInput, DescribeDashboardSnapshotJobCommandOutput>;
171
+ /**
172
+ * @internal
173
+ */
174
+ private serialize;
175
+ /**
176
+ * @internal
177
+ */
178
+ private deserialize;
179
+ }