@aws-sdk/client-quicksight 3.370.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 +1 -1
@@ -1,6 +1,762 @@
1
1
  import { ResourceStatus } from "./models_0";
2
- import { ResourcePermission, TemplateAlias, ThemeAlias, ThemeConfiguration, TopicDetails, TopicRefreshSchedule, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./models_2";
3
- import { User, UserRole } from "./models_3";
2
+ import { AssignmentStatus, ColumnGroup, ColumnLevelPermissionRule, DataSetImportMode, DatasetParameter, DataSetUsageConfiguration, DataSourceCredentials, DataSourceParameters, FieldFolder, Group, LogicalTable, PhysicalTable, RefreshSchedule, ResourcePermission, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, SslProperties, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, TopicDetails, TopicRefreshSchedule, VPCConnectionAvailabilityStatus, VpcConnectionProperties, VPCConnectionResourceStatus } from "./models_2";
3
+ import { LinkSharingConfiguration, User, UserRole } from "./models_3";
4
+ /**
5
+ * @public
6
+ */
7
+ export interface UpdateDashboardPermissionsRequest {
8
+ /**
9
+ * <p>The ID of the Amazon Web Services account that contains the dashboard whose permissions you're
10
+ * updating.</p>
11
+ */
12
+ AwsAccountId: string | undefined;
13
+ /**
14
+ * <p>The ID for the dashboard.</p>
15
+ */
16
+ DashboardId: string | undefined;
17
+ /**
18
+ * <p>The permissions that you want to grant on this resource.</p>
19
+ */
20
+ GrantPermissions?: ResourcePermission[];
21
+ /**
22
+ * <p>The permissions that you want to revoke from this resource.</p>
23
+ */
24
+ RevokePermissions?: ResourcePermission[];
25
+ /**
26
+ * <p>Grants link permissions to all users in a defined namespace.</p>
27
+ */
28
+ GrantLinkPermissions?: ResourcePermission[];
29
+ /**
30
+ * <p>Revokes link permissions from all users in a defined namespace.</p>
31
+ */
32
+ RevokeLinkPermissions?: ResourcePermission[];
33
+ }
34
+ /**
35
+ * @public
36
+ */
37
+ export interface UpdateDashboardPermissionsResponse {
38
+ /**
39
+ * <p>The Amazon Resource Name (ARN) of the dashboard.</p>
40
+ */
41
+ DashboardArn?: string;
42
+ /**
43
+ * <p>The ID for the dashboard.</p>
44
+ */
45
+ DashboardId?: string;
46
+ /**
47
+ * <p>Information about the permissions on the dashboard.</p>
48
+ */
49
+ Permissions?: ResourcePermission[];
50
+ /**
51
+ * <p>The Amazon Web Services request ID for this operation.</p>
52
+ */
53
+ RequestId?: string;
54
+ /**
55
+ * <p>The HTTP status of the request.</p>
56
+ */
57
+ Status?: number;
58
+ /**
59
+ * <p>Updates the permissions of a shared link to an Amazon QuickSight dashboard.</p>
60
+ */
61
+ LinkSharingConfiguration?: LinkSharingConfiguration;
62
+ }
63
+ /**
64
+ * @public
65
+ */
66
+ export interface UpdateDashboardPublishedVersionRequest {
67
+ /**
68
+ * <p>The ID of the Amazon Web Services account that contains the dashboard that you're
69
+ * updating.</p>
70
+ */
71
+ AwsAccountId: string | undefined;
72
+ /**
73
+ * <p>The ID for the dashboard.</p>
74
+ */
75
+ DashboardId: string | undefined;
76
+ /**
77
+ * <p>The version number of the dashboard.</p>
78
+ */
79
+ VersionNumber: number | undefined;
80
+ }
81
+ /**
82
+ * @public
83
+ */
84
+ export interface UpdateDashboardPublishedVersionResponse {
85
+ /**
86
+ * <p>The ID for the dashboard.</p>
87
+ */
88
+ DashboardId?: string;
89
+ /**
90
+ * <p>The Amazon Resource Name (ARN) of the dashboard.</p>
91
+ */
92
+ DashboardArn?: string;
93
+ /**
94
+ * <p>The HTTP status of the request.</p>
95
+ */
96
+ Status?: number;
97
+ /**
98
+ * <p>The Amazon Web Services request ID for this operation.</p>
99
+ */
100
+ RequestId?: string;
101
+ }
102
+ /**
103
+ * @public
104
+ */
105
+ export interface UpdateDataSetRequest {
106
+ /**
107
+ * <p>The Amazon Web Services account ID.</p>
108
+ */
109
+ AwsAccountId: string | undefined;
110
+ /**
111
+ * <p>The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each
112
+ * Amazon Web Services account.</p>
113
+ */
114
+ DataSetId: string | undefined;
115
+ /**
116
+ * <p>The display name for the dataset.</p>
117
+ */
118
+ Name: string | undefined;
119
+ /**
120
+ * <p>Declares the physical tables that are available in the underlying data sources.</p>
121
+ */
122
+ PhysicalTableMap: Record<string, PhysicalTable> | undefined;
123
+ /**
124
+ * <p>Configures the combination and transformation of the data from the physical tables.</p>
125
+ */
126
+ LogicalTableMap?: Record<string, LogicalTable>;
127
+ /**
128
+ * <p>Indicates whether you want to import the data into SPICE.</p>
129
+ */
130
+ ImportMode: DataSetImportMode | string | undefined;
131
+ /**
132
+ * <p>Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.</p>
133
+ */
134
+ ColumnGroups?: ColumnGroup[];
135
+ /**
136
+ * <p>The folder that contains fields and nested subfolders for your dataset.</p>
137
+ */
138
+ FieldFolders?: Record<string, FieldFolder>;
139
+ /**
140
+ * <p>The row-level security configuration for the data you want to create.</p>
141
+ */
142
+ RowLevelPermissionDataSet?: RowLevelPermissionDataSet;
143
+ /**
144
+ * <p>The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.</p>
145
+ */
146
+ RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration;
147
+ /**
148
+ * <p>A set of one or more definitions of a <code>
149
+ * <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html">ColumnLevelPermissionRule</a>
150
+ * </code>.</p>
151
+ */
152
+ ColumnLevelPermissionRules?: ColumnLevelPermissionRule[];
153
+ /**
154
+ * <p>The usage configuration to apply to child datasets that reference this dataset as a source.</p>
155
+ */
156
+ DataSetUsageConfiguration?: DataSetUsageConfiguration;
157
+ /**
158
+ * <p>The parameter declarations of the dataset.</p>
159
+ */
160
+ DatasetParameters?: DatasetParameter[];
161
+ }
162
+ /**
163
+ * @public
164
+ */
165
+ export interface UpdateDataSetResponse {
166
+ /**
167
+ * <p>The Amazon Resource Name (ARN) of the dataset.</p>
168
+ */
169
+ Arn?: string;
170
+ /**
171
+ * <p>The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
172
+ */
173
+ DataSetId?: string;
174
+ /**
175
+ * <p>The ARN for the ingestion, which is triggered as a result of dataset creation if the import
176
+ * mode is SPICE.</p>
177
+ */
178
+ IngestionArn?: string;
179
+ /**
180
+ * <p>The ID of the ingestion, which is triggered as a result of dataset creation if the import
181
+ * mode is SPICE.</p>
182
+ */
183
+ IngestionId?: string;
184
+ /**
185
+ * <p>The Amazon Web Services request ID for this operation.</p>
186
+ */
187
+ RequestId?: string;
188
+ /**
189
+ * <p>The HTTP status of the request.</p>
190
+ */
191
+ Status?: number;
192
+ }
193
+ /**
194
+ * @public
195
+ */
196
+ export interface UpdateDataSetPermissionsRequest {
197
+ /**
198
+ * <p>The Amazon Web Services account ID.</p>
199
+ */
200
+ AwsAccountId: string | undefined;
201
+ /**
202
+ * <p>The ID for the dataset whose permissions you want to update. This ID is unique per
203
+ * Amazon Web Services Region for each Amazon Web Services account.</p>
204
+ */
205
+ DataSetId: string | undefined;
206
+ /**
207
+ * <p>The resource permissions that you want to grant to the dataset.</p>
208
+ */
209
+ GrantPermissions?: ResourcePermission[];
210
+ /**
211
+ * <p>The resource permissions that you want to revoke from the dataset.</p>
212
+ */
213
+ RevokePermissions?: ResourcePermission[];
214
+ }
215
+ /**
216
+ * @public
217
+ */
218
+ export interface UpdateDataSetPermissionsResponse {
219
+ /**
220
+ * <p>The Amazon Resource Name (ARN) of the dataset.</p>
221
+ */
222
+ DataSetArn?: string;
223
+ /**
224
+ * <p>The ID for the dataset whose permissions you want to update. This ID is unique per
225
+ * Amazon Web Services Region for each Amazon Web Services account.</p>
226
+ */
227
+ DataSetId?: string;
228
+ /**
229
+ * <p>The Amazon Web Services request ID for this operation.</p>
230
+ */
231
+ RequestId?: string;
232
+ /**
233
+ * <p>The HTTP status of the request.</p>
234
+ */
235
+ Status?: number;
236
+ }
237
+ /**
238
+ * @public
239
+ */
240
+ export interface UpdateDataSourceRequest {
241
+ /**
242
+ * <p>The Amazon Web Services account ID.</p>
243
+ */
244
+ AwsAccountId: string | undefined;
245
+ /**
246
+ * <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. </p>
247
+ */
248
+ DataSourceId: string | undefined;
249
+ /**
250
+ * <p>A display name for the data source.</p>
251
+ */
252
+ Name: string | undefined;
253
+ /**
254
+ * <p>The parameters that Amazon QuickSight uses to connect to your underlying source.</p>
255
+ */
256
+ DataSourceParameters?: DataSourceParameters;
257
+ /**
258
+ * <p>The credentials that Amazon QuickSight that uses to connect to your underlying source. Currently,
259
+ * only credentials based on user name and password are supported.</p>
260
+ */
261
+ Credentials?: DataSourceCredentials;
262
+ /**
263
+ * <p>Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to
264
+ * your underlying source.</p>
265
+ */
266
+ VpcConnectionProperties?: VpcConnectionProperties;
267
+ /**
268
+ * <p>Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying
269
+ * source.</p>
270
+ */
271
+ SslProperties?: SslProperties;
272
+ }
273
+ /**
274
+ * @public
275
+ */
276
+ export interface UpdateDataSourceResponse {
277
+ /**
278
+ * <p>The Amazon Resource Name (ARN) of the data source.</p>
279
+ */
280
+ Arn?: string;
281
+ /**
282
+ * <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
283
+ */
284
+ DataSourceId?: string;
285
+ /**
286
+ * <p>The update status of the data source's last update.</p>
287
+ */
288
+ UpdateStatus?: ResourceStatus | string;
289
+ /**
290
+ * <p>The Amazon Web Services request ID for this operation.</p>
291
+ */
292
+ RequestId?: string;
293
+ /**
294
+ * <p>The HTTP status of the request.</p>
295
+ */
296
+ Status?: number;
297
+ }
298
+ /**
299
+ * @public
300
+ */
301
+ export interface UpdateDataSourcePermissionsRequest {
302
+ /**
303
+ * <p>The Amazon Web Services account ID.</p>
304
+ */
305
+ AwsAccountId: string | undefined;
306
+ /**
307
+ * <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. </p>
308
+ */
309
+ DataSourceId: string | undefined;
310
+ /**
311
+ * <p>A list of resource permissions that you want to grant on the data source.</p>
312
+ */
313
+ GrantPermissions?: ResourcePermission[];
314
+ /**
315
+ * <p>A list of resource permissions that you want to revoke on the data source.</p>
316
+ */
317
+ RevokePermissions?: ResourcePermission[];
318
+ }
319
+ /**
320
+ * @public
321
+ */
322
+ export interface UpdateDataSourcePermissionsResponse {
323
+ /**
324
+ * <p>The Amazon Resource Name (ARN) of the data source.</p>
325
+ */
326
+ DataSourceArn?: string;
327
+ /**
328
+ * <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
329
+ */
330
+ DataSourceId?: string;
331
+ /**
332
+ * <p>The Amazon Web Services request ID for this operation.</p>
333
+ */
334
+ RequestId?: string;
335
+ /**
336
+ * <p>The HTTP status of the request.</p>
337
+ */
338
+ Status?: number;
339
+ }
340
+ /**
341
+ * @public
342
+ */
343
+ export interface UpdateFolderRequest {
344
+ /**
345
+ * <p>The ID for the Amazon Web Services account that contains the folder to update.</p>
346
+ */
347
+ AwsAccountId: string | undefined;
348
+ /**
349
+ * <p>The ID of the folder.</p>
350
+ */
351
+ FolderId: string | undefined;
352
+ /**
353
+ * <p>The name of the folder.</p>
354
+ */
355
+ Name: string | undefined;
356
+ }
357
+ /**
358
+ * @public
359
+ */
360
+ export interface UpdateFolderResponse {
361
+ /**
362
+ * <p>The HTTP status of the request.</p>
363
+ */
364
+ Status?: number;
365
+ /**
366
+ * <p>The Amazon Resource Name (ARN) of the folder.</p>
367
+ */
368
+ Arn?: string;
369
+ /**
370
+ * <p>The ID of the folder.</p>
371
+ */
372
+ FolderId?: string;
373
+ /**
374
+ * <p>The Amazon Web Services request ID for this operation.</p>
375
+ */
376
+ RequestId?: string;
377
+ }
378
+ /**
379
+ * @public
380
+ */
381
+ export interface UpdateFolderPermissionsRequest {
382
+ /**
383
+ * <p>The ID for the Amazon Web Services account that contains the folder to update.</p>
384
+ */
385
+ AwsAccountId: string | undefined;
386
+ /**
387
+ * <p>The ID of the folder.</p>
388
+ */
389
+ FolderId: string | undefined;
390
+ /**
391
+ * <p>The permissions that you want to grant on a resource.</p>
392
+ */
393
+ GrantPermissions?: ResourcePermission[];
394
+ /**
395
+ * <p>The permissions that you want to revoke from a resource.</p>
396
+ */
397
+ RevokePermissions?: ResourcePermission[];
398
+ }
399
+ /**
400
+ * @public
401
+ */
402
+ export interface UpdateFolderPermissionsResponse {
403
+ /**
404
+ * <p>The HTTP status of the request.</p>
405
+ */
406
+ Status?: number;
407
+ /**
408
+ * <p>The Amazon Resource Name (ARN) of the folder.</p>
409
+ */
410
+ Arn?: string;
411
+ /**
412
+ * <p>The ID of the folder.</p>
413
+ */
414
+ FolderId?: string;
415
+ /**
416
+ * <p>Information about the permissions for the folder.</p>
417
+ */
418
+ Permissions?: ResourcePermission[];
419
+ /**
420
+ * <p>The Amazon Web Services request ID for this operation.</p>
421
+ */
422
+ RequestId?: string;
423
+ }
424
+ /**
425
+ * @public
426
+ */
427
+ export interface UpdateGroupRequest {
428
+ /**
429
+ * <p>The name of the group that you want to update.</p>
430
+ */
431
+ GroupName: string | undefined;
432
+ /**
433
+ * <p>The description for the group that you want to update.</p>
434
+ */
435
+ Description?: string;
436
+ /**
437
+ * <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the
438
+ * Amazon Web Services account that contains your Amazon QuickSight account.</p>
439
+ */
440
+ AwsAccountId: string | undefined;
441
+ /**
442
+ * <p>The namespace of the group that you want to update.</p>
443
+ */
444
+ Namespace: string | undefined;
445
+ }
446
+ /**
447
+ * @public
448
+ */
449
+ export interface UpdateGroupResponse {
450
+ /**
451
+ * <p>The name of the group.</p>
452
+ */
453
+ Group?: Group;
454
+ /**
455
+ * <p>The Amazon Web Services request ID for this operation.</p>
456
+ */
457
+ RequestId?: string;
458
+ /**
459
+ * <p>The HTTP status of the request.</p>
460
+ */
461
+ Status?: number;
462
+ }
463
+ /**
464
+ * @public
465
+ */
466
+ export interface UpdateIAMPolicyAssignmentRequest {
467
+ /**
468
+ * <p>The ID of the Amazon Web Services account that contains the IAM policy
469
+ * assignment. </p>
470
+ */
471
+ AwsAccountId: string | undefined;
472
+ /**
473
+ * <p>The name of the assignment, also called a rule.
474
+ * The
475
+ * name must be unique within the
476
+ * Amazon Web Services account.</p>
477
+ */
478
+ AssignmentName: string | undefined;
479
+ /**
480
+ * <p>The namespace of the assignment.</p>
481
+ */
482
+ Namespace: string | undefined;
483
+ /**
484
+ * <p>The status of the assignment. Possible values are as follows:</p>
485
+ * <ul>
486
+ * <li>
487
+ * <p>
488
+ * <code>ENABLED</code> - Anything specified in this assignment is used when
489
+ * creating the data source.</p>
490
+ * </li>
491
+ * <li>
492
+ * <p>
493
+ * <code>DISABLED</code> - This assignment isn't used when creating the data
494
+ * source.</p>
495
+ * </li>
496
+ * <li>
497
+ * <p>
498
+ * <code>DRAFT</code> - This assignment is an unfinished draft and isn't used
499
+ * when creating the data source.</p>
500
+ * </li>
501
+ * </ul>
502
+ */
503
+ AssignmentStatus?: AssignmentStatus | string;
504
+ /**
505
+ * <p>The ARN for the IAM policy to apply to the Amazon QuickSight users and
506
+ * groups specified in this assignment.</p>
507
+ */
508
+ PolicyArn?: string;
509
+ /**
510
+ * <p>The Amazon QuickSight users, groups, or both that you want to assign the policy
511
+ * to.</p>
512
+ */
513
+ Identities?: Record<string, string[]>;
514
+ }
515
+ /**
516
+ * @public
517
+ */
518
+ export interface UpdateIAMPolicyAssignmentResponse {
519
+ /**
520
+ * <p>The name of the assignment or rule.</p>
521
+ */
522
+ AssignmentName?: string;
523
+ /**
524
+ * <p>The ID of the assignment.</p>
525
+ */
526
+ AssignmentId?: string;
527
+ /**
528
+ * <p>The ARN for the IAM policy applied to the Amazon QuickSight users and
529
+ * groups specified in this assignment.</p>
530
+ */
531
+ PolicyArn?: string;
532
+ /**
533
+ * <p>The Amazon QuickSight users, groups, or both that the IAM policy is
534
+ * assigned to.</p>
535
+ */
536
+ Identities?: Record<string, string[]>;
537
+ /**
538
+ * <p>The status of the assignment. Possible values are as follows:</p>
539
+ * <ul>
540
+ * <li>
541
+ * <p>
542
+ * <code>ENABLED</code> - Anything specified in this assignment is used when
543
+ * creating the data source.</p>
544
+ * </li>
545
+ * <li>
546
+ * <p>
547
+ * <code>DISABLED</code> - This assignment isn't used when creating the data
548
+ * source.</p>
549
+ * </li>
550
+ * <li>
551
+ * <p>
552
+ * <code>DRAFT</code> - This assignment is an unfinished draft and isn't used
553
+ * when creating the data source.</p>
554
+ * </li>
555
+ * </ul>
556
+ */
557
+ AssignmentStatus?: AssignmentStatus | string;
558
+ /**
559
+ * <p>The Amazon Web Services request ID for this operation.</p>
560
+ */
561
+ RequestId?: string;
562
+ /**
563
+ * <p>The HTTP status of the request.</p>
564
+ */
565
+ Status?: number;
566
+ }
567
+ /**
568
+ * @public
569
+ */
570
+ export interface UpdateIpRestrictionRequest {
571
+ /**
572
+ * <p>The ID of the Amazon Web Services account that contains the IP rules.</p>
573
+ */
574
+ AwsAccountId: string | undefined;
575
+ /**
576
+ * <p>A map that describes the updated IP rules with CIDR ranges and descriptions.</p>
577
+ */
578
+ IpRestrictionRuleMap?: Record<string, string>;
579
+ /**
580
+ * <p>A value that specifies whether IP rules are turned on.</p>
581
+ */
582
+ Enabled?: boolean;
583
+ }
584
+ /**
585
+ * @public
586
+ */
587
+ export interface UpdateIpRestrictionResponse {
588
+ /**
589
+ * <p>The ID of the Amazon Web Services account that contains the IP rules.</p>
590
+ */
591
+ AwsAccountId?: string;
592
+ /**
593
+ * <p>The Amazon Web Services request ID for this operation.</p>
594
+ */
595
+ RequestId?: string;
596
+ /**
597
+ * <p>The HTTP status of the request. </p>
598
+ */
599
+ Status?: number;
600
+ }
601
+ /**
602
+ * @public
603
+ */
604
+ export interface UpdatePublicSharingSettingsRequest {
605
+ /**
606
+ * <p>The Amazon Web Services account ID associated with your Amazon QuickSight subscription.</p>
607
+ */
608
+ AwsAccountId: string | undefined;
609
+ /**
610
+ * <p>A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account.</p>
611
+ */
612
+ PublicSharingEnabled?: boolean;
613
+ }
614
+ /**
615
+ * @public
616
+ */
617
+ export interface UpdatePublicSharingSettingsResponse {
618
+ /**
619
+ * <p>The Amazon Web Services request ID for this operation.</p>
620
+ */
621
+ RequestId?: string;
622
+ /**
623
+ * <p>The HTTP status of the request.</p>
624
+ */
625
+ Status?: number;
626
+ }
627
+ /**
628
+ * @public
629
+ */
630
+ export interface UpdateRefreshScheduleRequest {
631
+ /**
632
+ * <p>The ID of the dataset.</p>
633
+ */
634
+ DataSetId: string | undefined;
635
+ /**
636
+ * <p>The Amazon Web Services account ID.</p>
637
+ */
638
+ AwsAccountId: string | undefined;
639
+ /**
640
+ * <p>The refresh schedule.</p>
641
+ */
642
+ Schedule: RefreshSchedule | undefined;
643
+ }
644
+ /**
645
+ * @public
646
+ */
647
+ export interface UpdateRefreshScheduleResponse {
648
+ /**
649
+ * <p>The HTTP status of the request.</p>
650
+ */
651
+ Status?: number;
652
+ /**
653
+ * <p>The Amazon Web Services request ID for this operation.</p>
654
+ */
655
+ RequestId?: string;
656
+ /**
657
+ * <p>The ID of the refresh schedule.</p>
658
+ */
659
+ ScheduleId?: string;
660
+ /**
661
+ * <p>The Amazon Resource Name (ARN) for the refresh schedule.</p>
662
+ */
663
+ Arn?: string;
664
+ }
665
+ /**
666
+ * @public
667
+ */
668
+ export interface UpdateTemplateRequest {
669
+ /**
670
+ * <p>The ID of the Amazon Web Services account that contains the template that you're updating.</p>
671
+ */
672
+ AwsAccountId: string | undefined;
673
+ /**
674
+ * <p>The ID for the template.</p>
675
+ */
676
+ TemplateId: string | undefined;
677
+ /**
678
+ * <p>The entity that you are using as a source when you update the template. In
679
+ * <code>SourceEntity</code>, you specify the type of object you're using as source:
680
+ * <code>SourceTemplate</code> for a template or <code>SourceAnalysis</code> for an
681
+ * analysis. Both of these require an Amazon Resource Name (ARN). For
682
+ * <code>SourceTemplate</code>, specify the ARN of the source template. For
683
+ * <code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code>
684
+ * ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;. </p>
685
+ * <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or
686
+ * <code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed
687
+ * in the original. The schema in each dataset must match its placeholder. </p>
688
+ */
689
+ SourceEntity?: TemplateSourceEntity;
690
+ /**
691
+ * <p>A description of the current template version that is being updated. Every time you call
692
+ * <code>UpdateTemplate</code>, you create a new version of the template. Each version
693
+ * of the template maintains a description of the version in the
694
+ * <code>VersionDescription</code> field.</p>
695
+ */
696
+ VersionDescription?: string;
697
+ /**
698
+ * <p>The name for the template.</p>
699
+ */
700
+ Name?: string;
701
+ /**
702
+ * <p>The definition of a template.</p>
703
+ * <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
704
+ */
705
+ Definition?: TemplateVersionDefinition;
706
+ }
707
+ /**
708
+ * @public
709
+ */
710
+ export interface UpdateTemplateResponse {
711
+ /**
712
+ * <p>The ID for the template.</p>
713
+ */
714
+ TemplateId?: string;
715
+ /**
716
+ * <p>The Amazon Resource Name (ARN) for the template.</p>
717
+ */
718
+ Arn?: string;
719
+ /**
720
+ * <p>The ARN for the template, including the version information of the first version.</p>
721
+ */
722
+ VersionArn?: string;
723
+ /**
724
+ * <p>The creation status of the template.</p>
725
+ */
726
+ CreationStatus?: ResourceStatus | string;
727
+ /**
728
+ * <p>The HTTP status of the request.</p>
729
+ */
730
+ Status?: number;
731
+ /**
732
+ * <p>The Amazon Web Services request ID for this operation.</p>
733
+ */
734
+ RequestId?: string;
735
+ }
736
+ /**
737
+ * @public
738
+ */
739
+ export interface UpdateTemplateAliasRequest {
740
+ /**
741
+ * <p>The ID of the Amazon Web Services account that contains the template alias that you're updating.</p>
742
+ */
743
+ AwsAccountId: string | undefined;
744
+ /**
745
+ * <p>The ID for the template.</p>
746
+ */
747
+ TemplateId: string | undefined;
748
+ /**
749
+ * <p>The alias of the template that you want to update. If you name a specific alias, you update
750
+ * the version that the alias points to. You can specify the latest version of the template
751
+ * by providing the keyword <code>$LATEST</code> in the <code>AliasName</code> parameter.
752
+ * The keyword <code>$PUBLISHED</code> doesn't apply to templates.</p>
753
+ */
754
+ AliasName: string | undefined;
755
+ /**
756
+ * <p>The version number of the template.</p>
757
+ */
758
+ TemplateVersionNumber: number | undefined;
759
+ }
4
760
  /**
5
761
  * @public
6
762
  */
@@ -540,6 +1296,18 @@ export interface UpdateVPCConnectionResponse {
540
1296
  */
541
1297
  Status?: number;
542
1298
  }
1299
+ /**
1300
+ * @internal
1301
+ */
1302
+ export declare const UpdateDataSetRequestFilterSensitiveLog: (obj: UpdateDataSetRequest) => any;
1303
+ /**
1304
+ * @internal
1305
+ */
1306
+ export declare const UpdateDataSourceRequestFilterSensitiveLog: (obj: UpdateDataSourceRequest) => any;
1307
+ /**
1308
+ * @internal
1309
+ */
1310
+ export declare const UpdateTemplateRequestFilterSensitiveLog: (obj: UpdateTemplateRequest) => any;
543
1311
  /**
544
1312
  * @internal
545
1313
  */