@aws-sdk/client-quicksight 3.947.0 → 3.950.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 (62) hide show
  1. package/README.md +8 -0
  2. package/dist-cjs/index.js +415 -101
  3. package/dist-es/QuickSight.js +2 -0
  4. package/dist-es/commands/GetIdentityContextCommand.js +16 -0
  5. package/dist-es/commands/index.js +1 -0
  6. package/dist-es/models/enums.js +49 -17
  7. package/dist-es/schemas/schemas_0.js +349 -84
  8. package/dist-types/QuickSight.d.ts +7 -0
  9. package/dist-types/QuickSightClient.d.ts +3 -2
  10. package/dist-types/commands/CreateAnalysisCommand.d.ts +194 -0
  11. package/dist-types/commands/CreateDashboardCommand.d.ts +194 -0
  12. package/dist-types/commands/CreateDataSetCommand.d.ts +1 -1
  13. package/dist-types/commands/CreateDataSourceCommand.d.ts +5 -0
  14. package/dist-types/commands/CreateTemplateCommand.d.ts +194 -0
  15. package/dist-types/commands/DescribeAnalysisDefinitionCommand.d.ts +194 -0
  16. package/dist-types/commands/DescribeDashboardDefinitionCommand.d.ts +194 -0
  17. package/dist-types/commands/DescribeDashboardSnapshotJobCommand.d.ts +19 -0
  18. package/dist-types/commands/DescribeDashboardSnapshotJobResultCommand.d.ts +89 -0
  19. package/dist-types/commands/DescribeTemplateDefinitionCommand.d.ts +194 -0
  20. package/dist-types/commands/DescribeThemeAliasCommand.d.ts +1 -1
  21. package/dist-types/commands/DescribeThemeCommand.d.ts +1 -1
  22. package/dist-types/commands/DescribeThemePermissionsCommand.d.ts +1 -1
  23. package/dist-types/commands/DescribeTopicCommand.d.ts +1 -1
  24. package/dist-types/commands/DescribeTopicPermissionsCommand.d.ts +1 -1
  25. package/dist-types/commands/DescribeTopicRefreshCommand.d.ts +1 -1
  26. package/dist-types/commands/DescribeTopicRefreshScheduleCommand.d.ts +1 -1
  27. package/dist-types/commands/DescribeUserCommand.d.ts +1 -1
  28. package/dist-types/commands/GetIdentityContextCommand.d.ts +143 -0
  29. package/dist-types/commands/StartDashboardSnapshotJobCommand.d.ts +55 -0
  30. package/dist-types/commands/UpdateAnalysisCommand.d.ts +194 -0
  31. package/dist-types/commands/UpdateDashboardCommand.d.ts +194 -0
  32. package/dist-types/commands/UpdateDataSourceCommand.d.ts +5 -0
  33. package/dist-types/commands/UpdateTemplateCommand.d.ts +194 -0
  34. package/dist-types/commands/index.d.ts +1 -0
  35. package/dist-types/models/enums.d.ts +97 -41
  36. package/dist-types/models/models_0.d.ts +265 -162
  37. package/dist-types/models/models_1.d.ts +615 -822
  38. package/dist-types/models/models_2.d.ts +5138 -5090
  39. package/dist-types/models/models_3.d.ts +3935 -3902
  40. package/dist-types/models/models_4.d.ts +727 -7
  41. package/dist-types/schemas/schemas_0.d.ts +33 -0
  42. package/dist-types/ts3.4/QuickSight.d.ts +17 -0
  43. package/dist-types/ts3.4/QuickSightClient.d.ts +6 -0
  44. package/dist-types/ts3.4/commands/CreateDataSetCommand.d.ts +1 -1
  45. package/dist-types/ts3.4/commands/DescribeThemeAliasCommand.d.ts +1 -1
  46. package/dist-types/ts3.4/commands/DescribeThemeCommand.d.ts +1 -1
  47. package/dist-types/ts3.4/commands/DescribeThemePermissionsCommand.d.ts +1 -1
  48. package/dist-types/ts3.4/commands/DescribeTopicCommand.d.ts +1 -1
  49. package/dist-types/ts3.4/commands/DescribeTopicPermissionsCommand.d.ts +1 -1
  50. package/dist-types/ts3.4/commands/DescribeTopicRefreshCommand.d.ts +1 -1
  51. package/dist-types/ts3.4/commands/DescribeTopicRefreshScheduleCommand.d.ts +1 -1
  52. package/dist-types/ts3.4/commands/DescribeUserCommand.d.ts +1 -1
  53. package/dist-types/ts3.4/commands/GetIdentityContextCommand.d.ts +51 -0
  54. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  55. package/dist-types/ts3.4/models/enums.d.ts +61 -23
  56. package/dist-types/ts3.4/models/models_0.d.ts +41 -38
  57. package/dist-types/ts3.4/models/models_1.d.ts +140 -164
  58. package/dist-types/ts3.4/models/models_2.d.ts +174 -176
  59. package/dist-types/ts3.4/models/models_3.d.ts +183 -147
  60. package/dist-types/ts3.4/models/models_4.d.ts +189 -13
  61. package/dist-types/ts3.4/schemas/schemas_0.d.ts +33 -0
  62. package/package.json +3 -3
@@ -1,6 +1,8 @@
1
1
  import {
2
2
  ActionConnectorType,
3
3
  AggType,
4
+ AnalysisFilterAttribute,
5
+ AnchorType,
4
6
  AnonymousUserDashboardEmbeddingConfigurationDisabledFeature,
5
7
  AnonymousUserDashboardEmbeddingConfigurationEnabledFeature,
6
8
  AssetBundleExportFormat,
@@ -34,16 +36,14 @@ import {
34
36
  DashboardBehavior,
35
37
  DashboardUIState,
36
38
  DataSetDateComparisonFilterOperator,
37
- DataSetImportMode,
38
39
  DataSetNumericComparisonFilterOperator,
39
40
  DatasetParameterValueType,
40
41
  DataSetStringComparisonFilterOperator,
41
42
  DataSetStringListFilterOperator,
42
- DataSetUseAs,
43
43
  DisplayFormat,
44
44
  Edition,
45
- FileFormat,
46
45
  FilterClass,
46
+ FilterOperator,
47
47
  GeoSpatialCountryCode,
48
48
  GeoSpatialDataRole,
49
49
  InputColumnDataType,
@@ -55,14 +55,11 @@ import {
55
55
  RefreshFailureAlertStatus,
56
56
  ResourceStatus,
57
57
  ReviewedAnswerErrorCode,
58
- RowLevelPermissionFormatVersion,
59
- RowLevelPermissionPolicy,
60
58
  ServiceType,
59
+ SheetContentType,
61
60
  SnapshotFileFormatType,
62
61
  SnapshotFileSheetSelectionScope,
63
62
  StarburstProductType,
64
- Status,
65
- TextQualifier,
66
63
  TimeGranularity,
67
64
  TopicIRFilterFunction,
68
65
  TopicIRFilterType,
@@ -80,8 +77,12 @@ import {
80
77
  AggregateOperation,
81
78
  AnalysisDefaults,
82
79
  AssetOptions,
80
+ ChartAxisLabelOptions,
83
81
  DataPrepAggregationFunction,
82
+ QueryExecutionOptions,
84
83
  TransformOperationSource,
84
+ VisualCustomActionDefaults,
85
+ VisualInteractionOptions,
85
86
  VisualMenuOption,
86
87
  AggregationPartitionBy,
87
88
  AmazonElasticsearchParameters,
@@ -90,18 +91,177 @@ import {
90
91
  ColumnConfiguration,
91
92
  DataSetColumnIdMapping,
92
93
  DataSetIdentifierDeclaration,
94
+ FilterControl,
93
95
  FilterGroup,
96
+ Layout,
97
+ ParameterControl,
94
98
  ParameterDeclaration,
99
+ SheetControlLayout,
100
+ SheetImage,
101
+ SheetTextBox,
102
+ VisualCustomAction,
95
103
  } from "./models_0";
96
104
  import {
97
- AnalysisDefinition,
98
- AnalysisSourceEntity,
99
- Anchor,
100
- AnonymousUserDashboardFeatureConfigurations,
101
- DataSetReference,
102
- SheetDefinition,
103
- StaticFile,
105
+ BarChartVisual,
106
+ BoxPlotVisual,
107
+ ComboChartVisual,
108
+ CustomContentVisual,
109
+ EmptyVisual,
110
+ FilledMapVisual,
111
+ FunnelChartVisual,
112
+ GaugeChartVisual,
113
+ GeospatialMapVisual,
114
+ HeatMapVisual,
115
+ HistogramVisual,
116
+ InsightVisual,
117
+ KPIVisual,
118
+ LayerMapVisual,
119
+ LineChartVisual,
120
+ PieChartVisual,
121
+ PivotTableVisual,
122
+ PluginVisual,
123
+ RadarChartVisual,
124
+ SankeyDiagramVisual,
125
+ ScatterPlotVisual,
126
+ TableVisual,
127
+ TreeMapVisual,
128
+ VisualSubtitleLabelOptions,
129
+ VisualTitleLabelOptions,
130
+ WaterfallVisual,
131
+ WordCloudFieldWells,
132
+ WordCloudOptions,
133
+ WordCloudSortConfiguration,
134
+ ColumnHierarchy,
104
135
  } from "./models_1";
136
+ export interface WordCloudChartConfiguration {
137
+ FieldWells?: WordCloudFieldWells | undefined;
138
+ SortConfiguration?: WordCloudSortConfiguration | undefined;
139
+ CategoryLabelOptions?: ChartAxisLabelOptions | undefined;
140
+ WordCloudOptions?: WordCloudOptions | undefined;
141
+ Interactions?: VisualInteractionOptions | undefined;
142
+ }
143
+ export interface WordCloudVisual {
144
+ VisualId: string | undefined;
145
+ Title?: VisualTitleLabelOptions | undefined;
146
+ Subtitle?: VisualSubtitleLabelOptions | undefined;
147
+ ChartConfiguration?: WordCloudChartConfiguration | undefined;
148
+ Actions?: VisualCustomAction[] | undefined;
149
+ ColumnHierarchies?: ColumnHierarchy[] | undefined;
150
+ VisualContentAltText?: string | undefined;
151
+ }
152
+ export interface Visual {
153
+ TableVisual?: TableVisual | undefined;
154
+ PivotTableVisual?: PivotTableVisual | undefined;
155
+ BarChartVisual?: BarChartVisual | undefined;
156
+ KPIVisual?: KPIVisual | undefined;
157
+ PieChartVisual?: PieChartVisual | undefined;
158
+ GaugeChartVisual?: GaugeChartVisual | undefined;
159
+ LineChartVisual?: LineChartVisual | undefined;
160
+ HeatMapVisual?: HeatMapVisual | undefined;
161
+ TreeMapVisual?: TreeMapVisual | undefined;
162
+ GeospatialMapVisual?: GeospatialMapVisual | undefined;
163
+ FilledMapVisual?: FilledMapVisual | undefined;
164
+ LayerMapVisual?: LayerMapVisual | undefined;
165
+ FunnelChartVisual?: FunnelChartVisual | undefined;
166
+ ScatterPlotVisual?: ScatterPlotVisual | undefined;
167
+ ComboChartVisual?: ComboChartVisual | undefined;
168
+ BoxPlotVisual?: BoxPlotVisual | undefined;
169
+ WaterfallVisual?: WaterfallVisual | undefined;
170
+ HistogramVisual?: HistogramVisual | undefined;
171
+ WordCloudVisual?: WordCloudVisual | undefined;
172
+ InsightVisual?: InsightVisual | undefined;
173
+ SankeyDiagramVisual?: SankeyDiagramVisual | undefined;
174
+ CustomContentVisual?: CustomContentVisual | undefined;
175
+ EmptyVisual?: EmptyVisual | undefined;
176
+ RadarChartVisual?: RadarChartVisual | undefined;
177
+ PluginVisual?: PluginVisual | undefined;
178
+ }
179
+ export interface SheetDefinition {
180
+ SheetId: string | undefined;
181
+ Title?: string | undefined;
182
+ Description?: string | undefined;
183
+ Name?: string | undefined;
184
+ ParameterControls?: ParameterControl[] | undefined;
185
+ FilterControls?: FilterControl[] | undefined;
186
+ Visuals?: Visual[] | undefined;
187
+ TextBoxes?: SheetTextBox[] | undefined;
188
+ Images?: SheetImage[] | undefined;
189
+ Layouts?: Layout[] | undefined;
190
+ SheetControlLayouts?: SheetControlLayout[] | undefined;
191
+ ContentType?: SheetContentType | undefined;
192
+ CustomActionDefaults?: VisualCustomActionDefaults | undefined;
193
+ }
194
+ export interface StaticFileS3SourceOptions {
195
+ BucketName: string | undefined;
196
+ ObjectKey: string | undefined;
197
+ Region: string | undefined;
198
+ }
199
+ export interface StaticFileUrlSourceOptions {
200
+ Url: string | undefined;
201
+ }
202
+ export interface StaticFileSource {
203
+ UrlOptions?: StaticFileUrlSourceOptions | undefined;
204
+ S3Options?: StaticFileS3SourceOptions | undefined;
205
+ }
206
+ export interface ImageStaticFile {
207
+ StaticFileId: string | undefined;
208
+ Source?: StaticFileSource | undefined;
209
+ }
210
+ export interface SpatialStaticFile {
211
+ StaticFileId: string | undefined;
212
+ Source?: StaticFileSource | undefined;
213
+ }
214
+ export interface StaticFile {
215
+ ImageStaticFile?: ImageStaticFile | undefined;
216
+ SpatialStaticFile?: SpatialStaticFile | undefined;
217
+ }
218
+ export interface AnalysisDefinition {
219
+ DataSetIdentifierDeclarations: DataSetIdentifierDeclaration[] | undefined;
220
+ Sheets?: SheetDefinition[] | undefined;
221
+ CalculatedFields?: CalculatedField[] | undefined;
222
+ ParameterDeclarations?: ParameterDeclaration[] | undefined;
223
+ FilterGroups?: FilterGroup[] | undefined;
224
+ ColumnConfigurations?: ColumnConfiguration[] | undefined;
225
+ AnalysisDefaults?: AnalysisDefaults | undefined;
226
+ Options?: AssetOptions | undefined;
227
+ QueryExecutionOptions?: QueryExecutionOptions | undefined;
228
+ StaticFiles?: StaticFile[] | undefined;
229
+ }
230
+ export interface AnalysisSearchFilter {
231
+ Operator?: FilterOperator | undefined;
232
+ Name?: AnalysisFilterAttribute | undefined;
233
+ Value?: string | undefined;
234
+ }
235
+ export interface DataSetReference {
236
+ DataSetPlaceholder: string | undefined;
237
+ DataSetArn: string | undefined;
238
+ }
239
+ export interface AnalysisSourceTemplate {
240
+ DataSetReferences: DataSetReference[] | undefined;
241
+ Arn: string | undefined;
242
+ }
243
+ export interface AnalysisSourceEntity {
244
+ SourceTemplate?: AnalysisSourceTemplate | undefined;
245
+ }
246
+ export interface AnalysisSummary {
247
+ Arn?: string | undefined;
248
+ AnalysisId?: string | undefined;
249
+ Name?: string | undefined;
250
+ Status?: ResourceStatus | undefined;
251
+ CreatedTime?: Date | undefined;
252
+ LastUpdatedTime?: Date | undefined;
253
+ }
254
+ export interface Anchor {
255
+ AnchorType?: AnchorType | undefined;
256
+ TimeGranularity?: TimeGranularity | undefined;
257
+ Offset?: number | undefined;
258
+ }
259
+ export interface SharedViewConfigurations {
260
+ Enabled: boolean | undefined;
261
+ }
262
+ export interface AnonymousUserDashboardFeatureConfigurations {
263
+ SharedView?: SharedViewConfigurations | undefined;
264
+ }
105
265
  export interface AnonymousUserDashboardEmbeddingConfiguration {
106
266
  InitialDashboardId: string | undefined;
107
267
  EnabledFeatures?:
@@ -3049,165 +3209,3 @@ export interface LogicalTable {
3049
3209
  DataTransforms?: TransformOperation[] | undefined;
3050
3210
  Source: LogicalTableSource | undefined;
3051
3211
  }
3052
- export interface UniqueKey {
3053
- ColumnNames: string[] | undefined;
3054
- }
3055
- export interface PerformanceConfiguration {
3056
- UniqueKeys?: UniqueKey[] | undefined;
3057
- }
3058
- export interface CustomSql {
3059
- DataSourceArn: string | undefined;
3060
- Name: string | undefined;
3061
- SqlQuery: string | undefined;
3062
- Columns?: InputColumn[] | undefined;
3063
- }
3064
- export interface RelationalTable {
3065
- DataSourceArn: string | undefined;
3066
- Catalog?: string | undefined;
3067
- Schema?: string | undefined;
3068
- Name: string | undefined;
3069
- InputColumns: InputColumn[] | undefined;
3070
- }
3071
- export interface UploadSettings {
3072
- Format?: FileFormat | undefined;
3073
- StartFromRow?: number | undefined;
3074
- ContainsHeader?: boolean | undefined;
3075
- TextQualifier?: TextQualifier | undefined;
3076
- Delimiter?: string | undefined;
3077
- CustomCellAddressRange?: string | undefined;
3078
- }
3079
- export interface S3Source {
3080
- DataSourceArn: string | undefined;
3081
- UploadSettings?: UploadSettings | undefined;
3082
- InputColumns: InputColumn[] | undefined;
3083
- }
3084
- export interface TablePathElement {
3085
- Name?: string | undefined;
3086
- Id?: string | undefined;
3087
- }
3088
- export interface SaaSTable {
3089
- DataSourceArn: string | undefined;
3090
- TablePath: TablePathElement[] | undefined;
3091
- InputColumns: InputColumn[] | undefined;
3092
- }
3093
- export type PhysicalTable =
3094
- | PhysicalTable.CustomSqlMember
3095
- | PhysicalTable.RelationalTableMember
3096
- | PhysicalTable.S3SourceMember
3097
- | PhysicalTable.SaaSTableMember
3098
- | PhysicalTable.$UnknownMember;
3099
- export declare namespace PhysicalTable {
3100
- interface RelationalTableMember {
3101
- RelationalTable: RelationalTable;
3102
- CustomSql?: never;
3103
- S3Source?: never;
3104
- SaaSTable?: never;
3105
- $unknown?: never;
3106
- }
3107
- interface CustomSqlMember {
3108
- RelationalTable?: never;
3109
- CustomSql: CustomSql;
3110
- S3Source?: never;
3111
- SaaSTable?: never;
3112
- $unknown?: never;
3113
- }
3114
- interface S3SourceMember {
3115
- RelationalTable?: never;
3116
- CustomSql?: never;
3117
- S3Source: S3Source;
3118
- SaaSTable?: never;
3119
- $unknown?: never;
3120
- }
3121
- interface SaaSTableMember {
3122
- RelationalTable?: never;
3123
- CustomSql?: never;
3124
- S3Source?: never;
3125
- SaaSTable: SaaSTable;
3126
- $unknown?: never;
3127
- }
3128
- interface $UnknownMember {
3129
- RelationalTable?: never;
3130
- CustomSql?: never;
3131
- S3Source?: never;
3132
- SaaSTable?: never;
3133
- $unknown: [string, any];
3134
- }
3135
- interface Visitor<T> {
3136
- RelationalTable: (value: RelationalTable) => T;
3137
- CustomSql: (value: CustomSql) => T;
3138
- S3Source: (value: S3Source) => T;
3139
- SaaSTable: (value: SaaSTable) => T;
3140
- _: (name: string, value: any) => T;
3141
- }
3142
- }
3143
- export interface RowLevelPermissionDataSet {
3144
- Namespace?: string | undefined;
3145
- Arn: string | undefined;
3146
- PermissionPolicy: RowLevelPermissionPolicy | undefined;
3147
- FormatVersion?: RowLevelPermissionFormatVersion | undefined;
3148
- Status?: Status | undefined;
3149
- }
3150
- export interface RowLevelPermissionTagRule {
3151
- TagKey: string | undefined;
3152
- ColumnName: string | undefined;
3153
- TagMultiValueDelimiter?: string | undefined;
3154
- MatchAllValue?: string | undefined;
3155
- }
3156
- export interface RowLevelPermissionTagConfiguration {
3157
- Status?: Status | undefined;
3158
- TagRules: RowLevelPermissionTagRule[] | undefined;
3159
- TagRuleConfigurations?: string[][] | undefined;
3160
- }
3161
- export interface RowLevelPermissionConfiguration {
3162
- TagConfiguration?: RowLevelPermissionTagConfiguration | undefined;
3163
- RowLevelPermissionDataSet?: RowLevelPermissionDataSet | undefined;
3164
- }
3165
- export interface SemanticTable {
3166
- Alias: string | undefined;
3167
- DestinationTableId: string | undefined;
3168
- RowLevelPermissionConfiguration?: RowLevelPermissionConfiguration | undefined;
3169
- }
3170
- export interface SemanticModelConfiguration {
3171
- TableMap?: Record<string, SemanticTable> | undefined;
3172
- }
3173
- export interface CreateDataSetRequest {
3174
- AwsAccountId: string | undefined;
3175
- DataSetId: string | undefined;
3176
- Name: string | undefined;
3177
- PhysicalTableMap: Record<string, PhysicalTable> | undefined;
3178
- LogicalTableMap?: Record<string, LogicalTable> | undefined;
3179
- ImportMode: DataSetImportMode | undefined;
3180
- ColumnGroups?: ColumnGroup[] | undefined;
3181
- FieldFolders?: Record<string, FieldFolder> | undefined;
3182
- Permissions?: ResourcePermission[] | undefined;
3183
- RowLevelPermissionDataSet?: RowLevelPermissionDataSet | undefined;
3184
- RowLevelPermissionTagConfiguration?:
3185
- | RowLevelPermissionTagConfiguration
3186
- | undefined;
3187
- ColumnLevelPermissionRules?: ColumnLevelPermissionRule[] | undefined;
3188
- Tags?: Tag[] | undefined;
3189
- DataSetUsageConfiguration?: DataSetUsageConfiguration | undefined;
3190
- DatasetParameters?: DatasetParameter[] | undefined;
3191
- FolderArns?: string[] | undefined;
3192
- PerformanceConfiguration?: PerformanceConfiguration | undefined;
3193
- UseAs?: DataSetUseAs | undefined;
3194
- DataPrepConfiguration?: DataPrepConfiguration | undefined;
3195
- SemanticModelConfiguration?: SemanticModelConfiguration | undefined;
3196
- }
3197
- export interface CreateDataSetResponse {
3198
- Arn?: string | undefined;
3199
- DataSetId?: string | undefined;
3200
- IngestionArn?: string | undefined;
3201
- IngestionId?: string | undefined;
3202
- RequestId?: string | undefined;
3203
- Status?: number | undefined;
3204
- }
3205
- export interface CredentialPair {
3206
- Username: string | undefined;
3207
- Password: string | undefined;
3208
- AlternateDataSourceParameters?: DataSourceParameters[] | undefined;
3209
- }
3210
- export interface WebProxyCredentials {
3211
- WebProxyUsername: string | undefined;
3212
- WebProxyPassword: string | undefined;
3213
- }