@aws-sdk/client-quicksight 3.948.0 → 3.952.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.
- package/README.md +8 -0
- package/dist-cjs/index.js +415 -101
- package/dist-es/QuickSight.js +2 -0
- package/dist-es/commands/GetIdentityContextCommand.js +16 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/enums.js +49 -17
- package/dist-es/schemas/schemas_0.js +349 -84
- package/dist-types/QuickSight.d.ts +7 -0
- package/dist-types/QuickSightClient.d.ts +3 -2
- package/dist-types/commands/CreateAnalysisCommand.d.ts +194 -0
- package/dist-types/commands/CreateDashboardCommand.d.ts +194 -0
- package/dist-types/commands/CreateDataSetCommand.d.ts +1 -1
- package/dist-types/commands/CreateDataSourceCommand.d.ts +5 -0
- package/dist-types/commands/CreateTemplateCommand.d.ts +194 -0
- package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +194 -0
- package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +194 -0
- package/dist-types/commands/DescribeDashboardSnapshotJobCommand.d.ts +19 -0
- package/dist-types/commands/DescribeDashboardSnapshotJobResultCommand.d.ts +89 -0
- package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +194 -0
- package/dist-types/commands/DescribeThemeAliasCommand.d.ts +1 -1
- package/dist-types/commands/DescribeThemeCommand.d.ts +1 -1
- package/dist-types/commands/DescribeThemePermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTopicCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTopicPermissionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTopicRefreshCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTopicRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/commands/DescribeUserCommand.d.ts +1 -1
- package/dist-types/commands/GetIdentityContextCommand.d.ts +143 -0
- package/dist-types/commands/StartDashboardSnapshotJobCommand.d.ts +55 -0
- package/dist-types/commands/UpdateAnalysisCommand.d.ts +194 -0
- package/dist-types/commands/UpdateDashboardCommand.d.ts +194 -0
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +5 -0
- package/dist-types/commands/UpdateTemplateCommand.d.ts +194 -0
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/enums.d.ts +97 -41
- package/dist-types/models/models_0.d.ts +265 -162
- package/dist-types/models/models_1.d.ts +615 -822
- package/dist-types/models/models_2.d.ts +5138 -5090
- package/dist-types/models/models_3.d.ts +3935 -3902
- package/dist-types/models/models_4.d.ts +727 -7
- package/dist-types/schemas/schemas_0.d.ts +33 -0
- package/dist-types/ts3.4/QuickSight.d.ts +17 -0
- package/dist-types/ts3.4/QuickSightClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/CreateDataSetCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeThemeAliasCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeThemeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeThemePermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTopicCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTopicPermissionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTopicRefreshCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeTopicRefreshScheduleCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DescribeUserCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetIdentityContextCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/enums.d.ts +61 -23
- package/dist-types/ts3.4/models/models_0.d.ts +41 -38
- package/dist-types/ts3.4/models/models_1.d.ts +140 -164
- package/dist-types/ts3.4/models/models_2.d.ts +174 -176
- package/dist-types/ts3.4/models/models_3.d.ts +183 -147
- package/dist-types/ts3.4/models/models_4.d.ts +189 -13
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +33 -0
- package/package.json +2 -2
|
@@ -951,6 +951,14 @@ declare const DescribeDashboardDefinitionCommand_base: {
|
|
|
951
951
|
* // },
|
|
952
952
|
* // },
|
|
953
953
|
* // ],
|
|
954
|
+
* // DashboardCustomizationVisualOptions: { // DashboardCustomizationVisualOptions
|
|
955
|
+
* // FieldsConfiguration: { // VisualCustomizationFieldsConfiguration
|
|
956
|
+
* // Status: "ENABLED" || "DISABLED",
|
|
957
|
+
* // AdditionalFields: [ // VisualCustomizationAdditionalFieldsList
|
|
958
|
+
* // "<ColumnIdentifier>",
|
|
959
|
+
* // ],
|
|
960
|
+
* // },
|
|
961
|
+
* // },
|
|
954
962
|
* // Interactions: { // VisualInteractionOptions
|
|
955
963
|
* // VisualMenuOption: { // VisualMenuOption
|
|
956
964
|
* // AvailabilityStatus: "ENABLED" || "DISABLED",
|
|
@@ -1463,6 +1471,14 @@ declare const DescribeDashboardDefinitionCommand_base: {
|
|
|
1463
1471
|
* // VerticalOverflowVisibility: "HIDDEN" || "VISIBLE",
|
|
1464
1472
|
* // OverflowColumnHeaderVisibility: "HIDDEN" || "VISIBLE",
|
|
1465
1473
|
* // },
|
|
1474
|
+
* // DashboardCustomizationVisualOptions: {
|
|
1475
|
+
* // FieldsConfiguration: {
|
|
1476
|
+
* // Status: "ENABLED" || "DISABLED",
|
|
1477
|
+
* // AdditionalFields: [
|
|
1478
|
+
* // "<ColumnIdentifier>",
|
|
1479
|
+
* // ],
|
|
1480
|
+
* // },
|
|
1481
|
+
* // },
|
|
1466
1482
|
* // Interactions: {
|
|
1467
1483
|
* // VisualMenuOption: {
|
|
1468
1484
|
* // AvailabilityStatus: "ENABLED" || "DISABLED",
|
|
@@ -1940,6 +1956,59 @@ declare const DescribeDashboardDefinitionCommand_base: {
|
|
|
1940
1956
|
* // },
|
|
1941
1957
|
* // ],
|
|
1942
1958
|
* // },
|
|
1959
|
+
* // DefaultSeriesSettings: { // BarChartDefaultSeriesSettings
|
|
1960
|
+
* // DecalSettings: { // DecalSettings
|
|
1961
|
+
* // ElementValue: "STRING_VALUE",
|
|
1962
|
+
* // DecalVisibility: "HIDDEN" || "VISIBLE",
|
|
1963
|
+
* // DecalColor: "STRING_VALUE",
|
|
1964
|
+
* // DecalPatternType: "SOLID" || "DIAGONAL_MEDIUM" || "CIRCLE_MEDIUM" || "DIAMOND_GRID_MEDIUM" || "CHECKERBOARD_MEDIUM" || "TRIANGLE_MEDIUM" || "DIAGONAL_OPPOSITE_MEDIUM" || "DIAMOND_MEDIUM" || "DIAGONAL_LARGE" || "CIRCLE_LARGE" || "DIAMOND_GRID_LARGE" || "CHECKERBOARD_LARGE" || "TRIANGLE_LARGE" || "DIAGONAL_OPPOSITE_LARGE" || "DIAMOND_LARGE" || "DIAGONAL_SMALL" || "CIRCLE_SMALL" || "DIAMOND_GRID_SMALL" || "CHECKERBOARD_SMALL" || "TRIANGLE_SMALL" || "DIAGONAL_OPPOSITE_SMALL" || "DIAMOND_SMALL",
|
|
1965
|
+
* // DecalStyleType: "Manual" || "Auto",
|
|
1966
|
+
* // },
|
|
1967
|
+
* // BorderSettings: { // BorderSettings
|
|
1968
|
+
* // BorderVisibility: "HIDDEN" || "VISIBLE",
|
|
1969
|
+
* // BorderWidth: "STRING_VALUE",
|
|
1970
|
+
* // BorderColor: "STRING_VALUE",
|
|
1971
|
+
* // },
|
|
1972
|
+
* // },
|
|
1973
|
+
* // Series: [ // BarSeriesItemList
|
|
1974
|
+
* // { // BarSeriesItem
|
|
1975
|
+
* // FieldBarSeriesItem: { // FieldBarSeriesItem
|
|
1976
|
+
* // FieldId: "STRING_VALUE", // required
|
|
1977
|
+
* // Settings: { // BarChartSeriesSettings
|
|
1978
|
+
* // DecalSettings: {
|
|
1979
|
+
* // ElementValue: "STRING_VALUE",
|
|
1980
|
+
* // DecalVisibility: "HIDDEN" || "VISIBLE",
|
|
1981
|
+
* // DecalColor: "STRING_VALUE",
|
|
1982
|
+
* // DecalPatternType: "SOLID" || "DIAGONAL_MEDIUM" || "CIRCLE_MEDIUM" || "DIAMOND_GRID_MEDIUM" || "CHECKERBOARD_MEDIUM" || "TRIANGLE_MEDIUM" || "DIAGONAL_OPPOSITE_MEDIUM" || "DIAMOND_MEDIUM" || "DIAGONAL_LARGE" || "CIRCLE_LARGE" || "DIAMOND_GRID_LARGE" || "CHECKERBOARD_LARGE" || "TRIANGLE_LARGE" || "DIAGONAL_OPPOSITE_LARGE" || "DIAMOND_LARGE" || "DIAGONAL_SMALL" || "CIRCLE_SMALL" || "DIAMOND_GRID_SMALL" || "CHECKERBOARD_SMALL" || "TRIANGLE_SMALL" || "DIAGONAL_OPPOSITE_SMALL" || "DIAMOND_SMALL",
|
|
1983
|
+
* // DecalStyleType: "Manual" || "Auto",
|
|
1984
|
+
* // },
|
|
1985
|
+
* // BorderSettings: {
|
|
1986
|
+
* // BorderVisibility: "HIDDEN" || "VISIBLE",
|
|
1987
|
+
* // BorderWidth: "STRING_VALUE",
|
|
1988
|
+
* // BorderColor: "STRING_VALUE",
|
|
1989
|
+
* // },
|
|
1990
|
+
* // },
|
|
1991
|
+
* // },
|
|
1992
|
+
* // DataFieldBarSeriesItem: { // DataFieldBarSeriesItem
|
|
1993
|
+
* // FieldId: "STRING_VALUE", // required
|
|
1994
|
+
* // FieldValue: "STRING_VALUE",
|
|
1995
|
+
* // Settings: {
|
|
1996
|
+
* // DecalSettings: {
|
|
1997
|
+
* // ElementValue: "STRING_VALUE",
|
|
1998
|
+
* // DecalVisibility: "HIDDEN" || "VISIBLE",
|
|
1999
|
+
* // DecalColor: "STRING_VALUE",
|
|
2000
|
+
* // DecalPatternType: "SOLID" || "DIAGONAL_MEDIUM" || "CIRCLE_MEDIUM" || "DIAMOND_GRID_MEDIUM" || "CHECKERBOARD_MEDIUM" || "TRIANGLE_MEDIUM" || "DIAGONAL_OPPOSITE_MEDIUM" || "DIAMOND_MEDIUM" || "DIAGONAL_LARGE" || "CIRCLE_LARGE" || "DIAMOND_GRID_LARGE" || "CHECKERBOARD_LARGE" || "TRIANGLE_LARGE" || "DIAGONAL_OPPOSITE_LARGE" || "DIAMOND_LARGE" || "DIAGONAL_SMALL" || "CIRCLE_SMALL" || "DIAMOND_GRID_SMALL" || "CHECKERBOARD_SMALL" || "TRIANGLE_SMALL" || "DIAGONAL_OPPOSITE_SMALL" || "DIAMOND_SMALL",
|
|
2001
|
+
* // DecalStyleType: "Manual" || "Auto",
|
|
2002
|
+
* // },
|
|
2003
|
+
* // BorderSettings: {
|
|
2004
|
+
* // BorderVisibility: "HIDDEN" || "VISIBLE",
|
|
2005
|
+
* // BorderWidth: "STRING_VALUE",
|
|
2006
|
+
* // BorderColor: "STRING_VALUE",
|
|
2007
|
+
* // },
|
|
2008
|
+
* // },
|
|
2009
|
+
* // },
|
|
2010
|
+
* // },
|
|
2011
|
+
* // ],
|
|
1943
2012
|
* // Legend: { // LegendOptions
|
|
1944
2013
|
* // Visibility: "HIDDEN" || "VISIBLE",
|
|
1945
2014
|
* // Title: "<LabelOptions>",
|
|
@@ -3176,6 +3245,13 @@ declare const DescribeDashboardDefinitionCommand_base: {
|
|
|
3176
3245
|
* // MarkerSize: "STRING_VALUE",
|
|
3177
3246
|
* // MarkerColor: "STRING_VALUE",
|
|
3178
3247
|
* // },
|
|
3248
|
+
* // DecalSettings: {
|
|
3249
|
+
* // ElementValue: "STRING_VALUE",
|
|
3250
|
+
* // DecalVisibility: "HIDDEN" || "VISIBLE",
|
|
3251
|
+
* // DecalColor: "STRING_VALUE",
|
|
3252
|
+
* // DecalPatternType: "SOLID" || "DIAGONAL_MEDIUM" || "CIRCLE_MEDIUM" || "DIAMOND_GRID_MEDIUM" || "CHECKERBOARD_MEDIUM" || "TRIANGLE_MEDIUM" || "DIAGONAL_OPPOSITE_MEDIUM" || "DIAMOND_MEDIUM" || "DIAGONAL_LARGE" || "CIRCLE_LARGE" || "DIAMOND_GRID_LARGE" || "CHECKERBOARD_LARGE" || "TRIANGLE_LARGE" || "DIAGONAL_OPPOSITE_LARGE" || "DIAMOND_LARGE" || "DIAGONAL_SMALL" || "CIRCLE_SMALL" || "DIAMOND_GRID_SMALL" || "CHECKERBOARD_SMALL" || "TRIANGLE_SMALL" || "DIAGONAL_OPPOSITE_SMALL" || "DIAMOND_SMALL",
|
|
3253
|
+
* // DecalStyleType: "Manual" || "Auto",
|
|
3254
|
+
* // },
|
|
3179
3255
|
* // },
|
|
3180
3256
|
* // Series: [ // SeriesItemList
|
|
3181
3257
|
* // { // SeriesItem
|
|
@@ -3195,6 +3271,13 @@ declare const DescribeDashboardDefinitionCommand_base: {
|
|
|
3195
3271
|
* // MarkerSize: "STRING_VALUE",
|
|
3196
3272
|
* // MarkerColor: "STRING_VALUE",
|
|
3197
3273
|
* // },
|
|
3274
|
+
* // DecalSettings: {
|
|
3275
|
+
* // ElementValue: "STRING_VALUE",
|
|
3276
|
+
* // DecalVisibility: "HIDDEN" || "VISIBLE",
|
|
3277
|
+
* // DecalColor: "STRING_VALUE",
|
|
3278
|
+
* // DecalPatternType: "SOLID" || "DIAGONAL_MEDIUM" || "CIRCLE_MEDIUM" || "DIAMOND_GRID_MEDIUM" || "CHECKERBOARD_MEDIUM" || "TRIANGLE_MEDIUM" || "DIAGONAL_OPPOSITE_MEDIUM" || "DIAMOND_MEDIUM" || "DIAGONAL_LARGE" || "CIRCLE_LARGE" || "DIAMOND_GRID_LARGE" || "CHECKERBOARD_LARGE" || "TRIANGLE_LARGE" || "DIAGONAL_OPPOSITE_LARGE" || "DIAMOND_LARGE" || "DIAGONAL_SMALL" || "CIRCLE_SMALL" || "DIAMOND_GRID_SMALL" || "CHECKERBOARD_SMALL" || "TRIANGLE_SMALL" || "DIAGONAL_OPPOSITE_SMALL" || "DIAMOND_SMALL",
|
|
3279
|
+
* // DecalStyleType: "Manual" || "Auto",
|
|
3280
|
+
* // },
|
|
3198
3281
|
* // },
|
|
3199
3282
|
* // },
|
|
3200
3283
|
* // DataFieldSeriesItem: { // DataFieldSeriesItem
|
|
@@ -3214,6 +3297,7 @@ declare const DescribeDashboardDefinitionCommand_base: {
|
|
|
3214
3297
|
* // MarkerSize: "STRING_VALUE",
|
|
3215
3298
|
* // MarkerColor: "STRING_VALUE",
|
|
3216
3299
|
* // },
|
|
3300
|
+
* // DecalSettings: "<DecalSettings>",
|
|
3217
3301
|
* // },
|
|
3218
3302
|
* // },
|
|
3219
3303
|
* // },
|
|
@@ -3611,6 +3695,30 @@ declare const DescribeDashboardDefinitionCommand_base: {
|
|
|
3611
3695
|
* // ColumnHierarchies: "<ColumnHierarchyList>",
|
|
3612
3696
|
* // Actions: "<VisualCustomActionList>",
|
|
3613
3697
|
* // VisualContentAltText: "STRING_VALUE",
|
|
3698
|
+
* // GeocodingPreferences: [ // GeocodePreferenceList
|
|
3699
|
+
* // { // GeocodePreference
|
|
3700
|
+
* // RequestKey: { // GeocoderHierarchy
|
|
3701
|
+
* // Country: "STRING_VALUE",
|
|
3702
|
+
* // State: "STRING_VALUE",
|
|
3703
|
+
* // County: "STRING_VALUE",
|
|
3704
|
+
* // City: "STRING_VALUE",
|
|
3705
|
+
* // PostCode: "STRING_VALUE",
|
|
3706
|
+
* // },
|
|
3707
|
+
* // Preference: { // GeocodePreferenceValue Union: only one key present
|
|
3708
|
+
* // GeocoderHierarchy: {
|
|
3709
|
+
* // Country: "STRING_VALUE",
|
|
3710
|
+
* // State: "STRING_VALUE",
|
|
3711
|
+
* // County: "STRING_VALUE",
|
|
3712
|
+
* // City: "STRING_VALUE",
|
|
3713
|
+
* // PostCode: "STRING_VALUE",
|
|
3714
|
+
* // },
|
|
3715
|
+
* // Coordinate: { // Coordinate
|
|
3716
|
+
* // Latitude: Number("double"), // required
|
|
3717
|
+
* // Longitude: Number("double"), // required
|
|
3718
|
+
* // },
|
|
3719
|
+
* // },
|
|
3720
|
+
* // },
|
|
3721
|
+
* // ],
|
|
3614
3722
|
* // },
|
|
3615
3723
|
* // FilledMapVisual: { // FilledMapVisual
|
|
3616
3724
|
* // VisualId: "STRING_VALUE", // required
|
|
@@ -3661,6 +3769,30 @@ declare const DescribeDashboardDefinitionCommand_base: {
|
|
|
3661
3769
|
* // ColumnHierarchies: "<ColumnHierarchyList>",
|
|
3662
3770
|
* // Actions: "<VisualCustomActionList>",
|
|
3663
3771
|
* // VisualContentAltText: "STRING_VALUE",
|
|
3772
|
+
* // GeocodingPreferences: [
|
|
3773
|
+
* // {
|
|
3774
|
+
* // RequestKey: {
|
|
3775
|
+
* // Country: "STRING_VALUE",
|
|
3776
|
+
* // State: "STRING_VALUE",
|
|
3777
|
+
* // County: "STRING_VALUE",
|
|
3778
|
+
* // City: "STRING_VALUE",
|
|
3779
|
+
* // PostCode: "STRING_VALUE",
|
|
3780
|
+
* // },
|
|
3781
|
+
* // Preference: {// Union: only one key present
|
|
3782
|
+
* // GeocoderHierarchy: {
|
|
3783
|
+
* // Country: "STRING_VALUE",
|
|
3784
|
+
* // State: "STRING_VALUE",
|
|
3785
|
+
* // County: "STRING_VALUE",
|
|
3786
|
+
* // City: "STRING_VALUE",
|
|
3787
|
+
* // PostCode: "STRING_VALUE",
|
|
3788
|
+
* // },
|
|
3789
|
+
* // Coordinate: {
|
|
3790
|
+
* // Latitude: Number("double"), // required
|
|
3791
|
+
* // Longitude: Number("double"), // required
|
|
3792
|
+
* // },
|
|
3793
|
+
* // },
|
|
3794
|
+
* // },
|
|
3795
|
+
* // ],
|
|
3664
3796
|
* // },
|
|
3665
3797
|
* // LayerMapVisual: { // LayerMapVisual
|
|
3666
3798
|
* // VisualId: "STRING_VALUE", // required
|
|
@@ -4047,6 +4179,63 @@ declare const DescribeDashboardDefinitionCommand_base: {
|
|
|
4047
4179
|
* // },
|
|
4048
4180
|
* // },
|
|
4049
4181
|
* // ColorLabelOptions: "<ChartAxisLabelOptions>",
|
|
4182
|
+
* // DefaultSeriesSettings: { // ComboChartDefaultSeriesSettings
|
|
4183
|
+
* // LineStyleSettings: {
|
|
4184
|
+
* // LineVisibility: "HIDDEN" || "VISIBLE",
|
|
4185
|
+
* // LineInterpolation: "LINEAR" || "SMOOTH" || "STEPPED",
|
|
4186
|
+
* // LineStyle: "SOLID" || "DOTTED" || "DASHED",
|
|
4187
|
+
* // LineWidth: "STRING_VALUE",
|
|
4188
|
+
* // },
|
|
4189
|
+
* // MarkerStyleSettings: {
|
|
4190
|
+
* // MarkerVisibility: "HIDDEN" || "VISIBLE",
|
|
4191
|
+
* // MarkerShape: "CIRCLE" || "TRIANGLE" || "SQUARE" || "DIAMOND" || "ROUNDED_SQUARE",
|
|
4192
|
+
* // MarkerSize: "STRING_VALUE",
|
|
4193
|
+
* // MarkerColor: "STRING_VALUE",
|
|
4194
|
+
* // },
|
|
4195
|
+
* // DecalSettings: "<DecalSettings>",
|
|
4196
|
+
* // BorderSettings: {
|
|
4197
|
+
* // BorderVisibility: "HIDDEN" || "VISIBLE",
|
|
4198
|
+
* // BorderWidth: "STRING_VALUE",
|
|
4199
|
+
* // BorderColor: "STRING_VALUE",
|
|
4200
|
+
* // },
|
|
4201
|
+
* // },
|
|
4202
|
+
* // Series: [ // ComboSeriesItemList
|
|
4203
|
+
* // { // ComboSeriesItem
|
|
4204
|
+
* // FieldComboSeriesItem: { // FieldComboSeriesItem
|
|
4205
|
+
* // FieldId: "STRING_VALUE", // required
|
|
4206
|
+
* // Settings: { // ComboChartSeriesSettings
|
|
4207
|
+
* // LineStyleSettings: {
|
|
4208
|
+
* // LineVisibility: "HIDDEN" || "VISIBLE",
|
|
4209
|
+
* // LineInterpolation: "LINEAR" || "SMOOTH" || "STEPPED",
|
|
4210
|
+
* // LineStyle: "SOLID" || "DOTTED" || "DASHED",
|
|
4211
|
+
* // LineWidth: "STRING_VALUE",
|
|
4212
|
+
* // },
|
|
4213
|
+
* // MarkerStyleSettings: {
|
|
4214
|
+
* // MarkerVisibility: "HIDDEN" || "VISIBLE",
|
|
4215
|
+
* // MarkerShape: "CIRCLE" || "TRIANGLE" || "SQUARE" || "DIAMOND" || "ROUNDED_SQUARE",
|
|
4216
|
+
* // MarkerSize: "STRING_VALUE",
|
|
4217
|
+
* // MarkerColor: "STRING_VALUE",
|
|
4218
|
+
* // },
|
|
4219
|
+
* // DecalSettings: "<DecalSettings>",
|
|
4220
|
+
* // BorderSettings: {
|
|
4221
|
+
* // BorderVisibility: "HIDDEN" || "VISIBLE",
|
|
4222
|
+
* // BorderWidth: "STRING_VALUE",
|
|
4223
|
+
* // BorderColor: "STRING_VALUE",
|
|
4224
|
+
* // },
|
|
4225
|
+
* // },
|
|
4226
|
+
* // },
|
|
4227
|
+
* // DataFieldComboSeriesItem: { // DataFieldComboSeriesItem
|
|
4228
|
+
* // FieldId: "STRING_VALUE", // required
|
|
4229
|
+
* // FieldValue: "STRING_VALUE",
|
|
4230
|
+
* // Settings: {
|
|
4231
|
+
* // LineStyleSettings: "<LineChartLineStyleSettings>",
|
|
4232
|
+
* // MarkerStyleSettings: "<LineChartMarkerStyleSettings>",
|
|
4233
|
+
* // DecalSettings: "<DecalSettings>",
|
|
4234
|
+
* // BorderSettings: "<BorderSettings>",
|
|
4235
|
+
* // },
|
|
4236
|
+
* // },
|
|
4237
|
+
* // },
|
|
4238
|
+
* // ],
|
|
4050
4239
|
* // Legend: "<LegendOptions>",
|
|
4051
4240
|
* // BarDataLabels: "<DataLabelOptions>",
|
|
4052
4241
|
* // LineDataLabels: "<DataLabelOptions>",
|
|
@@ -5444,6 +5633,11 @@ declare const DescribeDashboardDefinitionCommand_base: {
|
|
|
5444
5633
|
* // },
|
|
5445
5634
|
* // ],
|
|
5446
5635
|
* // },
|
|
5636
|
+
* // DecalSettingsConfiguration: { // DecalSettingsConfiguration
|
|
5637
|
+
* // CustomDecalSettings: [ // DecalSettingsList
|
|
5638
|
+
* // "<DecalSettings>",
|
|
5639
|
+
* // ],
|
|
5640
|
+
* // },
|
|
5447
5641
|
* // },
|
|
5448
5642
|
* // ],
|
|
5449
5643
|
* // AnalysisDefaults: { // AnalysisDefaults
|
|
@@ -29,6 +29,25 @@ declare const DescribeDashboardSnapshotJobCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <p>Describes an existing snapshot job.</p>
|
|
31
31
|
* <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>
|
|
32
|
+
* <p>
|
|
33
|
+
* <b>Registered user support</b>
|
|
34
|
+
* </p>
|
|
35
|
+
* <p>This API can be called as before to get status of a job started by the same Quick Sight user.</p>
|
|
36
|
+
* <p>
|
|
37
|
+
* <b>Possible error scenarios</b>
|
|
38
|
+
* </p>
|
|
39
|
+
* <p>Request will fail with an Access Denied error in the following scenarios:</p>
|
|
40
|
+
* <ul>
|
|
41
|
+
* <li>
|
|
42
|
+
* <p>The credentials have expired.</p>
|
|
43
|
+
* </li>
|
|
44
|
+
* <li>
|
|
45
|
+
* <p>Job has been started by a different user.</p>
|
|
46
|
+
* </li>
|
|
47
|
+
* <li>
|
|
48
|
+
* <p>Impersonated Quick Sight user doesn't have access to the specified dashboard in the job.</p>
|
|
49
|
+
* </li>
|
|
50
|
+
* </ul>
|
|
32
51
|
* @example
|
|
33
52
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
53
|
* ```javascript
|
|
@@ -30,6 +30,55 @@ declare const DescribeDashboardSnapshotJobResultCommand_base: {
|
|
|
30
30
|
* <p>Describes the result of an existing snapshot job that has finished running.</p>
|
|
31
31
|
* <p>A finished snapshot job will return a <code>COMPLETED</code> or <code>FAILED</code> status when you poll the job with a <code>DescribeDashboardSnapshotJob</code> API call.</p>
|
|
32
32
|
* <p>If the job has not finished running, this operation returns a message that says <code>Dashboard Snapshot Job with id <SnapshotjobId> has not reached a terminal state.</code>.</p>
|
|
33
|
+
* <p>
|
|
34
|
+
* <b>Registered user support</b>
|
|
35
|
+
* </p>
|
|
36
|
+
* <p>This API can be called as before to get the result of a job started by the same Quick Sight user. The result for the user will be returned in <code>RegisteredUsers</code> response attribute. The attribute will contain a list with at most one object in it.</p>
|
|
37
|
+
* <p>
|
|
38
|
+
* <b>Possible error scenarios</b>
|
|
39
|
+
* </p>
|
|
40
|
+
* <p>The request fails with an Access Denied error in the following scenarios:</p>
|
|
41
|
+
* <ul>
|
|
42
|
+
* <li>
|
|
43
|
+
* <p>The credentials have expired.</p>
|
|
44
|
+
* </li>
|
|
45
|
+
* <li>
|
|
46
|
+
* <p>The job was started by a different user.</p>
|
|
47
|
+
* </li>
|
|
48
|
+
* <li>
|
|
49
|
+
* <p>The registered user doesn't have access to the specified dashboard.</p>
|
|
50
|
+
* </li>
|
|
51
|
+
* </ul>
|
|
52
|
+
* <p>The request succeeds but the job fails in the following scenarios:</p>
|
|
53
|
+
* <ul>
|
|
54
|
+
* <li>
|
|
55
|
+
* <p>
|
|
56
|
+
* <code>DASHBOARD_ACCESS_DENIED</code> - The registered user lost access to the dashboard.</p>
|
|
57
|
+
* </li>
|
|
58
|
+
* <li>
|
|
59
|
+
* <p>
|
|
60
|
+
* <code>CAPABILITY_RESTRICTED</code> - The registered user is restricted from exporting data in <b>all</b> selected formats.</p>
|
|
61
|
+
* </li>
|
|
62
|
+
* </ul>
|
|
63
|
+
* <p>The request succeeds but the response contains an error code in the following scenarios:</p>
|
|
64
|
+
* <ul>
|
|
65
|
+
* <li>
|
|
66
|
+
* <p>
|
|
67
|
+
* <code>CAPABILITY_RESTRICTED</code> - The registered user is restricted from exporting data in <b>some</b> selected formats.</p>
|
|
68
|
+
* </li>
|
|
69
|
+
* <li>
|
|
70
|
+
* <p>
|
|
71
|
+
* <code>RLS_CHANGED</code> - Row-level security settings have changed. Re-run the job with current settings.</p>
|
|
72
|
+
* </li>
|
|
73
|
+
* <li>
|
|
74
|
+
* <p>
|
|
75
|
+
* <code>CLS_CHANGED</code> - Column-level security settings have changed. Re-run the job with current settings.</p>
|
|
76
|
+
* </li>
|
|
77
|
+
* <li>
|
|
78
|
+
* <p>
|
|
79
|
+
* <code>DATASET_DELETED</code> - The dataset has been deleted. Verify the dataset exists before re-running the job.</p>
|
|
80
|
+
* </li>
|
|
81
|
+
* </ul>
|
|
33
82
|
* @example
|
|
34
83
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
84
|
* ```javascript
|
|
@@ -91,6 +140,46 @@ declare const DescribeDashboardSnapshotJobResultCommand_base: {
|
|
|
91
140
|
* // ],
|
|
92
141
|
* // },
|
|
93
142
|
* // ],
|
|
143
|
+
* // RegisteredUsers: [ // RegisteredUserSnapshotJobResultList
|
|
144
|
+
* // { // RegisteredUserSnapshotJobResult
|
|
145
|
+
* // FileGroups: [
|
|
146
|
+
* // {
|
|
147
|
+
* // Files: [
|
|
148
|
+
* // {
|
|
149
|
+
* // SheetSelections: [ // required
|
|
150
|
+
* // {
|
|
151
|
+
* // SheetId: "STRING_VALUE", // required
|
|
152
|
+
* // SelectionScope: "ALL_VISUALS" || "SELECTED_VISUALS", // required
|
|
153
|
+
* // VisualIds: [
|
|
154
|
+
* // "STRING_VALUE",
|
|
155
|
+
* // ],
|
|
156
|
+
* // },
|
|
157
|
+
* // ],
|
|
158
|
+
* // FormatType: "CSV" || "PDF" || "EXCEL", // required
|
|
159
|
+
* // },
|
|
160
|
+
* // ],
|
|
161
|
+
* // S3Results: [
|
|
162
|
+
* // {
|
|
163
|
+
* // S3DestinationConfiguration: {
|
|
164
|
+
* // BucketConfiguration: {
|
|
165
|
+
* // BucketName: "STRING_VALUE", // required
|
|
166
|
+
* // BucketPrefix: "STRING_VALUE", // required
|
|
167
|
+
* // BucketRegion: "STRING_VALUE", // required
|
|
168
|
+
* // },
|
|
169
|
+
* // },
|
|
170
|
+
* // S3Uri: "STRING_VALUE",
|
|
171
|
+
* // ErrorInfo: [
|
|
172
|
+
* // {
|
|
173
|
+
* // ErrorMessage: "STRING_VALUE",
|
|
174
|
+
* // ErrorType: "STRING_VALUE",
|
|
175
|
+
* // },
|
|
176
|
+
* // ],
|
|
177
|
+
* // },
|
|
178
|
+
* // ],
|
|
179
|
+
* // },
|
|
180
|
+
* // ],
|
|
181
|
+
* // },
|
|
182
|
+
* // ],
|
|
94
183
|
* // },
|
|
95
184
|
* // ErrorInfo: { // SnapshotJobErrorInfo
|
|
96
185
|
* // ErrorMessage: "STRING_VALUE",
|