@aws-sdk/client-quicksight 3.379.1 → 3.382.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.
@@ -6,27 +6,33 @@ import { LinkSharingConfiguration, User, UserRole } from "./models_3";
6
6
  */
7
7
  export interface UpdateDashboardPermissionsRequest {
8
8
  /**
9
+ * @public
9
10
  * <p>The ID of the Amazon Web Services account that contains the dashboard whose permissions you're
10
11
  * updating.</p>
11
12
  */
12
13
  AwsAccountId: string | undefined;
13
14
  /**
15
+ * @public
14
16
  * <p>The ID for the dashboard.</p>
15
17
  */
16
18
  DashboardId: string | undefined;
17
19
  /**
20
+ * @public
18
21
  * <p>The permissions that you want to grant on this resource.</p>
19
22
  */
20
23
  GrantPermissions?: ResourcePermission[];
21
24
  /**
25
+ * @public
22
26
  * <p>The permissions that you want to revoke from this resource.</p>
23
27
  */
24
28
  RevokePermissions?: ResourcePermission[];
25
29
  /**
30
+ * @public
26
31
  * <p>Grants link permissions to all users in a defined namespace.</p>
27
32
  */
28
33
  GrantLinkPermissions?: ResourcePermission[];
29
34
  /**
35
+ * @public
30
36
  * <p>Revokes link permissions from all users in a defined namespace.</p>
31
37
  */
32
38
  RevokeLinkPermissions?: ResourcePermission[];
@@ -36,26 +42,32 @@ export interface UpdateDashboardPermissionsRequest {
36
42
  */
37
43
  export interface UpdateDashboardPermissionsResponse {
38
44
  /**
45
+ * @public
39
46
  * <p>The Amazon Resource Name (ARN) of the dashboard.</p>
40
47
  */
41
48
  DashboardArn?: string;
42
49
  /**
50
+ * @public
43
51
  * <p>The ID for the dashboard.</p>
44
52
  */
45
53
  DashboardId?: string;
46
54
  /**
55
+ * @public
47
56
  * <p>Information about the permissions on the dashboard.</p>
48
57
  */
49
58
  Permissions?: ResourcePermission[];
50
59
  /**
60
+ * @public
51
61
  * <p>The Amazon Web Services request ID for this operation.</p>
52
62
  */
53
63
  RequestId?: string;
54
64
  /**
65
+ * @public
55
66
  * <p>The HTTP status of the request.</p>
56
67
  */
57
68
  Status?: number;
58
69
  /**
70
+ * @public
59
71
  * <p>Updates the permissions of a shared link to an Amazon QuickSight dashboard.</p>
60
72
  */
61
73
  LinkSharingConfiguration?: LinkSharingConfiguration;
@@ -65,15 +77,18 @@ export interface UpdateDashboardPermissionsResponse {
65
77
  */
66
78
  export interface UpdateDashboardPublishedVersionRequest {
67
79
  /**
80
+ * @public
68
81
  * <p>The ID of the Amazon Web Services account that contains the dashboard that you're
69
82
  * updating.</p>
70
83
  */
71
84
  AwsAccountId: string | undefined;
72
85
  /**
86
+ * @public
73
87
  * <p>The ID for the dashboard.</p>
74
88
  */
75
89
  DashboardId: string | undefined;
76
90
  /**
91
+ * @public
77
92
  * <p>The version number of the dashboard.</p>
78
93
  */
79
94
  VersionNumber: number | undefined;
@@ -83,18 +98,22 @@ export interface UpdateDashboardPublishedVersionRequest {
83
98
  */
84
99
  export interface UpdateDashboardPublishedVersionResponse {
85
100
  /**
101
+ * @public
86
102
  * <p>The ID for the dashboard.</p>
87
103
  */
88
104
  DashboardId?: string;
89
105
  /**
106
+ * @public
90
107
  * <p>The Amazon Resource Name (ARN) of the dashboard.</p>
91
108
  */
92
109
  DashboardArn?: string;
93
110
  /**
111
+ * @public
94
112
  * <p>The HTTP status of the request.</p>
95
113
  */
96
114
  Status?: number;
97
115
  /**
116
+ * @public
98
117
  * <p>The Amazon Web Services request ID for this operation.</p>
99
118
  */
100
119
  RequestId?: string;
@@ -104,57 +123,70 @@ export interface UpdateDashboardPublishedVersionResponse {
104
123
  */
105
124
  export interface UpdateDataSetRequest {
106
125
  /**
126
+ * @public
107
127
  * <p>The Amazon Web Services account ID.</p>
108
128
  */
109
129
  AwsAccountId: string | undefined;
110
130
  /**
131
+ * @public
111
132
  * <p>The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each
112
133
  * Amazon Web Services account.</p>
113
134
  */
114
135
  DataSetId: string | undefined;
115
136
  /**
137
+ * @public
116
138
  * <p>The display name for the dataset.</p>
117
139
  */
118
140
  Name: string | undefined;
119
141
  /**
142
+ * @public
120
143
  * <p>Declares the physical tables that are available in the underlying data sources.</p>
121
144
  */
122
145
  PhysicalTableMap: Record<string, PhysicalTable> | undefined;
123
146
  /**
147
+ * @public
124
148
  * <p>Configures the combination and transformation of the data from the physical tables.</p>
125
149
  */
126
150
  LogicalTableMap?: Record<string, LogicalTable>;
127
151
  /**
152
+ * @public
128
153
  * <p>Indicates whether you want to import the data into SPICE.</p>
129
154
  */
130
155
  ImportMode: DataSetImportMode | string | undefined;
131
156
  /**
157
+ * @public
132
158
  * <p>Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.</p>
133
159
  */
134
160
  ColumnGroups?: ColumnGroup[];
135
161
  /**
162
+ * @public
136
163
  * <p>The folder that contains fields and nested subfolders for your dataset.</p>
137
164
  */
138
165
  FieldFolders?: Record<string, FieldFolder>;
139
166
  /**
167
+ * @public
140
168
  * <p>The row-level security configuration for the data you want to create.</p>
141
169
  */
142
170
  RowLevelPermissionDataSet?: RowLevelPermissionDataSet;
143
171
  /**
172
+ * @public
144
173
  * <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
174
  */
146
175
  RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration;
147
176
  /**
177
+ * @public
148
178
  * <p>A set of one or more definitions of a <code>
149
179
  * <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html">ColumnLevelPermissionRule</a>
150
180
  * </code>.</p>
151
181
  */
152
182
  ColumnLevelPermissionRules?: ColumnLevelPermissionRule[];
153
183
  /**
184
+ * @public
154
185
  * <p>The usage configuration to apply to child datasets that reference this dataset as a source.</p>
155
186
  */
156
187
  DataSetUsageConfiguration?: DataSetUsageConfiguration;
157
188
  /**
189
+ * @public
158
190
  * <p>The parameter declarations of the dataset.</p>
159
191
  */
160
192
  DatasetParameters?: DatasetParameter[];
@@ -164,28 +196,34 @@ export interface UpdateDataSetRequest {
164
196
  */
165
197
  export interface UpdateDataSetResponse {
166
198
  /**
199
+ * @public
167
200
  * <p>The Amazon Resource Name (ARN) of the dataset.</p>
168
201
  */
169
202
  Arn?: string;
170
203
  /**
204
+ * @public
171
205
  * <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
206
  */
173
207
  DataSetId?: string;
174
208
  /**
209
+ * @public
175
210
  * <p>The ARN for the ingestion, which is triggered as a result of dataset creation if the import
176
211
  * mode is SPICE.</p>
177
212
  */
178
213
  IngestionArn?: string;
179
214
  /**
215
+ * @public
180
216
  * <p>The ID of the ingestion, which is triggered as a result of dataset creation if the import
181
217
  * mode is SPICE.</p>
182
218
  */
183
219
  IngestionId?: string;
184
220
  /**
221
+ * @public
185
222
  * <p>The Amazon Web Services request ID for this operation.</p>
186
223
  */
187
224
  RequestId?: string;
188
225
  /**
226
+ * @public
189
227
  * <p>The HTTP status of the request.</p>
190
228
  */
191
229
  Status?: number;
@@ -195,19 +233,23 @@ export interface UpdateDataSetResponse {
195
233
  */
196
234
  export interface UpdateDataSetPermissionsRequest {
197
235
  /**
236
+ * @public
198
237
  * <p>The Amazon Web Services account ID.</p>
199
238
  */
200
239
  AwsAccountId: string | undefined;
201
240
  /**
241
+ * @public
202
242
  * <p>The ID for the dataset whose permissions you want to update. This ID is unique per
203
243
  * Amazon Web Services Region for each Amazon Web Services account.</p>
204
244
  */
205
245
  DataSetId: string | undefined;
206
246
  /**
247
+ * @public
207
248
  * <p>The resource permissions that you want to grant to the dataset.</p>
208
249
  */
209
250
  GrantPermissions?: ResourcePermission[];
210
251
  /**
252
+ * @public
211
253
  * <p>The resource permissions that you want to revoke from the dataset.</p>
212
254
  */
213
255
  RevokePermissions?: ResourcePermission[];
@@ -217,19 +259,23 @@ export interface UpdateDataSetPermissionsRequest {
217
259
  */
218
260
  export interface UpdateDataSetPermissionsResponse {
219
261
  /**
262
+ * @public
220
263
  * <p>The Amazon Resource Name (ARN) of the dataset.</p>
221
264
  */
222
265
  DataSetArn?: string;
223
266
  /**
267
+ * @public
224
268
  * <p>The ID for the dataset whose permissions you want to update. This ID is unique per
225
269
  * Amazon Web Services Region for each Amazon Web Services account.</p>
226
270
  */
227
271
  DataSetId?: string;
228
272
  /**
273
+ * @public
229
274
  * <p>The Amazon Web Services request ID for this operation.</p>
230
275
  */
231
276
  RequestId?: string;
232
277
  /**
278
+ * @public
233
279
  * <p>The HTTP status of the request.</p>
234
280
  */
235
281
  Status?: number;
@@ -239,32 +285,39 @@ export interface UpdateDataSetPermissionsResponse {
239
285
  */
240
286
  export interface UpdateDataSourceRequest {
241
287
  /**
288
+ * @public
242
289
  * <p>The Amazon Web Services account ID.</p>
243
290
  */
244
291
  AwsAccountId: string | undefined;
245
292
  /**
293
+ * @public
246
294
  * <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. </p>
247
295
  */
248
296
  DataSourceId: string | undefined;
249
297
  /**
298
+ * @public
250
299
  * <p>A display name for the data source.</p>
251
300
  */
252
301
  Name: string | undefined;
253
302
  /**
303
+ * @public
254
304
  * <p>The parameters that Amazon QuickSight uses to connect to your underlying source.</p>
255
305
  */
256
306
  DataSourceParameters?: DataSourceParameters;
257
307
  /**
308
+ * @public
258
309
  * <p>The credentials that Amazon QuickSight that uses to connect to your underlying source. Currently,
259
310
  * only credentials based on user name and password are supported.</p>
260
311
  */
261
312
  Credentials?: DataSourceCredentials;
262
313
  /**
314
+ * @public
263
315
  * <p>Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to
264
316
  * your underlying source.</p>
265
317
  */
266
318
  VpcConnectionProperties?: VpcConnectionProperties;
267
319
  /**
320
+ * @public
268
321
  * <p>Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying
269
322
  * source.</p>
270
323
  */
@@ -275,22 +328,27 @@ export interface UpdateDataSourceRequest {
275
328
  */
276
329
  export interface UpdateDataSourceResponse {
277
330
  /**
331
+ * @public
278
332
  * <p>The Amazon Resource Name (ARN) of the data source.</p>
279
333
  */
280
334
  Arn?: string;
281
335
  /**
336
+ * @public
282
337
  * <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
283
338
  */
284
339
  DataSourceId?: string;
285
340
  /**
341
+ * @public
286
342
  * <p>The update status of the data source's last update.</p>
287
343
  */
288
344
  UpdateStatus?: ResourceStatus | string;
289
345
  /**
346
+ * @public
290
347
  * <p>The Amazon Web Services request ID for this operation.</p>
291
348
  */
292
349
  RequestId?: string;
293
350
  /**
351
+ * @public
294
352
  * <p>The HTTP status of the request.</p>
295
353
  */
296
354
  Status?: number;
@@ -300,18 +358,22 @@ export interface UpdateDataSourceResponse {
300
358
  */
301
359
  export interface UpdateDataSourcePermissionsRequest {
302
360
  /**
361
+ * @public
303
362
  * <p>The Amazon Web Services account ID.</p>
304
363
  */
305
364
  AwsAccountId: string | undefined;
306
365
  /**
366
+ * @public
307
367
  * <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. </p>
308
368
  */
309
369
  DataSourceId: string | undefined;
310
370
  /**
371
+ * @public
311
372
  * <p>A list of resource permissions that you want to grant on the data source.</p>
312
373
  */
313
374
  GrantPermissions?: ResourcePermission[];
314
375
  /**
376
+ * @public
315
377
  * <p>A list of resource permissions that you want to revoke on the data source.</p>
316
378
  */
317
379
  RevokePermissions?: ResourcePermission[];
@@ -321,18 +383,22 @@ export interface UpdateDataSourcePermissionsRequest {
321
383
  */
322
384
  export interface UpdateDataSourcePermissionsResponse {
323
385
  /**
386
+ * @public
324
387
  * <p>The Amazon Resource Name (ARN) of the data source.</p>
325
388
  */
326
389
  DataSourceArn?: string;
327
390
  /**
391
+ * @public
328
392
  * <p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
329
393
  */
330
394
  DataSourceId?: string;
331
395
  /**
396
+ * @public
332
397
  * <p>The Amazon Web Services request ID for this operation.</p>
333
398
  */
334
399
  RequestId?: string;
335
400
  /**
401
+ * @public
336
402
  * <p>The HTTP status of the request.</p>
337
403
  */
338
404
  Status?: number;
@@ -342,14 +408,17 @@ export interface UpdateDataSourcePermissionsResponse {
342
408
  */
343
409
  export interface UpdateFolderRequest {
344
410
  /**
411
+ * @public
345
412
  * <p>The ID for the Amazon Web Services account that contains the folder to update.</p>
346
413
  */
347
414
  AwsAccountId: string | undefined;
348
415
  /**
416
+ * @public
349
417
  * <p>The ID of the folder.</p>
350
418
  */
351
419
  FolderId: string | undefined;
352
420
  /**
421
+ * @public
353
422
  * <p>The name of the folder.</p>
354
423
  */
355
424
  Name: string | undefined;
@@ -359,18 +428,22 @@ export interface UpdateFolderRequest {
359
428
  */
360
429
  export interface UpdateFolderResponse {
361
430
  /**
431
+ * @public
362
432
  * <p>The HTTP status of the request.</p>
363
433
  */
364
434
  Status?: number;
365
435
  /**
436
+ * @public
366
437
  * <p>The Amazon Resource Name (ARN) of the folder.</p>
367
438
  */
368
439
  Arn?: string;
369
440
  /**
441
+ * @public
370
442
  * <p>The ID of the folder.</p>
371
443
  */
372
444
  FolderId?: string;
373
445
  /**
446
+ * @public
374
447
  * <p>The Amazon Web Services request ID for this operation.</p>
375
448
  */
376
449
  RequestId?: string;
@@ -380,18 +453,22 @@ export interface UpdateFolderResponse {
380
453
  */
381
454
  export interface UpdateFolderPermissionsRequest {
382
455
  /**
456
+ * @public
383
457
  * <p>The ID for the Amazon Web Services account that contains the folder to update.</p>
384
458
  */
385
459
  AwsAccountId: string | undefined;
386
460
  /**
461
+ * @public
387
462
  * <p>The ID of the folder.</p>
388
463
  */
389
464
  FolderId: string | undefined;
390
465
  /**
466
+ * @public
391
467
  * <p>The permissions that you want to grant on a resource.</p>
392
468
  */
393
469
  GrantPermissions?: ResourcePermission[];
394
470
  /**
471
+ * @public
395
472
  * <p>The permissions that you want to revoke from a resource.</p>
396
473
  */
397
474
  RevokePermissions?: ResourcePermission[];
@@ -401,22 +478,27 @@ export interface UpdateFolderPermissionsRequest {
401
478
  */
402
479
  export interface UpdateFolderPermissionsResponse {
403
480
  /**
481
+ * @public
404
482
  * <p>The HTTP status of the request.</p>
405
483
  */
406
484
  Status?: number;
407
485
  /**
486
+ * @public
408
487
  * <p>The Amazon Resource Name (ARN) of the folder.</p>
409
488
  */
410
489
  Arn?: string;
411
490
  /**
491
+ * @public
412
492
  * <p>The ID of the folder.</p>
413
493
  */
414
494
  FolderId?: string;
415
495
  /**
496
+ * @public
416
497
  * <p>Information about the permissions for the folder.</p>
417
498
  */
418
499
  Permissions?: ResourcePermission[];
419
500
  /**
501
+ * @public
420
502
  * <p>The Amazon Web Services request ID for this operation.</p>
421
503
  */
422
504
  RequestId?: string;
@@ -426,19 +508,23 @@ export interface UpdateFolderPermissionsResponse {
426
508
  */
427
509
  export interface UpdateGroupRequest {
428
510
  /**
511
+ * @public
429
512
  * <p>The name of the group that you want to update.</p>
430
513
  */
431
514
  GroupName: string | undefined;
432
515
  /**
516
+ * @public
433
517
  * <p>The description for the group that you want to update.</p>
434
518
  */
435
519
  Description?: string;
436
520
  /**
521
+ * @public
437
522
  * <p>The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the
438
523
  * Amazon Web Services account that contains your Amazon QuickSight account.</p>
439
524
  */
440
525
  AwsAccountId: string | undefined;
441
526
  /**
527
+ * @public
442
528
  * <p>The namespace of the group that you want to update.</p>
443
529
  */
444
530
  Namespace: string | undefined;
@@ -448,14 +534,17 @@ export interface UpdateGroupRequest {
448
534
  */
449
535
  export interface UpdateGroupResponse {
450
536
  /**
537
+ * @public
451
538
  * <p>The name of the group.</p>
452
539
  */
453
540
  Group?: Group;
454
541
  /**
542
+ * @public
455
543
  * <p>The Amazon Web Services request ID for this operation.</p>
456
544
  */
457
545
  RequestId?: string;
458
546
  /**
547
+ * @public
459
548
  * <p>The HTTP status of the request.</p>
460
549
  */
461
550
  Status?: number;
@@ -465,11 +554,13 @@ export interface UpdateGroupResponse {
465
554
  */
466
555
  export interface UpdateIAMPolicyAssignmentRequest {
467
556
  /**
557
+ * @public
468
558
  * <p>The ID of the Amazon Web Services account that contains the IAM policy
469
559
  * assignment. </p>
470
560
  */
471
561
  AwsAccountId: string | undefined;
472
562
  /**
563
+ * @public
473
564
  * <p>The name of the assignment, also called a rule.
474
565
  * The
475
566
  * name must be unique within the
@@ -477,10 +568,12 @@ export interface UpdateIAMPolicyAssignmentRequest {
477
568
  */
478
569
  AssignmentName: string | undefined;
479
570
  /**
571
+ * @public
480
572
  * <p>The namespace of the assignment.</p>
481
573
  */
482
574
  Namespace: string | undefined;
483
575
  /**
576
+ * @public
484
577
  * <p>The status of the assignment. Possible values are as follows:</p>
485
578
  * <ul>
486
579
  * <li>
@@ -502,11 +595,13 @@ export interface UpdateIAMPolicyAssignmentRequest {
502
595
  */
503
596
  AssignmentStatus?: AssignmentStatus | string;
504
597
  /**
598
+ * @public
505
599
  * <p>The ARN for the IAM policy to apply to the Amazon QuickSight users and
506
600
  * groups specified in this assignment.</p>
507
601
  */
508
602
  PolicyArn?: string;
509
603
  /**
604
+ * @public
510
605
  * <p>The Amazon QuickSight users, groups, or both that you want to assign the policy
511
606
  * to.</p>
512
607
  */
@@ -517,24 +612,29 @@ export interface UpdateIAMPolicyAssignmentRequest {
517
612
  */
518
613
  export interface UpdateIAMPolicyAssignmentResponse {
519
614
  /**
615
+ * @public
520
616
  * <p>The name of the assignment or rule.</p>
521
617
  */
522
618
  AssignmentName?: string;
523
619
  /**
620
+ * @public
524
621
  * <p>The ID of the assignment.</p>
525
622
  */
526
623
  AssignmentId?: string;
527
624
  /**
625
+ * @public
528
626
  * <p>The ARN for the IAM policy applied to the Amazon QuickSight users and
529
627
  * groups specified in this assignment.</p>
530
628
  */
531
629
  PolicyArn?: string;
532
630
  /**
631
+ * @public
533
632
  * <p>The Amazon QuickSight users, groups, or both that the IAM policy is
534
633
  * assigned to.</p>
535
634
  */
536
635
  Identities?: Record<string, string[]>;
537
636
  /**
637
+ * @public
538
638
  * <p>The status of the assignment. Possible values are as follows:</p>
539
639
  * <ul>
540
640
  * <li>
@@ -556,10 +656,12 @@ export interface UpdateIAMPolicyAssignmentResponse {
556
656
  */
557
657
  AssignmentStatus?: AssignmentStatus | string;
558
658
  /**
659
+ * @public
559
660
  * <p>The Amazon Web Services request ID for this operation.</p>
560
661
  */
561
662
  RequestId?: string;
562
663
  /**
664
+ * @public
563
665
  * <p>The HTTP status of the request.</p>
564
666
  */
565
667
  Status?: number;
@@ -569,14 +671,17 @@ export interface UpdateIAMPolicyAssignmentResponse {
569
671
  */
570
672
  export interface UpdateIpRestrictionRequest {
571
673
  /**
674
+ * @public
572
675
  * <p>The ID of the Amazon Web Services account that contains the IP rules.</p>
573
676
  */
574
677
  AwsAccountId: string | undefined;
575
678
  /**
679
+ * @public
576
680
  * <p>A map that describes the updated IP rules with CIDR ranges and descriptions.</p>
577
681
  */
578
682
  IpRestrictionRuleMap?: Record<string, string>;
579
683
  /**
684
+ * @public
580
685
  * <p>A value that specifies whether IP rules are turned on.</p>
581
686
  */
582
687
  Enabled?: boolean;
@@ -586,14 +691,17 @@ export interface UpdateIpRestrictionRequest {
586
691
  */
587
692
  export interface UpdateIpRestrictionResponse {
588
693
  /**
694
+ * @public
589
695
  * <p>The ID of the Amazon Web Services account that contains the IP rules.</p>
590
696
  */
591
697
  AwsAccountId?: string;
592
698
  /**
699
+ * @public
593
700
  * <p>The Amazon Web Services request ID for this operation.</p>
594
701
  */
595
702
  RequestId?: string;
596
703
  /**
704
+ * @public
597
705
  * <p>The HTTP status of the request. </p>
598
706
  */
599
707
  Status?: number;
@@ -603,10 +711,12 @@ export interface UpdateIpRestrictionResponse {
603
711
  */
604
712
  export interface UpdatePublicSharingSettingsRequest {
605
713
  /**
714
+ * @public
606
715
  * <p>The Amazon Web Services account ID associated with your Amazon QuickSight subscription.</p>
607
716
  */
608
717
  AwsAccountId: string | undefined;
609
718
  /**
719
+ * @public
610
720
  * <p>A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account.</p>
611
721
  */
612
722
  PublicSharingEnabled?: boolean;
@@ -616,10 +726,12 @@ export interface UpdatePublicSharingSettingsRequest {
616
726
  */
617
727
  export interface UpdatePublicSharingSettingsResponse {
618
728
  /**
729
+ * @public
619
730
  * <p>The Amazon Web Services request ID for this operation.</p>
620
731
  */
621
732
  RequestId?: string;
622
733
  /**
734
+ * @public
623
735
  * <p>The HTTP status of the request.</p>
624
736
  */
625
737
  Status?: number;
@@ -629,14 +741,17 @@ export interface UpdatePublicSharingSettingsResponse {
629
741
  */
630
742
  export interface UpdateRefreshScheduleRequest {
631
743
  /**
744
+ * @public
632
745
  * <p>The ID of the dataset.</p>
633
746
  */
634
747
  DataSetId: string | undefined;
635
748
  /**
749
+ * @public
636
750
  * <p>The Amazon Web Services account ID.</p>
637
751
  */
638
752
  AwsAccountId: string | undefined;
639
753
  /**
754
+ * @public
640
755
  * <p>The refresh schedule.</p>
641
756
  */
642
757
  Schedule: RefreshSchedule | undefined;
@@ -646,18 +761,22 @@ export interface UpdateRefreshScheduleRequest {
646
761
  */
647
762
  export interface UpdateRefreshScheduleResponse {
648
763
  /**
764
+ * @public
649
765
  * <p>The HTTP status of the request.</p>
650
766
  */
651
767
  Status?: number;
652
768
  /**
769
+ * @public
653
770
  * <p>The Amazon Web Services request ID for this operation.</p>
654
771
  */
655
772
  RequestId?: string;
656
773
  /**
774
+ * @public
657
775
  * <p>The ID of the refresh schedule.</p>
658
776
  */
659
777
  ScheduleId?: string;
660
778
  /**
779
+ * @public
661
780
  * <p>The Amazon Resource Name (ARN) for the refresh schedule.</p>
662
781
  */
663
782
  Arn?: string;
@@ -667,14 +786,17 @@ export interface UpdateRefreshScheduleResponse {
667
786
  */
668
787
  export interface UpdateTemplateRequest {
669
788
  /**
789
+ * @public
670
790
  * <p>The ID of the Amazon Web Services account that contains the template that you're updating.</p>
671
791
  */
672
792
  AwsAccountId: string | undefined;
673
793
  /**
794
+ * @public
674
795
  * <p>The ID for the template.</p>
675
796
  */
676
797
  TemplateId: string | undefined;
677
798
  /**
799
+ * @public
678
800
  * <p>The entity that you are using as a source when you update the template. In
679
801
  * <code>SourceEntity</code>, you specify the type of object you're using as source:
680
802
  * <code>SourceTemplate</code> for a template or <code>SourceAnalysis</code> for an
@@ -688,6 +810,7 @@ export interface UpdateTemplateRequest {
688
810
  */
689
811
  SourceEntity?: TemplateSourceEntity;
690
812
  /**
813
+ * @public
691
814
  * <p>A description of the current template version that is being updated. Every time you call
692
815
  * <code>UpdateTemplate</code>, you create a new version of the template. Each version
693
816
  * of the template maintains a description of the version in the
@@ -695,10 +818,12 @@ export interface UpdateTemplateRequest {
695
818
  */
696
819
  VersionDescription?: string;
697
820
  /**
821
+ * @public
698
822
  * <p>The name for the template.</p>
699
823
  */
700
824
  Name?: string;
701
825
  /**
826
+ * @public
702
827
  * <p>The definition of a template.</p>
703
828
  * <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
704
829
  */
@@ -709,26 +834,32 @@ export interface UpdateTemplateRequest {
709
834
  */
710
835
  export interface UpdateTemplateResponse {
711
836
  /**
837
+ * @public
712
838
  * <p>The ID for the template.</p>
713
839
  */
714
840
  TemplateId?: string;
715
841
  /**
842
+ * @public
716
843
  * <p>The Amazon Resource Name (ARN) for the template.</p>
717
844
  */
718
845
  Arn?: string;
719
846
  /**
847
+ * @public
720
848
  * <p>The ARN for the template, including the version information of the first version.</p>
721
849
  */
722
850
  VersionArn?: string;
723
851
  /**
852
+ * @public
724
853
  * <p>The creation status of the template.</p>
725
854
  */
726
855
  CreationStatus?: ResourceStatus | string;
727
856
  /**
857
+ * @public
728
858
  * <p>The HTTP status of the request.</p>
729
859
  */
730
860
  Status?: number;
731
861
  /**
862
+ * @public
732
863
  * <p>The Amazon Web Services request ID for this operation.</p>
733
864
  */
734
865
  RequestId?: string;
@@ -738,14 +869,17 @@ export interface UpdateTemplateResponse {
738
869
  */
739
870
  export interface UpdateTemplateAliasRequest {
740
871
  /**
872
+ * @public
741
873
  * <p>The ID of the Amazon Web Services account that contains the template alias that you're updating.</p>
742
874
  */
743
875
  AwsAccountId: string | undefined;
744
876
  /**
877
+ * @public
745
878
  * <p>The ID for the template.</p>
746
879
  */
747
880
  TemplateId: string | undefined;
748
881
  /**
882
+ * @public
749
883
  * <p>The alias of the template that you want to update. If you name a specific alias, you update
750
884
  * the version that the alias points to. You can specify the latest version of the template
751
885
  * by providing the keyword <code>$LATEST</code> in the <code>AliasName</code> parameter.
@@ -753,6 +887,7 @@ export interface UpdateTemplateAliasRequest {
753
887
  */
754
888
  AliasName: string | undefined;
755
889
  /**
890
+ * @public
756
891
  * <p>The version number of the template.</p>
757
892
  */
758
893
  TemplateVersionNumber: number | undefined;
@@ -762,14 +897,17 @@ export interface UpdateTemplateAliasRequest {
762
897
  */
763
898
  export interface UpdateTemplateAliasResponse {
764
899
  /**
900
+ * @public
765
901
  * <p>The template alias.</p>
766
902
  */
767
903
  TemplateAlias?: TemplateAlias;
768
904
  /**
905
+ * @public
769
906
  * <p>The HTTP status of the request.</p>
770
907
  */
771
908
  Status?: number;
772
909
  /**
910
+ * @public
773
911
  * <p>The Amazon Web Services request ID for this operation.</p>
774
912
  */
775
913
  RequestId?: string;
@@ -779,18 +917,22 @@ export interface UpdateTemplateAliasResponse {
779
917
  */
780
918
  export interface UpdateTemplatePermissionsRequest {
781
919
  /**
920
+ * @public
782
921
  * <p>The ID of the Amazon Web Services account that contains the template.</p>
783
922
  */
784
923
  AwsAccountId: string | undefined;
785
924
  /**
925
+ * @public
786
926
  * <p>The ID for the template.</p>
787
927
  */
788
928
  TemplateId: string | undefined;
789
929
  /**
930
+ * @public
790
931
  * <p>A list of resource permissions to be granted on the template. </p>
791
932
  */
792
933
  GrantPermissions?: ResourcePermission[];
793
934
  /**
935
+ * @public
794
936
  * <p>A list of resource permissions to be revoked from the template. </p>
795
937
  */
796
938
  RevokePermissions?: ResourcePermission[];
@@ -800,22 +942,27 @@ export interface UpdateTemplatePermissionsRequest {
800
942
  */
801
943
  export interface UpdateTemplatePermissionsResponse {
802
944
  /**
945
+ * @public
803
946
  * <p>The ID for the template.</p>
804
947
  */
805
948
  TemplateId?: string;
806
949
  /**
950
+ * @public
807
951
  * <p>The Amazon Resource Name (ARN) of the template.</p>
808
952
  */
809
953
  TemplateArn?: string;
810
954
  /**
955
+ * @public
811
956
  * <p>A list of resource permissions to be set on the template.</p>
812
957
  */
813
958
  Permissions?: ResourcePermission[];
814
959
  /**
960
+ * @public
815
961
  * <p>The Amazon Web Services request ID for this operation.</p>
816
962
  */
817
963
  RequestId?: string;
818
964
  /**
965
+ * @public
819
966
  * <p>The HTTP status of the request.</p>
820
967
  */
821
968
  Status?: number;
@@ -825,29 +972,35 @@ export interface UpdateTemplatePermissionsResponse {
825
972
  */
826
973
  export interface UpdateThemeRequest {
827
974
  /**
975
+ * @public
828
976
  * <p>The ID of the Amazon Web Services account that contains the theme that you're updating.</p>
829
977
  */
830
978
  AwsAccountId: string | undefined;
831
979
  /**
980
+ * @public
832
981
  * <p>The ID for the theme.</p>
833
982
  */
834
983
  ThemeId: string | undefined;
835
984
  /**
985
+ * @public
836
986
  * <p>The name for the theme.</p>
837
987
  */
838
988
  Name?: string;
839
989
  /**
990
+ * @public
840
991
  * <p>The theme ID, defined by Amazon QuickSight, that a custom theme inherits from.
841
992
  * All themes initially inherit from a default Amazon QuickSight theme.</p>
842
993
  */
843
994
  BaseThemeId: string | undefined;
844
995
  /**
996
+ * @public
845
997
  * <p>A description of the theme version that you're updating Every time that you call
846
998
  * <code>UpdateTheme</code>, you create a new version of the theme. Each version of the
847
999
  * theme maintains a description of the version in <code>VersionDescription</code>.</p>
848
1000
  */
849
1001
  VersionDescription?: string;
850
1002
  /**
1003
+ * @public
851
1004
  * <p>The theme configuration, which contains the theme display properties.</p>
852
1005
  */
853
1006
  Configuration?: ThemeConfiguration;
@@ -857,26 +1010,32 @@ export interface UpdateThemeRequest {
857
1010
  */
858
1011
  export interface UpdateThemeResponse {
859
1012
  /**
1013
+ * @public
860
1014
  * <p>The ID for the theme.</p>
861
1015
  */
862
1016
  ThemeId?: string;
863
1017
  /**
1018
+ * @public
864
1019
  * <p>The Amazon Resource Name (ARN) for the theme.</p>
865
1020
  */
866
1021
  Arn?: string;
867
1022
  /**
1023
+ * @public
868
1024
  * <p>The Amazon Resource Name (ARN) for the new version of the theme.</p>
869
1025
  */
870
1026
  VersionArn?: string;
871
1027
  /**
1028
+ * @public
872
1029
  * <p>The creation status of the theme.</p>
873
1030
  */
874
1031
  CreationStatus?: ResourceStatus | string;
875
1032
  /**
1033
+ * @public
876
1034
  * <p>The HTTP status of the request.</p>
877
1035
  */
878
1036
  Status?: number;
879
1037
  /**
1038
+ * @public
880
1039
  * <p>The Amazon Web Services request ID for this operation.</p>
881
1040
  */
882
1041
  RequestId?: string;
@@ -886,18 +1045,22 @@ export interface UpdateThemeResponse {
886
1045
  */
887
1046
  export interface UpdateThemeAliasRequest {
888
1047
  /**
1048
+ * @public
889
1049
  * <p>The ID of the Amazon Web Services account that contains the theme alias that you're updating.</p>
890
1050
  */
891
1051
  AwsAccountId: string | undefined;
892
1052
  /**
1053
+ * @public
893
1054
  * <p>The ID for the theme.</p>
894
1055
  */
895
1056
  ThemeId: string | undefined;
896
1057
  /**
1058
+ * @public
897
1059
  * <p>The name of the theme alias that you want to update.</p>
898
1060
  */
899
1061
  AliasName: string | undefined;
900
1062
  /**
1063
+ * @public
901
1064
  * <p>The version number of the theme that the alias should reference.</p>
902
1065
  */
903
1066
  ThemeVersionNumber: number | undefined;
@@ -907,14 +1070,17 @@ export interface UpdateThemeAliasRequest {
907
1070
  */
908
1071
  export interface UpdateThemeAliasResponse {
909
1072
  /**
1073
+ * @public
910
1074
  * <p>Information about the theme alias.</p>
911
1075
  */
912
1076
  ThemeAlias?: ThemeAlias;
913
1077
  /**
1078
+ * @public
914
1079
  * <p>The HTTP status of the request.</p>
915
1080
  */
916
1081
  Status?: number;
917
1082
  /**
1083
+ * @public
918
1084
  * <p>The Amazon Web Services request ID for this operation.</p>
919
1085
  */
920
1086
  RequestId?: string;
@@ -924,18 +1090,22 @@ export interface UpdateThemeAliasResponse {
924
1090
  */
925
1091
  export interface UpdateThemePermissionsRequest {
926
1092
  /**
1093
+ * @public
927
1094
  * <p>The ID of the Amazon Web Services account that contains the theme.</p>
928
1095
  */
929
1096
  AwsAccountId: string | undefined;
930
1097
  /**
1098
+ * @public
931
1099
  * <p>The ID for the theme.</p>
932
1100
  */
933
1101
  ThemeId: string | undefined;
934
1102
  /**
1103
+ * @public
935
1104
  * <p>A list of resource permissions to be granted for the theme.</p>
936
1105
  */
937
1106
  GrantPermissions?: ResourcePermission[];
938
1107
  /**
1108
+ * @public
939
1109
  * <p>A list of resource permissions to be revoked from the theme.</p>
940
1110
  */
941
1111
  RevokePermissions?: ResourcePermission[];
@@ -945,22 +1115,27 @@ export interface UpdateThemePermissionsRequest {
945
1115
  */
946
1116
  export interface UpdateThemePermissionsResponse {
947
1117
  /**
1118
+ * @public
948
1119
  * <p>The ID for the theme.</p>
949
1120
  */
950
1121
  ThemeId?: string;
951
1122
  /**
1123
+ * @public
952
1124
  * <p>The Amazon Resource Name (ARN) of the theme.</p>
953
1125
  */
954
1126
  ThemeArn?: string;
955
1127
  /**
1128
+ * @public
956
1129
  * <p>The resulting list of resource permissions for the theme.</p>
957
1130
  */
958
1131
  Permissions?: ResourcePermission[];
959
1132
  /**
1133
+ * @public
960
1134
  * <p>The Amazon Web Services request ID for this operation.</p>
961
1135
  */
962
1136
  RequestId?: string;
963
1137
  /**
1138
+ * @public
964
1139
  * <p>The HTTP status of the request.</p>
965
1140
  */
966
1141
  Status?: number;
@@ -970,15 +1145,18 @@ export interface UpdateThemePermissionsResponse {
970
1145
  */
971
1146
  export interface UpdateTopicRequest {
972
1147
  /**
1148
+ * @public
973
1149
  * <p>The ID of the Amazon Web Services account that contains the topic that you want to
974
1150
  * update.</p>
975
1151
  */
976
1152
  AwsAccountId: string | undefined;
977
1153
  /**
1154
+ * @public
978
1155
  * <p>The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
979
1156
  */
980
1157
  TopicId: string | undefined;
981
1158
  /**
1159
+ * @public
982
1160
  * <p>The definition of the topic that you want to update.</p>
983
1161
  */
984
1162
  Topic: TopicDetails | undefined;
@@ -988,22 +1166,27 @@ export interface UpdateTopicRequest {
988
1166
  */
989
1167
  export interface UpdateTopicResponse {
990
1168
  /**
1169
+ * @public
991
1170
  * <p>The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
992
1171
  */
993
1172
  TopicId?: string;
994
1173
  /**
1174
+ * @public
995
1175
  * <p>The Amazon Resource Name (ARN) of the topic.</p>
996
1176
  */
997
1177
  Arn?: string;
998
1178
  /**
1179
+ * @public
999
1180
  * <p>The Amazon Resource Name (ARN) of the topic refresh.</p>
1000
1181
  */
1001
1182
  RefreshArn?: string;
1002
1183
  /**
1184
+ * @public
1003
1185
  * <p>The Amazon Web Services request ID for this operation.</p>
1004
1186
  */
1005
1187
  RequestId?: string;
1006
1188
  /**
1189
+ * @public
1007
1190
  * <p>The HTTP status of the request.</p>
1008
1191
  */
1009
1192
  Status?: number;
@@ -1013,19 +1196,23 @@ export interface UpdateTopicResponse {
1013
1196
  */
1014
1197
  export interface UpdateTopicPermissionsRequest {
1015
1198
  /**
1199
+ * @public
1016
1200
  * <p>The ID of the Amazon Web Services account that contains the topic that you want to update
1017
1201
  * the permissions for.</p>
1018
1202
  */
1019
1203
  AwsAccountId: string | undefined;
1020
1204
  /**
1205
+ * @public
1021
1206
  * <p>The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
1022
1207
  */
1023
1208
  TopicId: string | undefined;
1024
1209
  /**
1210
+ * @public
1025
1211
  * <p>The resource permissions that you want to grant to the topic.</p>
1026
1212
  */
1027
1213
  GrantPermissions?: ResourcePermission[];
1028
1214
  /**
1215
+ * @public
1029
1216
  * <p>The resource permissions that you want to revoke from the topic.</p>
1030
1217
  */
1031
1218
  RevokePermissions?: ResourcePermission[];
@@ -1035,22 +1222,27 @@ export interface UpdateTopicPermissionsRequest {
1035
1222
  */
1036
1223
  export interface UpdateTopicPermissionsResponse {
1037
1224
  /**
1225
+ * @public
1038
1226
  * <p>The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
1039
1227
  */
1040
1228
  TopicId?: string;
1041
1229
  /**
1230
+ * @public
1042
1231
  * <p>The Amazon Resource Name (ARN) of the topic.</p>
1043
1232
  */
1044
1233
  TopicArn?: string;
1045
1234
  /**
1235
+ * @public
1046
1236
  * <p>A list of resource permissions on the topic.</p>
1047
1237
  */
1048
1238
  Permissions?: ResourcePermission[];
1049
1239
  /**
1240
+ * @public
1050
1241
  * <p>The HTTP status of the request.</p>
1051
1242
  */
1052
1243
  Status?: number;
1053
1244
  /**
1245
+ * @public
1054
1246
  * <p>The Amazon Web Services request ID for this operation.</p>
1055
1247
  */
1056
1248
  RequestId?: string;
@@ -1060,19 +1252,23 @@ export interface UpdateTopicPermissionsResponse {
1060
1252
  */
1061
1253
  export interface UpdateTopicRefreshScheduleRequest {
1062
1254
  /**
1255
+ * @public
1063
1256
  * <p>The ID of the Amazon Web Services account that contains the topic whose refresh schedule
1064
1257
  * you want to update.</p>
1065
1258
  */
1066
1259
  AwsAccountId: string | undefined;
1067
1260
  /**
1261
+ * @public
1068
1262
  * <p>The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
1069
1263
  */
1070
1264
  TopicId: string | undefined;
1071
1265
  /**
1266
+ * @public
1072
1267
  * <p>The ID of the dataset.</p>
1073
1268
  */
1074
1269
  DatasetId: string | undefined;
1075
1270
  /**
1271
+ * @public
1076
1272
  * <p>The definition of a refresh schedule.</p>
1077
1273
  */
1078
1274
  RefreshSchedule: TopicRefreshSchedule | undefined;
@@ -1082,22 +1278,27 @@ export interface UpdateTopicRefreshScheduleRequest {
1082
1278
  */
1083
1279
  export interface UpdateTopicRefreshScheduleResponse {
1084
1280
  /**
1281
+ * @public
1085
1282
  * <p>The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
1086
1283
  */
1087
1284
  TopicId?: string;
1088
1285
  /**
1286
+ * @public
1089
1287
  * <p>The Amazon Resource Name (ARN) of the topic.</p>
1090
1288
  */
1091
1289
  TopicArn?: string;
1092
1290
  /**
1291
+ * @public
1093
1292
  * <p>The Amazon Resource Name (ARN) of the dataset.</p>
1094
1293
  */
1095
1294
  DatasetArn?: string;
1096
1295
  /**
1296
+ * @public
1097
1297
  * <p>The HTTP status of the request.</p>
1098
1298
  */
1099
1299
  Status?: number;
1100
1300
  /**
1301
+ * @public
1101
1302
  * <p>The Amazon Web Services request ID for this operation.</p>
1102
1303
  */
1103
1304
  RequestId?: string;
@@ -1107,23 +1308,28 @@ export interface UpdateTopicRefreshScheduleResponse {
1107
1308
  */
1108
1309
  export interface UpdateUserRequest {
1109
1310
  /**
1311
+ * @public
1110
1312
  * <p>The Amazon QuickSight user name that you want to update.</p>
1111
1313
  */
1112
1314
  UserName: string | undefined;
1113
1315
  /**
1316
+ * @public
1114
1317
  * <p>The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the
1115
1318
  * Amazon Web Services account that contains your Amazon QuickSight account.</p>
1116
1319
  */
1117
1320
  AwsAccountId: string | undefined;
1118
1321
  /**
1322
+ * @public
1119
1323
  * <p>The namespace. Currently, you should set this to <code>default</code>.</p>
1120
1324
  */
1121
1325
  Namespace: string | undefined;
1122
1326
  /**
1327
+ * @public
1123
1328
  * <p>The email address of the user that you want to update.</p>
1124
1329
  */
1125
1330
  Email: string | undefined;
1126
1331
  /**
1332
+ * @public
1127
1333
  * <p>The Amazon QuickSight role of the user. The role can be one of the
1128
1334
  * following default security cohorts:</p>
1129
1335
  * <ul>
@@ -1147,6 +1353,7 @@ export interface UpdateUserRequest {
1147
1353
  */
1148
1354
  Role: UserRole | string | undefined;
1149
1355
  /**
1356
+ * @public
1150
1357
  * <p>(Enterprise edition only) The name of the custom permissions profile that you want to
1151
1358
  * assign to this user. Customized permissions allows you to control a user's access by
1152
1359
  * restricting access the following operations:</p>
@@ -1175,6 +1382,7 @@ export interface UpdateUserRequest {
1175
1382
  */
1176
1383
  CustomPermissionsName?: string;
1177
1384
  /**
1385
+ * @public
1178
1386
  * <p>A flag that you use to indicate that you want to remove all custom permissions
1179
1387
  * from this user. Using this parameter resets the user to the state
1180
1388
  * it was in before a custom permissions profile was applied. This parameter defaults to
@@ -1182,6 +1390,7 @@ export interface UpdateUserRequest {
1182
1390
  */
1183
1391
  UnapplyCustomPermissions?: boolean;
1184
1392
  /**
1393
+ * @public
1185
1394
  * <p>The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.</p>
1186
1395
  * <ul>
1187
1396
  * <li>
@@ -1204,12 +1413,14 @@ export interface UpdateUserRequest {
1204
1413
  */
1205
1414
  ExternalLoginFederationProviderType?: string;
1206
1415
  /**
1416
+ * @public
1207
1417
  * <p>The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate
1208
1418
  * into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should
1209
1419
  * only be used when <code>ExternalLoginFederationProviderType</code> parameter is set to <code>CUSTOM_OIDC</code>.</p>
1210
1420
  */
1211
1421
  CustomFederationProviderUrl?: string;
1212
1422
  /**
1423
+ * @public
1213
1424
  * <p>The identity ID for a user in the external login provider.</p>
1214
1425
  */
1215
1426
  ExternalLoginId?: string;
@@ -1219,14 +1430,17 @@ export interface UpdateUserRequest {
1219
1430
  */
1220
1431
  export interface UpdateUserResponse {
1221
1432
  /**
1433
+ * @public
1222
1434
  * <p>The Amazon QuickSight user.</p>
1223
1435
  */
1224
1436
  User?: User;
1225
1437
  /**
1438
+ * @public
1226
1439
  * <p>The Amazon Web Services request ID for this operation.</p>
1227
1440
  */
1228
1441
  RequestId?: string;
1229
1442
  /**
1443
+ * @public
1230
1444
  * <p>The HTTP status of the request.</p>
1231
1445
  */
1232
1446
  Status?: number;
@@ -1236,33 +1450,40 @@ export interface UpdateUserResponse {
1236
1450
  */
1237
1451
  export interface UpdateVPCConnectionRequest {
1238
1452
  /**
1453
+ * @public
1239
1454
  * <p>The Amazon Web Services account ID of the account that contains the VPC connection that
1240
1455
  * you want to update.</p>
1241
1456
  */
1242
1457
  AwsAccountId: string | undefined;
1243
1458
  /**
1459
+ * @public
1244
1460
  * <p>The ID of the VPC connection that
1245
1461
  * you're updating. This ID is a unique identifier for each Amazon Web Services Region in an
1246
1462
  * Amazon Web Services account.</p>
1247
1463
  */
1248
1464
  VPCConnectionId: string | undefined;
1249
1465
  /**
1466
+ * @public
1250
1467
  * <p>The display name for the VPC connection.</p>
1251
1468
  */
1252
1469
  Name: string | undefined;
1253
1470
  /**
1471
+ * @public
1254
1472
  * <p>A list of subnet IDs for the VPC connection.</p>
1255
1473
  */
1256
1474
  SubnetIds: string[] | undefined;
1257
1475
  /**
1476
+ * @public
1258
1477
  * <p>A list of security group IDs for the VPC connection.</p>
1259
1478
  */
1260
1479
  SecurityGroupIds: string[] | undefined;
1261
1480
  /**
1481
+ * @public
1262
1482
  * <p>A list of IP addresses of DNS resolver endpoints for the VPC connection.</p>
1263
1483
  */
1264
1484
  DnsResolvers?: string[];
1265
1485
  /**
1486
+ * @public
1266
1487
  * <p>An IAM role associated with the VPC connection.</p>
1267
1488
  */
1268
1489
  RoleArn: string | undefined;
@@ -1272,26 +1493,32 @@ export interface UpdateVPCConnectionRequest {
1272
1493
  */
1273
1494
  export interface UpdateVPCConnectionResponse {
1274
1495
  /**
1496
+ * @public
1275
1497
  * <p>The Amazon Resource Name (ARN) of the VPC connection.</p>
1276
1498
  */
1277
1499
  Arn?: string;
1278
1500
  /**
1501
+ * @public
1279
1502
  * <p>The ID of the VPC connection that you are updating. This ID is a unique identifier for each Amazon Web Services Region in anAmazon Web Services account.</p>
1280
1503
  */
1281
1504
  VPCConnectionId?: string;
1282
1505
  /**
1506
+ * @public
1283
1507
  * <p>The update status of the VPC connection's last update.</p>
1284
1508
  */
1285
1509
  UpdateStatus?: VPCConnectionResourceStatus | string;
1286
1510
  /**
1511
+ * @public
1287
1512
  * <p>The availability status of the VPC connection.</p>
1288
1513
  */
1289
1514
  AvailabilityStatus?: VPCConnectionAvailabilityStatus | string;
1290
1515
  /**
1516
+ * @public
1291
1517
  * <p>The Amazon Web Services request ID for this operation.</p>
1292
1518
  */
1293
1519
  RequestId?: string;
1294
1520
  /**
1521
+ * @public
1295
1522
  * <p>The HTTP status of the request.</p>
1296
1523
  */
1297
1524
  Status?: number;