@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.
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 +2 -2
@@ -1,8 +1,617 @@
1
- import { AssetBundleExportFormat, AssetBundleImportFailureAction, AssignmentStatus, DashboardsQAStatus, DataSetImportMode, EmbeddingIdentityType, FieldName, FilterOperator, FlowPublishState, FolderFilterAttribute, FolderType, GeneratedAnswerStatus, GroupFilterAttribute, GroupFilterOperator, IdentityType, IncludeFolderMembers, IncludeGeneratedAnswer, IncludeQuickSightQIndex, NetworkInterfaceStatus, PersonalizationMode, PurchaseMode, QAResultType, QSearchStatus, ResourceStatus, Role, SearchFilterOperator, ServiceType, SharingModel, ThemeType, TopicFilterAttribute, TopicFilterOperator, TopicUserExperienceVersion, UserRole, VisualRole, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./enums";
1
+ import { AssetBundleExportFormat, AssetBundleImportFailureAction, AssignmentStatus, DashboardsQAStatus, DataSetImportMode, EmbeddingIdentityType, FieldName, FilterOperator, FlowPublishState, FolderFilterAttribute, FolderType, GeneratedAnswerStatus, GroupFilterAttribute, GroupFilterOperator, IdentityType, IncludeFolderMembers, IncludeGeneratedAnswer, IncludeQuickSightQIndex, NetworkInterfaceStatus, PersonalizationMode, PurchaseMode, QAResultType, QSearchStatus, ResourceStatus, Role, SearchFilterOperator, ServiceType, SharingModel, ThemeErrorType, ThemeType, TopicFilterAttribute, TopicFilterOperator, TopicRefreshStatus, TopicUserExperienceVersion, UserRole, VisualRole, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./enums";
2
2
  import { type AccountCustomization, type AmazonQInQuickSightConsoleConfigurations, type AmazonQInQuickSightDashboardConfigurations, ActionConnectorSearchFilter, ActionConnectorSummary, ActiveIAMPolicyAssignment } from "./models_0";
3
- import { type AnalysisDefinition, type AnalysisSourceEntity, type SharedViewConfigurations, AnalysisSearchFilter, AnalysisSummary } from "./models_1";
4
- import { type _Parameters, type AnonymousUserEmbeddingExperienceConfiguration, type AssetBundleCloudFormationOverridePropertyConfiguration, type AssetBundleExportJobValidationStrategy, type AssetBundleImportJobOverrideParameters, type AssetBundleImportJobOverridePermissions, type AssetBundleImportJobOverrideTags, type AssetBundleImportJobOverrideValidationStrategy, type AssetBundleImportSource, type AuthConfig, type BookmarksConfigurations, type BrandDefinition, type BrandDetail, type Capabilities, type DashboardPublishOptions, type DashboardSourceEntity, type DashboardVersionDefinition, type DashboardVisualId, type DataPrepConfiguration, type DataSetRefreshProperties, type DataSetUsageConfiguration, type DataSourceParameters, type LinkSharingConfiguration, type PerformanceConfiguration, type RowLevelPermissionDataSet, type RowLevelPermissionTagConfiguration, type SemanticModelConfiguration, type SslProperties, type TopicIR, type TopicTemplate, type ValidationStrategy, type VpcConnectionProperties, AssetBundleExportJobSummary, AssetBundleImportJobSummary, AuthorizedTargetsByService, BrandSummary, ColumnGroup, ColumnLevelPermissionRule, DatasetParameter, FieldFolder, LogicalTable, PhysicalTable, ResourcePermission, Tag } from "./models_2";
5
- import { type CustomInstructions, type DashboardVisualResult, type DataSourceCredentials, type SnapshotConfiguration, type TemplateSourceEntity, type TemplateVersionDefinition, type ThemeConfiguration, type TopicDetails, type TopicRefreshSchedule, CustomPermissions, DashboardSearchFilter, DashboardSummary, DashboardVersionSummary, DataSetSearchFilter, DataSetSummary, DataSource, DataSourceSearchFilter, DataSourceSummary, Group, GroupMember, Ingestion, NamespaceInfoV2, RefreshSchedule, RegisteredCustomerManagedKey, TemplateAlias, ThemeAlias, User } from "./models_3";
3
+ import { type _Parameters, type AnalysisDefinition, type AnalysisSourceEntity, type AnonymousUserEmbeddingExperienceConfiguration, type AssetBundleCloudFormationOverridePropertyConfiguration, type AssetBundleExportJobValidationStrategy, type AssetBundleImportJobOverrideParameters, type AssetBundleImportJobOverridePermissions, type AssetBundleImportJobOverrideTags, type AssetBundleImportJobOverrideValidationStrategy, type AssetBundleImportSource, type AuthConfig, type BookmarksConfigurations, type BrandDefinition, type BrandDetail, type Capabilities, type DashboardPublishOptions, type DashboardSourceEntity, type DashboardVersionDefinition, type DashboardVisualId, type DataPrepConfiguration, type DataSetRefreshProperties, type DataSetUsageConfiguration, type DataSourceParameters, type LinkSharingConfiguration, type SharedViewConfigurations, type SslProperties, type TopicIR, type TopicTemplate, type ValidationStrategy, type VpcConnectionProperties, AnalysisSearchFilter, AnalysisSummary, AssetBundleExportJobSummary, AssetBundleImportJobSummary, AuthorizedTargetsByService, BrandSummary, ColumnGroup, ColumnLevelPermissionRule, DatasetParameter, FieldFolder, LogicalTable, ResourcePermission, Tag } from "./models_2";
4
+ import { type CustomInstructions, type DashboardVisualResult, type DataSourceCredentials, type PerformanceConfiguration, type RowLevelPermissionDataSet, type RowLevelPermissionTagConfiguration, type SemanticModelConfiguration, type SnapshotConfiguration, type TemplateSourceEntity, type TemplateVersionDefinition, type ThemeConfiguration, type TopicDetails, type TopicRefreshSchedule, CustomPermissions, DashboardSearchFilter, DashboardSummary, DashboardVersionSummary, DataSetSearchFilter, DataSetSummary, DataSource, DataSourceSearchFilter, DataSourceSummary, Group, GroupMember, Ingestion, NamespaceInfoV2, PhysicalTable, RefreshSchedule, RegisteredCustomerManagedKey, TemplateAlias, ThemeAlias } from "./models_3";
5
+ /**
6
+ * @public
7
+ */
8
+ export interface DescribeThemeRequest {
9
+ /**
10
+ * <p>The ID of the Amazon Web Services account that contains the theme that you're describing.</p>
11
+ * @public
12
+ */
13
+ AwsAccountId: string | undefined;
14
+ /**
15
+ * <p>The ID for the theme.</p>
16
+ * @public
17
+ */
18
+ ThemeId: string | undefined;
19
+ /**
20
+ * <p>The version number for the version to describe. If a <code>VersionNumber</code> parameter
21
+ * value isn't provided, the latest version of the theme is described.</p>
22
+ * @public
23
+ */
24
+ VersionNumber?: number | undefined;
25
+ /**
26
+ * <p>The alias of the theme that you want to describe. If you name a specific alias, you
27
+ * describe the version that the alias points to. You can specify the latest version of the
28
+ * theme by providing the keyword <code>$LATEST</code> in the <code>AliasName</code>
29
+ * parameter. The keyword <code>$PUBLISHED</code> doesn't apply to themes.</p>
30
+ * @public
31
+ */
32
+ AliasName?: string | undefined;
33
+ }
34
+ /**
35
+ * <p>Theme error.</p>
36
+ * @public
37
+ */
38
+ export interface ThemeError {
39
+ /**
40
+ * <p>The type of error.</p>
41
+ * @public
42
+ */
43
+ Type?: ThemeErrorType | undefined;
44
+ /**
45
+ * <p>The error message.</p>
46
+ * @public
47
+ */
48
+ Message?: string | undefined;
49
+ }
50
+ /**
51
+ * <p>A version of a theme.</p>
52
+ * @public
53
+ */
54
+ export interface ThemeVersion {
55
+ /**
56
+ * <p>The version number of the theme.</p>
57
+ * @public
58
+ */
59
+ VersionNumber?: number | undefined;
60
+ /**
61
+ * <p>The Amazon Resource Name (ARN) of the resource.</p>
62
+ * @public
63
+ */
64
+ Arn?: string | undefined;
65
+ /**
66
+ * <p>The description of the theme.</p>
67
+ * @public
68
+ */
69
+ Description?: string | undefined;
70
+ /**
71
+ * <p>The Quick Sight-defined ID of the theme that a custom theme inherits from. All
72
+ * themes initially inherit from a default Quick Sight theme.</p>
73
+ * @public
74
+ */
75
+ BaseThemeId?: string | undefined;
76
+ /**
77
+ * <p>The date and time that this theme version was created.</p>
78
+ * @public
79
+ */
80
+ CreatedTime?: Date | undefined;
81
+ /**
82
+ * <p>The theme configuration, which contains all the theme display properties.</p>
83
+ * @public
84
+ */
85
+ Configuration?: ThemeConfiguration | undefined;
86
+ /**
87
+ * <p>Errors associated with the theme.</p>
88
+ * @public
89
+ */
90
+ Errors?: ThemeError[] | undefined;
91
+ /**
92
+ * <p>The status of the theme version.</p>
93
+ * @public
94
+ */
95
+ Status?: ResourceStatus | undefined;
96
+ }
97
+ /**
98
+ * <p>Summary information about a theme.</p>
99
+ * @public
100
+ */
101
+ export interface Theme {
102
+ /**
103
+ * <p>The Amazon Resource Name (ARN) of the theme.</p>
104
+ * @public
105
+ */
106
+ Arn?: string | undefined;
107
+ /**
108
+ * <p>The name that the user gives to the theme.</p>
109
+ * @public
110
+ */
111
+ Name?: string | undefined;
112
+ /**
113
+ * <p>The identifier that the user gives to the theme.</p>
114
+ * @public
115
+ */
116
+ ThemeId?: string | undefined;
117
+ /**
118
+ * <p>A version of a theme.</p>
119
+ * @public
120
+ */
121
+ Version?: ThemeVersion | undefined;
122
+ /**
123
+ * <p>The date and time that the theme was created.</p>
124
+ * @public
125
+ */
126
+ CreatedTime?: Date | undefined;
127
+ /**
128
+ * <p>The date and time that the theme was last updated.</p>
129
+ * @public
130
+ */
131
+ LastUpdatedTime?: Date | undefined;
132
+ /**
133
+ * <p>The type of theme, based on how it was created. Valid values include:
134
+ * <code>QUICKSIGHT</code> and <code>CUSTOM</code>.</p>
135
+ * @public
136
+ */
137
+ Type?: ThemeType | undefined;
138
+ }
139
+ /**
140
+ * @public
141
+ */
142
+ export interface DescribeThemeResponse {
143
+ /**
144
+ * <p>The information about the theme that you are describing.</p>
145
+ * @public
146
+ */
147
+ Theme?: Theme | undefined;
148
+ /**
149
+ * <p>The HTTP status of the request.</p>
150
+ * @public
151
+ */
152
+ Status?: number | undefined;
153
+ /**
154
+ * <p>The Amazon Web Services request ID for this operation.</p>
155
+ * @public
156
+ */
157
+ RequestId?: string | undefined;
158
+ }
159
+ /**
160
+ * @public
161
+ */
162
+ export interface DescribeThemeAliasRequest {
163
+ /**
164
+ * <p>The ID of the Amazon Web Services account that contains the theme alias that you're
165
+ * describing.</p>
166
+ * @public
167
+ */
168
+ AwsAccountId: string | undefined;
169
+ /**
170
+ * <p>The ID for the theme.</p>
171
+ * @public
172
+ */
173
+ ThemeId: string | undefined;
174
+ /**
175
+ * <p>The name of the theme alias that you want to describe.</p>
176
+ * @public
177
+ */
178
+ AliasName: string | undefined;
179
+ }
180
+ /**
181
+ * @public
182
+ */
183
+ export interface DescribeThemeAliasResponse {
184
+ /**
185
+ * <p>Information about the theme alias.</p>
186
+ * @public
187
+ */
188
+ ThemeAlias?: ThemeAlias | undefined;
189
+ /**
190
+ * <p>The HTTP status of the request.</p>
191
+ * @public
192
+ */
193
+ Status?: number | undefined;
194
+ /**
195
+ * <p>The Amazon Web Services request ID for this operation.</p>
196
+ * @public
197
+ */
198
+ RequestId?: string | undefined;
199
+ }
200
+ /**
201
+ * @public
202
+ */
203
+ export interface DescribeThemePermissionsRequest {
204
+ /**
205
+ * <p>The ID of the Amazon Web Services account that contains the theme that you're describing.</p>
206
+ * @public
207
+ */
208
+ AwsAccountId: string | undefined;
209
+ /**
210
+ * <p>The ID for the theme that you want to describe permissions for.</p>
211
+ * @public
212
+ */
213
+ ThemeId: string | undefined;
214
+ }
215
+ /**
216
+ * @public
217
+ */
218
+ export interface DescribeThemePermissionsResponse {
219
+ /**
220
+ * <p>The ID for the theme.</p>
221
+ * @public
222
+ */
223
+ ThemeId?: string | undefined;
224
+ /**
225
+ * <p>The Amazon Resource Name (ARN) of the theme.</p>
226
+ * @public
227
+ */
228
+ ThemeArn?: string | undefined;
229
+ /**
230
+ * <p>A list of resource permissions set on the theme. </p>
231
+ * @public
232
+ */
233
+ Permissions?: ResourcePermission[] | undefined;
234
+ /**
235
+ * <p>The Amazon Web Services request ID for this operation.</p>
236
+ * @public
237
+ */
238
+ RequestId?: string | undefined;
239
+ /**
240
+ * <p>The HTTP status of the request.</p>
241
+ * @public
242
+ */
243
+ Status?: number | undefined;
244
+ }
245
+ /**
246
+ * @public
247
+ */
248
+ export interface DescribeTopicRequest {
249
+ /**
250
+ * <p>The Amazon Web Services account ID.</p>
251
+ * @public
252
+ */
253
+ AwsAccountId: string | undefined;
254
+ /**
255
+ * <p>The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
256
+ * @public
257
+ */
258
+ TopicId: string | undefined;
259
+ }
260
+ /**
261
+ * @public
262
+ */
263
+ export interface DescribeTopicResponse {
264
+ /**
265
+ * <p>The Amazon Resource Name (ARN) of the topic.</p>
266
+ * @public
267
+ */
268
+ Arn?: string | undefined;
269
+ /**
270
+ * <p>The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
271
+ * @public
272
+ */
273
+ TopicId?: string | undefined;
274
+ /**
275
+ * <p>The definition of a topic.</p>
276
+ * @public
277
+ */
278
+ Topic?: TopicDetails | undefined;
279
+ /**
280
+ * <p>The Amazon Web Services request ID for this operation.</p>
281
+ * @public
282
+ */
283
+ RequestId?: string | undefined;
284
+ /**
285
+ * <p>The HTTP status of the request.</p>
286
+ * @public
287
+ */
288
+ Status?: number | undefined;
289
+ /**
290
+ * <p>Custom instructions for the topic.</p>
291
+ * @public
292
+ */
293
+ CustomInstructions?: CustomInstructions | undefined;
294
+ }
295
+ /**
296
+ * @public
297
+ */
298
+ export interface DescribeTopicPermissionsRequest {
299
+ /**
300
+ * <p>The ID of the Amazon Web Services account that contains the topic that you want
301
+ * described.</p>
302
+ * @public
303
+ */
304
+ AwsAccountId: string | undefined;
305
+ /**
306
+ * <p>The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
307
+ * @public
308
+ */
309
+ TopicId: string | undefined;
310
+ }
311
+ /**
312
+ * @public
313
+ */
314
+ export interface DescribeTopicPermissionsResponse {
315
+ /**
316
+ * <p>The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
317
+ * @public
318
+ */
319
+ TopicId?: string | undefined;
320
+ /**
321
+ * <p>The Amazon Resource Name (ARN) of the topic.</p>
322
+ * @public
323
+ */
324
+ TopicArn?: string | undefined;
325
+ /**
326
+ * <p>A list of resource permissions that are configured to the topic.</p>
327
+ * @public
328
+ */
329
+ Permissions?: ResourcePermission[] | undefined;
330
+ /**
331
+ * <p>The HTTP status of the request.</p>
332
+ * @public
333
+ */
334
+ Status?: number | undefined;
335
+ /**
336
+ * <p>The Amazon Web Services request ID for this operation.</p>
337
+ * @public
338
+ */
339
+ RequestId?: string | undefined;
340
+ }
341
+ /**
342
+ * @public
343
+ */
344
+ export interface DescribeTopicRefreshRequest {
345
+ /**
346
+ * <p>The ID of the Amazon Web Services account that contains the topic whose refresh you want
347
+ * to describe.</p>
348
+ * @public
349
+ */
350
+ AwsAccountId: string | undefined;
351
+ /**
352
+ * <p>The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
353
+ * @public
354
+ */
355
+ TopicId: string | undefined;
356
+ /**
357
+ * <p>The ID of the refresh, which is performed when the topic is created or updated.</p>
358
+ * @public
359
+ */
360
+ RefreshId: string | undefined;
361
+ }
362
+ /**
363
+ * <p>The details about the refresh of a topic.</p>
364
+ * @public
365
+ */
366
+ export interface TopicRefreshDetails {
367
+ /**
368
+ * <p>The Amazon Resource Name (ARN) of the topic refresh.</p>
369
+ * @public
370
+ */
371
+ RefreshArn?: string | undefined;
372
+ /**
373
+ * <p>The ID of the refresh, which occurs as a result of topic creation or topic update.</p>
374
+ * @public
375
+ */
376
+ RefreshId?: string | undefined;
377
+ /**
378
+ * <p>The status of the refresh job that indicates whether the job is still running, completed successfully, or failed.</p>
379
+ * @public
380
+ */
381
+ RefreshStatus?: TopicRefreshStatus | undefined;
382
+ }
383
+ /**
384
+ * @public
385
+ */
386
+ export interface DescribeTopicRefreshResponse {
387
+ /**
388
+ * <p>Details of the refresh, which is performed when the topic is created or updated.</p>
389
+ * @public
390
+ */
391
+ RefreshDetails?: TopicRefreshDetails | undefined;
392
+ /**
393
+ * <p>The Amazon Web Services request ID for this operation.</p>
394
+ * @public
395
+ */
396
+ RequestId?: string | undefined;
397
+ /**
398
+ * <p>The HTTP status of the request.</p>
399
+ * @public
400
+ */
401
+ Status?: number | undefined;
402
+ }
403
+ /**
404
+ * @public
405
+ */
406
+ export interface DescribeTopicRefreshScheduleRequest {
407
+ /**
408
+ * <p>The Amazon Web Services account ID.</p>
409
+ * @public
410
+ */
411
+ AwsAccountId: string | undefined;
412
+ /**
413
+ * <p>The ID of the topic that contains the refresh schedule that you want to describe. This
414
+ * ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
415
+ * @public
416
+ */
417
+ TopicId: string | undefined;
418
+ /**
419
+ * <p>The ID of the dataset.</p>
420
+ * @public
421
+ */
422
+ DatasetId: string | undefined;
423
+ }
424
+ /**
425
+ * @public
426
+ */
427
+ export interface DescribeTopicRefreshScheduleResponse {
428
+ /**
429
+ * <p>The ID of the topic that contains the refresh schedule that you want to describe. This
430
+ * ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
431
+ * @public
432
+ */
433
+ TopicId?: string | undefined;
434
+ /**
435
+ * <p>The Amazon Resource Name (ARN) of the topic.</p>
436
+ * @public
437
+ */
438
+ TopicArn?: string | undefined;
439
+ /**
440
+ * <p>The Amazon Resource Name (ARN) of the dataset.</p>
441
+ * @public
442
+ */
443
+ DatasetArn?: string | undefined;
444
+ /**
445
+ * <p>The definition of a refresh schedule.</p>
446
+ * @public
447
+ */
448
+ RefreshSchedule?: TopicRefreshSchedule | undefined;
449
+ /**
450
+ * <p>The HTTP status of the request.</p>
451
+ * @public
452
+ */
453
+ Status?: number | undefined;
454
+ /**
455
+ * <p>The Amazon Web Services request ID for this operation.</p>
456
+ * @public
457
+ */
458
+ RequestId?: string | undefined;
459
+ }
460
+ /**
461
+ * @public
462
+ */
463
+ export interface DescribeUserRequest {
464
+ /**
465
+ * <p>The name of the user that you want to describe.</p>
466
+ * @public
467
+ */
468
+ UserName: string | undefined;
469
+ /**
470
+ * <p>The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the
471
+ * Amazon Web Services account that contains your Amazon Quick Sight account.</p>
472
+ * @public
473
+ */
474
+ AwsAccountId: string | undefined;
475
+ /**
476
+ * <p>The namespace. Currently, you should set this to <code>default</code>.</p>
477
+ * @public
478
+ */
479
+ Namespace: string | undefined;
480
+ }
481
+ /**
482
+ * <p>A registered user of Quick Sight. </p>
483
+ * @public
484
+ */
485
+ export interface User {
486
+ /**
487
+ * <p>The Amazon Resource Name (ARN) for the user.</p>
488
+ * @public
489
+ */
490
+ Arn?: string | undefined;
491
+ /**
492
+ * <p>The user's user name. This value is required if you are registering a user that will be managed in Quick Sight. In the output, the value for <code>UserName</code> is
493
+ * <code>N/A</code> when the value for <code>IdentityType</code> is <code>IAM</code>
494
+ * and the corresponding IAM user is deleted.</p>
495
+ * @public
496
+ */
497
+ UserName?: string | undefined;
498
+ /**
499
+ * <p>The user's email address.</p>
500
+ * @public
501
+ */
502
+ Email?: string | undefined;
503
+ /**
504
+ * <p>The Quick Sight role for the user. The user role can be one of the
505
+ * following:.</p>
506
+ * <ul>
507
+ * <li>
508
+ * <p>
509
+ * <code>READER</code>: A user who has read-only access to dashboards.</p>
510
+ * </li>
511
+ * <li>
512
+ * <p>
513
+ * <code>AUTHOR</code>: A user who can create data sources, datasets, analyses,
514
+ * and dashboards.</p>
515
+ * </li>
516
+ * <li>
517
+ * <p>
518
+ * <code>ADMIN</code>: A user who is an author, who can also manage Amazon
519
+ * Quick Sight settings.</p>
520
+ * </li>
521
+ * <li>
522
+ * <p>
523
+ * <code>READER_PRO</code>: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Quick Sight, can build stories with Amazon Q, and can generate executive summaries from dashboards.</p>
524
+ * </li>
525
+ * <li>
526
+ * <p>
527
+ * <code>AUTHOR_PRO</code>: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.</p>
528
+ * </li>
529
+ * <li>
530
+ * <p>
531
+ * <code>ADMIN_PRO</code>: Admin Pros are Author Pros who can also manage Quick Sight administrative settings. Admin Pro users are billed at Author Pro pricing.</p>
532
+ * </li>
533
+ * <li>
534
+ * <p>
535
+ * <code>RESTRICTED_READER</code>: This role isn't currently available for
536
+ * use.</p>
537
+ * </li>
538
+ * <li>
539
+ * <p>
540
+ * <code>RESTRICTED_AUTHOR</code>: This role isn't currently available for
541
+ * use.</p>
542
+ * </li>
543
+ * </ul>
544
+ * @public
545
+ */
546
+ Role?: UserRole | undefined;
547
+ /**
548
+ * <p>The type of identity authentication used by the user.</p>
549
+ * @public
550
+ */
551
+ IdentityType?: IdentityType | undefined;
552
+ /**
553
+ * <p>The active status of user. When you create an Quick Sight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a
554
+ * password.</p>
555
+ * @public
556
+ */
557
+ Active?: boolean | undefined;
558
+ /**
559
+ * <p>The principal ID of the user.</p>
560
+ * @public
561
+ */
562
+ PrincipalId?: string | undefined;
563
+ /**
564
+ * <p>The custom permissions profile associated with this user.</p>
565
+ * @public
566
+ */
567
+ CustomPermissionsName?: string | undefined;
568
+ /**
569
+ * <p>The type of supported external login provider that provides identity to let the user
570
+ * federate into Quick Sight with an associated IAM role. The type can be one of the following.</p>
571
+ * <ul>
572
+ * <li>
573
+ * <p>
574
+ * <code>COGNITO</code>: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.</p>
575
+ * </li>
576
+ * <li>
577
+ * <p>
578
+ * <code>CUSTOM_OIDC</code>: Custom OpenID Connect (OIDC) provider.</p>
579
+ * </li>
580
+ * </ul>
581
+ * @public
582
+ */
583
+ ExternalLoginFederationProviderType?: string | undefined;
584
+ /**
585
+ * <p>The URL of the external login provider.</p>
586
+ * @public
587
+ */
588
+ ExternalLoginFederationProviderUrl?: string | undefined;
589
+ /**
590
+ * <p>The identity ID for the user in the external login provider.</p>
591
+ * @public
592
+ */
593
+ ExternalLoginId?: string | undefined;
594
+ }
595
+ /**
596
+ * @public
597
+ */
598
+ export interface DescribeUserResponse {
599
+ /**
600
+ * <p>The user name.</p>
601
+ * @public
602
+ */
603
+ User?: User | undefined;
604
+ /**
605
+ * <p>The Amazon Web Services request ID for this operation.</p>
606
+ * @public
607
+ */
608
+ RequestId?: string | undefined;
609
+ /**
610
+ * <p>The HTTP status of the request.</p>
611
+ * @public
612
+ */
613
+ Status?: number | undefined;
614
+ }
6
615
  /**
7
616
  * @public
8
617
  */
@@ -1258,6 +1867,112 @@ export interface GetFlowPermissionsOutput {
1258
1867
  */
1259
1868
  Status?: number | undefined;
1260
1869
  }
1870
+ /**
1871
+ * <p>A structure that contains information to identify a user.</p>
1872
+ * @public
1873
+ */
1874
+ export type UserIdentifier = UserIdentifier.EmailMember | UserIdentifier.UserArnMember | UserIdentifier.UserNameMember | UserIdentifier.$UnknownMember;
1875
+ /**
1876
+ * @public
1877
+ */
1878
+ export declare namespace UserIdentifier {
1879
+ /**
1880
+ * <p>The name of the user that you want to get identity context for.</p>
1881
+ * @public
1882
+ */
1883
+ interface UserNameMember {
1884
+ UserName: string;
1885
+ Email?: never;
1886
+ UserArn?: never;
1887
+ $unknown?: never;
1888
+ }
1889
+ /**
1890
+ * <p>The email address of the user that you want to get identity context for.</p>
1891
+ * @public
1892
+ */
1893
+ interface EmailMember {
1894
+ UserName?: never;
1895
+ Email: string;
1896
+ UserArn?: never;
1897
+ $unknown?: never;
1898
+ }
1899
+ /**
1900
+ * <p>The Amazon Resource Name (ARN) of the user that you want to get identity context for.</p>
1901
+ * @public
1902
+ */
1903
+ interface UserArnMember {
1904
+ UserName?: never;
1905
+ Email?: never;
1906
+ UserArn: string;
1907
+ $unknown?: never;
1908
+ }
1909
+ /**
1910
+ * @public
1911
+ */
1912
+ interface $UnknownMember {
1913
+ UserName?: never;
1914
+ Email?: never;
1915
+ UserArn?: never;
1916
+ $unknown: [string, any];
1917
+ }
1918
+ /**
1919
+ * @deprecated unused in schema-serde mode.
1920
+ *
1921
+ */
1922
+ interface Visitor<T> {
1923
+ UserName: (value: string) => T;
1924
+ Email: (value: string) => T;
1925
+ UserArn: (value: string) => T;
1926
+ _: (name: string, value: any) => T;
1927
+ }
1928
+ }
1929
+ /**
1930
+ * <p>/////////////////////////
1931
+ * /////////////////////////</p>
1932
+ * @public
1933
+ */
1934
+ export interface GetIdentityContextRequest {
1935
+ /**
1936
+ * <p>The ID for the Amazon Web Services account that the user whose identity context you want to retrieve is in. Currently, you use the ID for the Amazon Web Services account that contains your Quick Sight account.</p>
1937
+ * @public
1938
+ */
1939
+ AwsAccountId: string | undefined;
1940
+ /**
1941
+ * <p>The identifier for the user whose identity context you want to retrieve.</p>
1942
+ * @public
1943
+ */
1944
+ UserIdentifier: UserIdentifier | undefined;
1945
+ /**
1946
+ * <p>The namespace of the user that you want to get identity context for. This parameter is required when the UserIdentifier is specified using Email or UserName.</p>
1947
+ * @public
1948
+ */
1949
+ Namespace?: string | undefined;
1950
+ /**
1951
+ * <p>The timestamp at which the session will expire.</p>
1952
+ * @public
1953
+ */
1954
+ SessionExpiresAt?: Date | undefined;
1955
+ }
1956
+ /**
1957
+ * @public
1958
+ */
1959
+ export interface GetIdentityContextResponse {
1960
+ /**
1961
+ * <p>The HTTP status of the request.</p>
1962
+ * @public
1963
+ */
1964
+ Status: number | undefined;
1965
+ /**
1966
+ * <p>The Amazon Web Services request ID for this operation.</p>
1967
+ * @public
1968
+ */
1969
+ RequestId: string | undefined;
1970
+ /**
1971
+ * <p>The identity context information for the user. This is an identity token that should be used as the ContextAssertion parameter in the <a href="https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html">STS AssumeRole API</a> call to obtain identity enhanced AWS credentials.</p>
1972
+ * @public
1973
+ */
1974
+ Context?: string | undefined;
1975
+ }
1261
1976
  /**
1262
1977
  * @public
1263
1978
  */
@@ -4468,6 +5183,9 @@ export interface SnapshotAnonymousUser {
4468
5183
  }
4469
5184
  /**
4470
5185
  * <p>A structure that contains information about the users that the dashboard snapshot is generated for.</p>
5186
+ * <important>
5187
+ * <p>When using identity-enhanced session credentials, set the UserConfiguration request attribute to null. Otherwise, the request will be invalid.</p>
5188
+ * </important>
4471
5189
  * @public
4472
5190
  */
4473
5191
  export interface SnapshotUserConfiguration {
@@ -4498,11 +5216,13 @@ export interface StartDashboardSnapshotJobRequest {
4498
5216
  */
4499
5217
  SnapshotJobId: string | undefined;
4500
5218
  /**
4501
- * <p>
4502
- * A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered Amazon Quick Sight.</p>
5219
+ * <p>A structure that contains information about the users that the dashboard snapshot is generated for. The users can be either anonymous users or registered users. Anonymous users cannot be used together with registered users.</p>
5220
+ * <important>
5221
+ * <p>When using identity-enhanced session credentials, set the UserConfiguration request attribute to null. Otherwise, the request will be invalid.</p>
5222
+ * </important>
4503
5223
  * @public
4504
5224
  */
4505
- UserConfiguration: SnapshotUserConfiguration | undefined;
5225
+ UserConfiguration?: SnapshotUserConfiguration | undefined;
4506
5226
  /**
4507
5227
  * <p>A structure that describes the configuration of the dashboard snapshot.</p>
4508
5228
  * @public