@aws-sdk/client-lightsail 3.379.1 → 3.385.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 (3) hide show
  1. package/dist-types/models/models_0.d.ts +749 -0
  2. package/dist-types/models/models_1.d.ts +539 -0
  3. package/package.json +5 -5
package/dist-types/models/models_0.d.ts CHANGED
@@ -37,16 +37,19 @@ export type AccessDirection = (typeof AccessDirection)[keyof typeof AccessDirect
37
37
  */
38
38
  export interface AccessKeyLastUsed {
39
39
  /**
40
+ * @public
40
41
  * <p>The date and time when the access key was most recently used.</p>
41
42
  * <p>This value is null if the access key has not been used.</p>
42
43
  */
43
44
  lastUsedDate?: Date;
44
45
  /**
46
+ * @public
45
47
  * <p>The Amazon Web Services Region where this access key was most recently used.</p>
46
48
  * <p>This value is <code>N/A</code> if the access key has not been used.</p>
47
49
  */
48
50
  region?: string;
49
51
  /**
52
+ * @public
50
53
  * <p>The name of the Amazon Web Services service with which this access key was most recently
51
54
  * used.</p>
52
55
  * <p>This value is <code>N/A</code> if the access key has not been used.</p>
@@ -81,26 +84,31 @@ export type StatusType = (typeof StatusType)[keyof typeof StatusType];
81
84
  */
82
85
  export interface AccessKey {
83
86
  /**
87
+ * @public
84
88
  * <p>The ID of the access key.</p>
85
89
  */
86
90
  accessKeyId?: string;
87
91
  /**
92
+ * @public
88
93
  * <p>The secret access key used to sign requests.</p>
89
94
  * <p>You should store the secret access key in a safe location. We recommend that you delete
90
95
  * the access key if the secret access key is compromised.</p>
91
96
  */
92
97
  secretAccessKey?: string;
93
98
  /**
99
+ * @public
94
100
  * <p>The status of the access key.</p>
95
101
  * <p>A status of <code>Active</code> means that the key is valid, while <code>Inactive</code>
96
102
  * means it is not.</p>
97
103
  */
98
104
  status?: StatusType | string;
99
105
  /**
106
+ * @public
100
107
  * <p>The timestamp when the access key was created.</p>
101
108
  */
102
109
  createdAt?: Date;
103
110
  /**
111
+ * @public
104
112
  * <p>An object that describes the last time the access key was used.</p>
105
113
  * <note>
106
114
  * <p>This object does not include data in the response of a <a href="https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateBucketAccessKey.html">CreateBucketAccessKey</a> action. If the access key has not been used, the
@@ -116,10 +124,12 @@ export interface AccessKey {
116
124
  */
117
125
  export interface ResourceReceivingAccess {
118
126
  /**
127
+ * @public
119
128
  * <p>The name of the Lightsail instance.</p>
120
129
  */
121
130
  name?: string;
122
131
  /**
132
+ * @public
123
133
  * <p>The Lightsail resource type (for example, <code>Instance</code>).</p>
124
134
  */
125
135
  resourceType?: string;
@@ -146,6 +156,7 @@ export type AccessType = (typeof AccessType)[keyof typeof AccessType];
146
156
  */
147
157
  export interface AccessRules {
148
158
  /**
159
+ * @public
149
160
  * <p>Specifies the anonymous access to all objects in a bucket.</p>
150
161
  * <p>The following options can be specified:</p>
151
162
  * <ul>
@@ -171,6 +182,7 @@ export interface AccessRules {
171
182
  */
172
183
  getObject?: AccessType | string;
173
184
  /**
185
+ * @public
174
186
  * <p>A Boolean value that indicates whether the access control list (ACL) permissions that are
175
187
  * applied to individual objects override the <code>getObject</code> option that is currently
176
188
  * specified.</p>
@@ -224,6 +236,7 @@ export type AccountLevelBpaSyncStatus = (typeof AccountLevelBpaSyncStatus)[keyof
224
236
  */
225
237
  export interface AccountLevelBpaSync {
226
238
  /**
239
+ * @public
227
240
  * <p>The status of the account-level BPA synchronization.</p>
228
241
  * <p>The following statuses are possible:</p>
229
242
  * <ul>
@@ -256,11 +269,13 @@ export interface AccountLevelBpaSync {
256
269
  */
257
270
  status?: AccountLevelBpaSyncStatus | string;
258
271
  /**
272
+ * @public
259
273
  * <p>The timestamp of when the account-level BPA configuration was last synchronized. This
260
274
  * value is null when the account-level BPA configuration has not been synchronized.</p>
261
275
  */
262
276
  lastSyncedAt?: Date;
263
277
  /**
278
+ * @public
264
279
  * <p>A message that provides a reason for a <code>Failed</code> or <code>Defaulted</code>
265
280
  * synchronization status.</p>
266
281
  * <p>The following messages are possible:</p>
@@ -301,6 +316,7 @@ export interface AccountLevelBpaSync {
301
316
  */
302
317
  message?: BPAStatusMessage | string;
303
318
  /**
319
+ * @public
304
320
  * <p>A Boolean value that indicates whether account-level block public access is affecting your
305
321
  * Lightsail buckets.</p>
306
322
  */
@@ -328,14 +344,17 @@ export declare class AccountSetupInProgressException extends __BaseException {
328
344
  */
329
345
  export interface AddOn {
330
346
  /**
347
+ * @public
331
348
  * <p>The name of the add-on.</p>
332
349
  */
333
350
  name?: string;
334
351
  /**
352
+ * @public
335
353
  * <p>The status of the add-on.</p>
336
354
  */
337
355
  status?: string;
338
356
  /**
357
+ * @public
339
358
  * <p>The daily time when an automatic snapshot is created.</p>
340
359
  * <p>The time shown is in <code>HH:00</code> format, and in Coordinated Universal Time
341
360
  * (UTC).</p>
@@ -344,6 +363,7 @@ export interface AddOn {
344
363
  */
345
364
  snapshotTimeOfDay?: string;
346
365
  /**
366
+ * @public
347
367
  * <p>The next daily time an automatic snapshot will be created.</p>
348
368
  * <p>The time shown is in <code>HH:00</code> format, and in Coordinated Universal Time
349
369
  * (UTC).</p>
@@ -352,6 +372,7 @@ export interface AddOn {
352
372
  */
353
373
  nextSnapshotTimeOfDay?: string;
354
374
  /**
375
+ * @public
355
376
  * <p>The trigger threshold of the action.</p>
356
377
  * <important>
357
378
  * <p>This add-on only applies to Lightsail for Research resources.</p>
@@ -359,6 +380,7 @@ export interface AddOn {
359
380
  */
360
381
  threshold?: string;
361
382
  /**
383
+ * @public
362
384
  * <p>The amount of idle time in minutes after which your virtual computer will automatically stop.</p>
363
385
  * <important>
364
386
  * <p>This add-on only applies to Lightsail for Research resources.</p>
@@ -416,6 +438,7 @@ export type AddOnType = (typeof AddOnType)[keyof typeof AddOnType];
416
438
  */
417
439
  export interface AutoSnapshotAddOnRequest {
418
440
  /**
441
+ * @public
419
442
  * <p>The daily time when an automatic snapshot will be created.</p>
420
443
  * <p>Constraints:</p>
421
444
  * <ul>
@@ -442,10 +465,12 @@ export interface AutoSnapshotAddOnRequest {
442
465
  */
443
466
  export interface StopInstanceOnIdleRequest {
444
467
  /**
468
+ * @public
445
469
  * <p>The value to compare with the duration.</p>
446
470
  */
447
471
  threshold?: string;
448
472
  /**
473
+ * @public
449
474
  * <p>The amount of idle time in minutes after which your virtual computer will automatically stop.</p>
450
475
  */
451
476
  duration?: string;
@@ -462,15 +487,18 @@ export interface StopInstanceOnIdleRequest {
462
487
  */
463
488
  export interface AddOnRequest {
464
489
  /**
490
+ * @public
465
491
  * <p>The add-on type.</p>
466
492
  */
467
493
  addOnType: AddOnType | string | undefined;
468
494
  /**
495
+ * @public
469
496
  * <p>An object that represents additional parameters when enabling or modifying the automatic
470
497
  * snapshot add-on.</p>
471
498
  */
472
499
  autoSnapshotAddOnRequest?: AutoSnapshotAddOnRequest;
473
500
  /**
501
+ * @public
474
502
  * <p>An object that represents additional parameters when enabling or modifying the
475
503
  * <code>StopInstanceOnIdle</code> add-on.</p>
476
504
  * <important>
@@ -536,10 +564,12 @@ export type RegionName = (typeof RegionName)[keyof typeof RegionName];
536
564
  */
537
565
  export interface ResourceLocation {
538
566
  /**
567
+ * @public
539
568
  * <p>The Availability Zone. Follows the format <code>us-east-2a</code> (case-sensitive).</p>
540
569
  */
541
570
  availabilityZone?: string;
542
571
  /**
572
+ * @public
543
573
  * <p>The Amazon Web Services Region name.</p>
544
574
  */
545
575
  regionName?: RegionName | string;
@@ -618,14 +648,17 @@ export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
618
648
  */
619
649
  export interface MonitoredResourceInfo {
620
650
  /**
651
+ * @public
621
652
  * <p>The Amazon Resource Name (ARN) of the resource being monitored.</p>
622
653
  */
623
654
  arn?: string;
624
655
  /**
656
+ * @public
625
657
  * <p>The name of the Lightsail resource being monitored.</p>
626
658
  */
627
659
  name?: string;
628
660
  /**
661
+ * @public
629
662
  * <p>The Lightsail resource type of the resource being monitored.</p>
630
663
  * <p>Instances, load balancers, and relational databases are the only Lightsail resources
631
664
  * that can currently be monitored by alarms.</p>
@@ -719,57 +752,70 @@ export type MetricUnit = (typeof MetricUnit)[keyof typeof MetricUnit];
719
752
  */
720
753
  export interface Alarm {
721
754
  /**
755
+ * @public
722
756
  * <p>The name of the alarm.</p>
723
757
  */
724
758
  name?: string;
725
759
  /**
760
+ * @public
726
761
  * <p>The Amazon Resource Name (ARN) of the alarm.</p>
727
762
  */
728
763
  arn?: string;
729
764
  /**
765
+ * @public
730
766
  * <p>The timestamp when the alarm was created.</p>
731
767
  */
732
768
  createdAt?: Date;
733
769
  /**
770
+ * @public
734
771
  * <p>An object that lists information about the location of the alarm.</p>
735
772
  */
736
773
  location?: ResourceLocation;
737
774
  /**
775
+ * @public
738
776
  * <p>The Lightsail resource type (e.g., <code>Alarm</code>).</p>
739
777
  */
740
778
  resourceType?: ResourceType | string;
741
779
  /**
780
+ * @public
742
781
  * <p>The support code. Include this code in your email to support when you have questions about
743
782
  * your Lightsail alarm. This code enables our support team to look up your Lightsail
744
783
  * information more easily.</p>
745
784
  */
746
785
  supportCode?: string;
747
786
  /**
787
+ * @public
748
788
  * <p>An object that lists information about the resource monitored by the alarm.</p>
749
789
  */
750
790
  monitoredResourceInfo?: MonitoredResourceInfo;
751
791
  /**
792
+ * @public
752
793
  * <p>The arithmetic operation used when comparing the specified statistic and threshold.</p>
753
794
  */
754
795
  comparisonOperator?: ComparisonOperator | string;
755
796
  /**
797
+ * @public
756
798
  * <p>The number of periods over which data is compared to the specified threshold.</p>
757
799
  */
758
800
  evaluationPeriods?: number;
759
801
  /**
802
+ * @public
760
803
  * <p>The period, in seconds, over which the statistic is applied.</p>
761
804
  */
762
805
  period?: number;
763
806
  /**
807
+ * @public
764
808
  * <p>The value against which the specified statistic is compared.</p>
765
809
  */
766
810
  threshold?: number;
767
811
  /**
812
+ * @public
768
813
  * <p>The number of data points that must not within the specified threshold to trigger the
769
814
  * alarm.</p>
770
815
  */
771
816
  datapointsToAlarm?: number;
772
817
  /**
818
+ * @public
773
819
  * <p>Specifies how the alarm handles missing data points.</p>
774
820
  * <p>An alarm can treat missing data in the following ways:</p>
775
821
  * <ul>
@@ -797,6 +843,7 @@ export interface Alarm {
797
843
  */
798
844
  treatMissingData?: TreatMissingData | string;
799
845
  /**
846
+ * @public
800
847
  * <p>The statistic for the metric associated with the alarm.</p>
801
848
  * <p>The following statistics are available:</p>
802
849
  * <ul>
@@ -831,10 +878,12 @@ export interface Alarm {
831
878
  */
832
879
  statistic?: MetricStatistic | string;
833
880
  /**
881
+ * @public
834
882
  * <p>The name of the metric associated with the alarm.</p>
835
883
  */
836
884
  metricName?: MetricName | string;
837
885
  /**
886
+ * @public
838
887
  * <p>The current state of the alarm.</p>
839
888
  * <p>An alarm has the following possible states:</p>
840
889
  * <ul>
@@ -856,19 +905,23 @@ export interface Alarm {
856
905
  */
857
906
  state?: AlarmState | string;
858
907
  /**
908
+ * @public
859
909
  * <p>The unit of the metric associated with the alarm.</p>
860
910
  */
861
911
  unit?: MetricUnit | string;
862
912
  /**
913
+ * @public
863
914
  * <p>The contact protocols for the alarm, such as <code>Email</code>, <code>SMS</code> (text
864
915
  * messaging), or both.</p>
865
916
  */
866
917
  contactProtocols?: (ContactProtocol | string)[];
867
918
  /**
919
+ * @public
868
920
  * <p>The alarm states that trigger a notification.</p>
869
921
  */
870
922
  notificationTriggers?: (AlarmState | string)[];
871
923
  /**
924
+ * @public
872
925
  * <p>Indicates whether the alarm is enabled.</p>
873
926
  */
874
927
  notificationEnabled?: boolean;
@@ -878,6 +931,7 @@ export interface Alarm {
878
931
  */
879
932
  export interface AllocateStaticIpRequest {
880
933
  /**
934
+ * @public
881
935
  * <p>The name of the static IP address.</p>
882
936
  */
883
937
  staticIpName: string | undefined;
@@ -995,51 +1049,63 @@ export type OperationStatus = (typeof OperationStatus)[keyof typeof OperationSta
995
1049
  */
996
1050
  export interface Operation {
997
1051
  /**
1052
+ * @public
998
1053
  * <p>The ID of the operation.</p>
999
1054
  */
1000
1055
  id?: string;
1001
1056
  /**
1057
+ * @public
1002
1058
  * <p>The resource name.</p>
1003
1059
  */
1004
1060
  resourceName?: string;
1005
1061
  /**
1062
+ * @public
1006
1063
  * <p>The resource type. </p>
1007
1064
  */
1008
1065
  resourceType?: ResourceType | string;
1009
1066
  /**
1067
+ * @public
1010
1068
  * <p>The timestamp when the operation was initialized (e.g.,
1011
1069
  * <code>1479816991.349</code>).</p>
1012
1070
  */
1013
1071
  createdAt?: Date;
1014
1072
  /**
1073
+ * @public
1015
1074
  * <p>The Amazon Web Services Region and Availability Zone.</p>
1016
1075
  */
1017
1076
  location?: ResourceLocation;
1018
1077
  /**
1078
+ * @public
1019
1079
  * <p>A Boolean value indicating whether the operation is terminal.</p>
1020
1080
  */
1021
1081
  isTerminal?: boolean;
1022
1082
  /**
1083
+ * @public
1023
1084
  * <p>Details about the operation (e.g., <code>Debian-1GB-Ohio-1</code>).</p>
1024
1085
  */
1025
1086
  operationDetails?: string;
1026
1087
  /**
1088
+ * @public
1027
1089
  * <p>The type of operation. </p>
1028
1090
  */
1029
1091
  operationType?: OperationType | string;
1030
1092
  /**
1093
+ * @public
1031
1094
  * <p>The status of the operation. </p>
1032
1095
  */
1033
1096
  status?: OperationStatus | string;
1034
1097
  /**
1098
+ * @public
1035
1099
  * <p>The timestamp when the status was changed (e.g., <code>1479816991.349</code>).</p>
1036
1100
  */
1037
1101
  statusChangedAt?: Date;
1038
1102
  /**
1103
+ * @public
1039
1104
  * <p>The error code.</p>
1040
1105
  */
1041
1106
  errorCode?: string;
1042
1107
  /**
1108
+ * @public
1043
1109
  * <p>The error details.</p>
1044
1110
  */
1045
1111
  errorDetails?: string;
@@ -1049,6 +1115,7 @@ export interface Operation {
1049
1115
  */
1050
1116
  export interface AllocateStaticIpResult {
1051
1117
  /**
1118
+ * @public
1052
1119
  * <p>An array of objects that describe the result of the action, such as the status of the
1053
1120
  * request, the timestamp of the request, and the resources affected by the request.</p>
1054
1121
  */
@@ -1152,12 +1219,14 @@ export type AppCategory = (typeof AppCategory)[keyof typeof AppCategory];
1152
1219
  */
1153
1220
  export interface AttachCertificateToDistributionRequest {
1154
1221
  /**
1222
+ * @public
1155
1223
  * <p>The name of the distribution that the certificate will be attached to.</p>
1156
1224
  * <p>Use the <code>GetDistributions</code> action to get a list of distribution names that you
1157
1225
  * can specify.</p>
1158
1226
  */
1159
1227
  distributionName: string | undefined;
1160
1228
  /**
1229
+ * @public
1161
1230
  * <p>The name of the certificate to attach to a distribution.</p>
1162
1231
  * <p>Only certificates with a status of <code>ISSUED</code> can be attached to a
1163
1232
  * distribution.</p>
@@ -1178,6 +1247,7 @@ export interface AttachCertificateToDistributionRequest {
1178
1247
  */
1179
1248
  export interface AttachCertificateToDistributionResult {
1180
1249
  /**
1250
+ * @public
1181
1251
  * <p>An object that describes the result of the action, such as the status of the request, the
1182
1252
  * timestamp of the request, and the resources affected by the request.</p>
1183
1253
  */
@@ -1188,18 +1258,22 @@ export interface AttachCertificateToDistributionResult {
1188
1258
  */
1189
1259
  export interface AttachDiskRequest {
1190
1260
  /**
1261
+ * @public
1191
1262
  * <p>The unique Lightsail disk name (e.g., <code>my-disk</code>).</p>
1192
1263
  */
1193
1264
  diskName: string | undefined;
1194
1265
  /**
1266
+ * @public
1195
1267
  * <p>The name of the Lightsail instance where you want to utilize the storage disk.</p>
1196
1268
  */
1197
1269
  instanceName: string | undefined;
1198
1270
  /**
1271
+ * @public
1199
1272
  * <p>The disk path to expose to the instance (e.g., <code>/dev/xvdf</code>).</p>
1200
1273
  */
1201
1274
  diskPath: string | undefined;
1202
1275
  /**
1276
+ * @public
1203
1277
  * <p>A Boolean value used to determine the automatic mounting of a storage volume to a virtual
1204
1278
  * computer. The default value is <code>False</code>.</p>
1205
1279
  * <important>
@@ -1213,6 +1287,7 @@ export interface AttachDiskRequest {
1213
1287
  */
1214
1288
  export interface AttachDiskResult {
1215
1289
  /**
1290
+ * @public
1216
1291
  * <p>An array of objects that describe the result of the action, such as the status of the
1217
1292
  * request, the timestamp of the request, and the resources affected by the request.</p>
1218
1293
  */
@@ -1225,10 +1300,12 @@ export interface AttachDiskResult {
1225
1300
  */
1226
1301
  export interface AttachedDisk {
1227
1302
  /**
1303
+ * @public
1228
1304
  * <p>The path of the disk (e.g., <code>/dev/xvdf</code>).</p>
1229
1305
  */
1230
1306
  path?: string;
1231
1307
  /**
1308
+ * @public
1232
1309
  * <p>The size of the disk in GB.</p>
1233
1310
  */
1234
1311
  sizeInGb?: number;
@@ -1239,11 +1316,13 @@ export interface AttachedDisk {
1239
1316
  */
1240
1317
  export interface DiskMap {
1241
1318
  /**
1319
+ * @public
1242
1320
  * <p>The original disk path exposed to the instance (for example,
1243
1321
  * <code>/dev/sdh</code>).</p>
1244
1322
  */
1245
1323
  originalDiskPath?: string;
1246
1324
  /**
1325
+ * @public
1247
1326
  * <p>The new disk name (e.g., <code>my-new-disk</code>).</p>
1248
1327
  */
1249
1328
  newDiskName?: string;
@@ -1253,10 +1332,12 @@ export interface DiskMap {
1253
1332
  */
1254
1333
  export interface AttachInstancesToLoadBalancerRequest {
1255
1334
  /**
1335
+ * @public
1256
1336
  * <p>The name of the load balancer.</p>
1257
1337
  */
1258
1338
  loadBalancerName: string | undefined;
1259
1339
  /**
1340
+ * @public
1260
1341
  * <p>An array of strings representing the instance name(s) you want to attach to your load
1261
1342
  * balancer.</p>
1262
1343
  * <p>An instance must be <code>running</code> before you can attach it to your load
@@ -1272,6 +1353,7 @@ export interface AttachInstancesToLoadBalancerRequest {
1272
1353
  */
1273
1354
  export interface AttachInstancesToLoadBalancerResult {
1274
1355
  /**
1356
+ * @public
1275
1357
  * <p>An array of objects that describe the result of the action, such as the status of the
1276
1358
  * request, the timestamp of the request, and the resources affected by the request.</p>
1277
1359
  */
@@ -1282,11 +1364,13 @@ export interface AttachInstancesToLoadBalancerResult {
1282
1364
  */
1283
1365
  export interface AttachLoadBalancerTlsCertificateRequest {
1284
1366
  /**
1367
+ * @public
1285
1368
  * <p>The name of the load balancer to which you want to associate the SSL/TLS
1286
1369
  * certificate.</p>
1287
1370
  */
1288
1371
  loadBalancerName: string | undefined;
1289
1372
  /**
1373
+ * @public
1290
1374
  * <p>The name of your SSL/TLS certificate.</p>
1291
1375
  */
1292
1376
  certificateName: string | undefined;
@@ -1296,6 +1380,7 @@ export interface AttachLoadBalancerTlsCertificateRequest {
1296
1380
  */
1297
1381
  export interface AttachLoadBalancerTlsCertificateResult {
1298
1382
  /**
1383
+ * @public
1299
1384
  * <p>An array of objects that describe the result of the action, such as the status of the
1300
1385
  * request, the timestamp of the request, and the resources affected by the request.</p>
1301
1386
  * <p>These SSL/TLS certificates are only usable by Lightsail load balancers. You can't get
@@ -1308,10 +1393,12 @@ export interface AttachLoadBalancerTlsCertificateResult {
1308
1393
  */
1309
1394
  export interface AttachStaticIpRequest {
1310
1395
  /**
1396
+ * @public
1311
1397
  * <p>The name of the static IP.</p>
1312
1398
  */
1313
1399
  staticIpName: string | undefined;
1314
1400
  /**
1401
+ * @public
1315
1402
  * <p>The instance name to which you want to attach the static IP address.</p>
1316
1403
  */
1317
1404
  instanceName: string | undefined;
@@ -1321,6 +1408,7 @@ export interface AttachStaticIpRequest {
1321
1408
  */
1322
1409
  export interface AttachStaticIpResult {
1323
1410
  /**
1411
+ * @public
1324
1412
  * <p>An array of objects that describe the result of the action, such as the status of the
1325
1413
  * request, the timestamp of the request, and the resources affected by the request.</p>
1326
1414
  */
@@ -1360,18 +1448,22 @@ export type AutoSnapshotStatus = (typeof AutoSnapshotStatus)[keyof typeof AutoSn
1360
1448
  */
1361
1449
  export interface AutoSnapshotDetails {
1362
1450
  /**
1451
+ * @public
1363
1452
  * <p>The date of the automatic snapshot in <code>YYYY-MM-DD</code> format.</p>
1364
1453
  */
1365
1454
  date?: string;
1366
1455
  /**
1456
+ * @public
1367
1457
  * <p>The timestamp when the automatic snapshot was created.</p>
1368
1458
  */
1369
1459
  createdAt?: Date;
1370
1460
  /**
1461
+ * @public
1371
1462
  * <p>The status of the automatic snapshot.</p>
1372
1463
  */
1373
1464
  status?: AutoSnapshotStatus | string;
1374
1465
  /**
1466
+ * @public
1375
1467
  * <p>An array of objects that describe the block storage disks attached to the instance when
1376
1468
  * the automatic snapshot was created.</p>
1377
1469
  */
@@ -1384,11 +1476,13 @@ export interface AutoSnapshotDetails {
1384
1476
  */
1385
1477
  export interface AvailabilityZone {
1386
1478
  /**
1479
+ * @public
1387
1480
  * <p>The name of the Availability Zone. The format is <code>us-east-2a</code>
1388
1481
  * (case-sensitive).</p>
1389
1482
  */
1390
1483
  zoneName?: string;
1391
1484
  /**
1485
+ * @public
1392
1486
  * <p>The state of the Availability Zone.</p>
1393
1487
  */
1394
1488
  state?: string;
@@ -1435,27 +1529,33 @@ export type BlueprintType = (typeof BlueprintType)[keyof typeof BlueprintType];
1435
1529
  */
1436
1530
  export interface Blueprint {
1437
1531
  /**
1532
+ * @public
1438
1533
  * <p>The ID for the virtual private server image (e.g., <code>app_wordpress_4_4</code> or
1439
1534
  * <code>app_lamp_7_0</code>).</p>
1440
1535
  */
1441
1536
  blueprintId?: string;
1442
1537
  /**
1538
+ * @public
1443
1539
  * <p>The friendly name of the blueprint (e.g., <code>Amazon Linux</code>).</p>
1444
1540
  */
1445
1541
  name?: string;
1446
1542
  /**
1543
+ * @public
1447
1544
  * <p>The group name of the blueprint (e.g., <code>amazon-linux</code>).</p>
1448
1545
  */
1449
1546
  group?: string;
1450
1547
  /**
1548
+ * @public
1451
1549
  * <p>The type of the blueprint (e.g., <code>os</code> or <code>app</code>).</p>
1452
1550
  */
1453
1551
  type?: BlueprintType | string;
1454
1552
  /**
1553
+ * @public
1455
1554
  * <p>The description of the blueprint.</p>
1456
1555
  */
1457
1556
  description?: string;
1458
1557
  /**
1558
+ * @public
1459
1559
  * <p>A Boolean value indicating whether the blueprint is active. Inactive blueprints are listed
1460
1560
  * to support customers with existing instances but are not necessarily available for launch of
1461
1561
  * new instances. Blueprints are marked inactive when they become outdated due to operating
@@ -1463,6 +1563,7 @@ export interface Blueprint {
1463
1563
  */
1464
1564
  isActive?: boolean;
1465
1565
  /**
1566
+ * @public
1466
1567
  * <p>The minimum bundle power required to run this blueprint. For example, you need a bundle
1467
1568
  * with a power value of 500 or more to create an instance that uses a blueprint with a minimum
1468
1569
  * power value of 500. <code>0</code> indicates that the blueprint runs on all instance sizes.
@@ -1470,28 +1571,34 @@ export interface Blueprint {
1470
1571
  */
1471
1572
  minPower?: number;
1472
1573
  /**
1574
+ * @public
1473
1575
  * <p>The version number of the operating system, application, or stack (e.g.,
1474
1576
  * <code>2016.03.0</code>).</p>
1475
1577
  */
1476
1578
  version?: string;
1477
1579
  /**
1580
+ * @public
1478
1581
  * <p>The version code.</p>
1479
1582
  */
1480
1583
  versionCode?: string;
1481
1584
  /**
1585
+ * @public
1482
1586
  * <p>The product URL to learn more about the image or blueprint.</p>
1483
1587
  */
1484
1588
  productUrl?: string;
1485
1589
  /**
1590
+ * @public
1486
1591
  * <p>The end-user license agreement URL for the image or blueprint.</p>
1487
1592
  */
1488
1593
  licenseUrl?: string;
1489
1594
  /**
1595
+ * @public
1490
1596
  * <p>The operating system platform (either Linux/Unix-based or Windows Server-based) of the
1491
1597
  * blueprint.</p>
1492
1598
  */
1493
1599
  platform?: InstancePlatform | string;
1494
1600
  /**
1601
+ * @public
1495
1602
  * <p>Virtual computer blueprints that are supported by Lightsail for Research.</p>
1496
1603
  * <important>
1497
1604
  * <p>This parameter only applies to Lightsail for Research resources.</p>
@@ -1508,11 +1615,13 @@ export interface Blueprint {
1508
1615
  */
1509
1616
  export interface BucketAccessLogConfig {
1510
1617
  /**
1618
+ * @public
1511
1619
  * <p>A Boolean value that indicates whether bucket access logging is enabled for the
1512
1620
  * bucket.</p>
1513
1621
  */
1514
1622
  enabled: boolean | undefined;
1515
1623
  /**
1624
+ * @public
1516
1625
  * <p>The name of the bucket where the access logs are saved. The destination can be a
1517
1626
  * Lightsail bucket in the same account, and in the same Amazon Web Services Region as the
1518
1627
  * source bucket.</p>
@@ -1523,6 +1632,7 @@ export interface BucketAccessLogConfig {
1523
1632
  */
1524
1633
  destination?: string;
1525
1634
  /**
1635
+ * @public
1526
1636
  * <p>The optional object prefix for the bucket access log.</p>
1527
1637
  * <p>The prefix is an optional addition to the object key that organizes your access log files
1528
1638
  * in the destination bucket. For example, if you specify a <code>logs/</code> prefix, then each
@@ -1541,6 +1651,7 @@ export interface BucketAccessLogConfig {
1541
1651
  */
1542
1652
  export interface BucketState {
1543
1653
  /**
1654
+ * @public
1544
1655
  * <p>The state code of the bucket.</p>
1545
1656
  * <p>The following codes are possible:</p>
1546
1657
  * <ul>
@@ -1557,6 +1668,7 @@ export interface BucketState {
1557
1668
  */
1558
1669
  code?: string;
1559
1670
  /**
1671
+ * @public
1560
1672
  * <p>A message that describes the state of the bucket.</p>
1561
1673
  */
1562
1674
  message?: string;
@@ -1568,12 +1680,14 @@ export interface BucketState {
1568
1680
  */
1569
1681
  export interface Tag {
1570
1682
  /**
1683
+ * @public
1571
1684
  * <p>The key of the tag.</p>
1572
1685
  * <p>Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the
1573
1686
  * following characters: + - = . _ : / @</p>
1574
1687
  */
1575
1688
  key?: string;
1576
1689
  /**
1690
+ * @public
1577
1691
  * <p>The value of the tag.</p>
1578
1692
  * <p>Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the
1579
1693
  * following characters: + - = . _ : / @</p>
@@ -1586,18 +1700,22 @@ export interface Tag {
1586
1700
  */
1587
1701
  export interface Bucket {
1588
1702
  /**
1703
+ * @public
1589
1704
  * <p>The Lightsail resource type of the bucket (for example, <code>Bucket</code>).</p>
1590
1705
  */
1591
1706
  resourceType?: string;
1592
1707
  /**
1708
+ * @public
1593
1709
  * <p>An object that describes the access rules of the bucket.</p>
1594
1710
  */
1595
1711
  accessRules?: AccessRules;
1596
1712
  /**
1713
+ * @public
1597
1714
  * <p>The Amazon Resource Name (ARN) of the bucket.</p>
1598
1715
  */
1599
1716
  arn?: string;
1600
1717
  /**
1718
+ * @public
1601
1719
  * <p>The ID of the bundle currently applied to the bucket.</p>
1602
1720
  * <p>A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a
1603
1721
  * bucket.</p>
@@ -1606,34 +1724,41 @@ export interface Bucket {
1606
1724
  */
1607
1725
  bundleId?: string;
1608
1726
  /**
1727
+ * @public
1609
1728
  * <p>The timestamp when the distribution was created.</p>
1610
1729
  */
1611
1730
  createdAt?: Date;
1612
1731
  /**
1732
+ * @public
1613
1733
  * <p>The URL of the bucket.</p>
1614
1734
  */
1615
1735
  url?: string;
1616
1736
  /**
1737
+ * @public
1617
1738
  * <p>An object that describes the location of the bucket, such as the Amazon Web Services Region
1618
1739
  * and Availability Zone.</p>
1619
1740
  */
1620
1741
  location?: ResourceLocation;
1621
1742
  /**
1743
+ * @public
1622
1744
  * <p>The name of the bucket.</p>
1623
1745
  */
1624
1746
  name?: string;
1625
1747
  /**
1748
+ * @public
1626
1749
  * <p>The support code for a bucket. Include this code in your email to support when you have
1627
1750
  * questions about a Lightsail bucket. This code enables our support team to look up your
1628
1751
  * Lightsail information more easily.</p>
1629
1752
  */
1630
1753
  supportCode?: string;
1631
1754
  /**
1755
+ * @public
1632
1756
  * <p>The tag keys and optional values for the bucket. For more information, see <a href="https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags">Tags in
1633
1757
  * Amazon Lightsail</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>
1634
1758
  */
1635
1759
  tags?: Tag[];
1636
1760
  /**
1761
+ * @public
1637
1762
  * <p>Indicates whether object versioning is enabled for the bucket.</p>
1638
1763
  * <p>The following options can be configured:</p>
1639
1764
  * <ul>
@@ -1654,6 +1779,7 @@ export interface Bucket {
1654
1779
  */
1655
1780
  objectVersioning?: string;
1656
1781
  /**
1782
+ * @public
1657
1783
  * <p>Indicates whether the bundle that is currently applied to a bucket can be changed to
1658
1784
  * another bundle.</p>
1659
1785
  * <p>You can update a bucket's bundle only one time within a monthly Amazon Web Services billing
@@ -1663,11 +1789,13 @@ export interface Bucket {
1663
1789
  */
1664
1790
  ableToUpdateBundle?: boolean;
1665
1791
  /**
1792
+ * @public
1666
1793
  * <p>An array of strings that specify the Amazon Web Services account IDs that have read-only
1667
1794
  * access to the bucket.</p>
1668
1795
  */
1669
1796
  readonlyAccessAccounts?: string[];
1670
1797
  /**
1798
+ * @public
1671
1799
  * <p>An array of objects that describe Lightsail instances that have access to the
1672
1800
  * bucket.</p>
1673
1801
  * <p>Use the <a href="https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_SetResourceAccessForBucket.html">SetResourceAccessForBucket</a>
@@ -1675,10 +1803,12 @@ export interface Bucket {
1675
1803
  */
1676
1804
  resourcesReceivingAccess?: ResourceReceivingAccess[];
1677
1805
  /**
1806
+ * @public
1678
1807
  * <p>An object that describes the state of the bucket.</p>
1679
1808
  */
1680
1809
  state?: BucketState;
1681
1810
  /**
1811
+ * @public
1682
1812
  * <p>An object that describes the access log configuration for the bucket.</p>
1683
1813
  */
1684
1814
  accessLogConfig?: BucketAccessLogConfig;
@@ -1692,26 +1822,32 @@ export interface Bucket {
1692
1822
  */
1693
1823
  export interface BucketBundle {
1694
1824
  /**
1825
+ * @public
1695
1826
  * <p>The ID of the bundle.</p>
1696
1827
  */
1697
1828
  bundleId?: string;
1698
1829
  /**
1830
+ * @public
1699
1831
  * <p>The name of the bundle.</p>
1700
1832
  */
1701
1833
  name?: string;
1702
1834
  /**
1835
+ * @public
1703
1836
  * <p>The monthly price of the bundle, in US dollars.</p>
1704
1837
  */
1705
1838
  price?: number;
1706
1839
  /**
1840
+ * @public
1707
1841
  * <p>The storage size of the bundle, in GB.</p>
1708
1842
  */
1709
1843
  storagePerMonthInGb?: number;
1710
1844
  /**
1845
+ * @public
1711
1846
  * <p>The monthly network transfer quota of the bundle.</p>
1712
1847
  */
1713
1848
  transferPerMonthInGb?: number;
1714
1849
  /**
1850
+ * @public
1715
1851
  * <p>Indicates whether the bundle is active. Use for a new or existing bucket.</p>
1716
1852
  */
1717
1853
  isActive?: boolean;
@@ -1735,34 +1871,42 @@ export type BucketMetricName = (typeof BucketMetricName)[keyof typeof BucketMetr
1735
1871
  */
1736
1872
  export interface Bundle {
1737
1873
  /**
1874
+ * @public
1738
1875
  * <p>The price in US dollars (e.g., <code>5.0</code>) of the bundle.</p>
1739
1876
  */
1740
1877
  price?: number;
1741
1878
  /**
1879
+ * @public
1742
1880
  * <p>The number of vCPUs included in the bundle (e.g., <code>2</code>).</p>
1743
1881
  */
1744
1882
  cpuCount?: number;
1745
1883
  /**
1884
+ * @public
1746
1885
  * <p>The size of the SSD (e.g., <code>30</code>).</p>
1747
1886
  */
1748
1887
  diskSizeInGb?: number;
1749
1888
  /**
1889
+ * @public
1750
1890
  * <p>The bundle ID (e.g., <code>micro_1_0</code>).</p>
1751
1891
  */
1752
1892
  bundleId?: string;
1753
1893
  /**
1894
+ * @public
1754
1895
  * <p>The Amazon EC2 instance type (e.g., <code>t2.micro</code>).</p>
1755
1896
  */
1756
1897
  instanceType?: string;
1757
1898
  /**
1899
+ * @public
1758
1900
  * <p>A Boolean value indicating whether the bundle is active.</p>
1759
1901
  */
1760
1902
  isActive?: boolean;
1761
1903
  /**
1904
+ * @public
1762
1905
  * <p>A friendly name for the bundle (e.g., <code>Micro</code>).</p>
1763
1906
  */
1764
1907
  name?: string;
1765
1908
  /**
1909
+ * @public
1766
1910
  * <p>A numeric value that represents the power of the bundle (e.g., <code>500</code>). You can
1767
1911
  * use the bundle's power value in conjunction with a blueprint's minimum power value to
1768
1912
  * determine whether the blueprint will run on the bundle. For example, you need a bundle with a
@@ -1771,14 +1915,17 @@ export interface Bundle {
1771
1915
  */
1772
1916
  power?: number;
1773
1917
  /**
1918
+ * @public
1774
1919
  * <p>The amount of RAM in GB (e.g., <code>2.0</code>).</p>
1775
1920
  */
1776
1921
  ramSizeInGb?: number;
1777
1922
  /**
1923
+ * @public
1778
1924
  * <p>The data transfer rate per month in GB (e.g., <code>2000</code>).</p>
1779
1925
  */
1780
1926
  transferPerMonthInGb?: number;
1781
1927
  /**
1928
+ * @public
1782
1929
  * <p>The operating system platform (Linux/Unix-based or Windows Server-based) that the bundle
1783
1930
  * supports. You can only launch a <code>WINDOWS</code> bundle on a blueprint that supports the
1784
1931
  * <code>WINDOWS</code> platform. <code>LINUX_UNIX</code> blueprints require a
@@ -1786,6 +1933,7 @@ export interface Bundle {
1786
1933
  */
1787
1934
  supportedPlatforms?: (InstancePlatform | string)[];
1788
1935
  /**
1936
+ * @public
1789
1937
  * <p>Virtual computer blueprints that are supported by a Lightsail for Research bundle.</p>
1790
1938
  * <important>
1791
1939
  * <p>This parameter only applies to Lightsail for Research resources.</p>
@@ -1800,6 +1948,7 @@ export interface Bundle {
1800
1948
  */
1801
1949
  export interface CacheBehavior {
1802
1950
  /**
1951
+ * @public
1803
1952
  * <p>The cache behavior of the distribution.</p>
1804
1953
  * <p>The following cache behaviors can be specified:</p>
1805
1954
  * <ul>
@@ -1841,6 +1990,7 @@ export interface CacheBehavior {
1841
1990
  */
1842
1991
  export interface CacheBehaviorPerPath {
1843
1992
  /**
1993
+ * @public
1844
1994
  * <p>The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify
1845
1995
  * wildcard directories (<code>path/to/assets/*</code>), and file types (<code>*.html, *jpg,
1846
1996
  * *js</code>). Directories and file paths are case-sensitive.</p>
@@ -1889,6 +2039,7 @@ export interface CacheBehaviorPerPath {
1889
2039
  */
1890
2040
  path?: string;
1891
2041
  /**
2042
+ * @public
1892
2043
  * <p>The cache behavior for the specified path.</p>
1893
2044
  * <p>You can specify one of the following per-path cache behaviors:</p>
1894
2045
  * <ul>
@@ -1933,12 +2084,14 @@ export type ForwardValues = (typeof ForwardValues)[keyof typeof ForwardValues];
1933
2084
  */
1934
2085
  export interface CookieObject {
1935
2086
  /**
2087
+ * @public
1936
2088
  * <p>Specifies which cookies to forward to the distribution's origin for a cache behavior:
1937
2089
  * <code>all</code>, <code>none</code>, or <code>allow-list</code> to forward only the cookies
1938
2090
  * specified in the <code>cookiesAllowList</code> parameter.</p>
1939
2091
  */
1940
2092
  option?: ForwardValues | string;
1941
2093
  /**
2094
+ * @public
1942
2095
  * <p>The specific cookies to forward to your distribution's origin.</p>
1943
2096
  */
1944
2097
  cookiesAllowList?: string[];
@@ -1982,6 +2135,7 @@ export type HeaderEnum = (typeof HeaderEnum)[keyof typeof HeaderEnum];
1982
2135
  */
1983
2136
  export interface HeaderObject {
1984
2137
  /**
2138
+ * @public
1985
2139
  * <p>The headers that you want your distribution to forward to your origin and base caching
1986
2140
  * on.</p>
1987
2141
  * <p>You can configure your distribution to do one of the following:</p>
@@ -2011,6 +2165,7 @@ export interface HeaderObject {
2011
2165
  */
2012
2166
  option?: ForwardValues | string;
2013
2167
  /**
2168
+ * @public
2014
2169
  * <p>The specific headers to forward to your distribution's origin.</p>
2015
2170
  */
2016
2171
  headersAllowList?: (HeaderEnum | string)[];
@@ -2025,10 +2180,12 @@ export interface HeaderObject {
2025
2180
  */
2026
2181
  export interface QueryStringObject {
2027
2182
  /**
2183
+ * @public
2028
2184
  * <p>Indicates whether the distribution forwards and caches based on query strings.</p>
2029
2185
  */
2030
2186
  option?: boolean;
2031
2187
  /**
2188
+ * @public
2032
2189
  * <p>The specific query strings that the distribution forwards to the origin.</p>
2033
2190
  * <p>Your distribution will cache content based on the specified query strings.</p>
2034
2191
  * <p>If the <code>option</code> parameter is true, then your distribution forwards all query
@@ -2047,6 +2204,7 @@ export interface QueryStringObject {
2047
2204
  */
2048
2205
  export interface CacheSettings {
2049
2206
  /**
2207
+ * @public
2050
2208
  * <p>The default amount of time that objects stay in the distribution's cache before the
2051
2209
  * distribution forwards another request to the origin to determine whether the content has been
2052
2210
  * updated.</p>
@@ -2058,6 +2216,7 @@ export interface CacheSettings {
2058
2216
  */
2059
2217
  defaultTTL?: number;
2060
2218
  /**
2219
+ * @public
2061
2220
  * <p>The minimum amount of time that objects stay in the distribution's cache before the
2062
2221
  * distribution forwards another request to the origin to determine whether the object has been
2063
2222
  * updated.</p>
@@ -2066,6 +2225,7 @@ export interface CacheSettings {
2066
2225
  */
2067
2226
  minimumTTL?: number;
2068
2227
  /**
2228
+ * @public
2069
2229
  * <p>The maximum amount of time that objects stay in the distribution's cache before the
2070
2230
  * distribution forwards another request to the origin to determine whether the object has been
2071
2231
  * updated.</p>
@@ -2075,6 +2235,7 @@ export interface CacheSettings {
2075
2235
  */
2076
2236
  maximumTTL?: number;
2077
2237
  /**
2238
+ * @public
2078
2239
  * <p>The HTTP methods that are processed and forwarded to the distribution's origin.</p>
2079
2240
  * <p>You can specify the following options:</p>
2080
2241
  * <ul>
@@ -2101,6 +2262,7 @@ export interface CacheSettings {
2101
2262
  */
2102
2263
  allowedHTTPMethods?: string;
2103
2264
  /**
2265
+ * @public
2104
2266
  * <p>The HTTP method responses that are cached by your distribution.</p>
2105
2267
  * <p>You can specify the following options:</p>
2106
2268
  * <ul>
@@ -2118,16 +2280,19 @@ export interface CacheSettings {
2118
2280
  */
2119
2281
  cachedHTTPMethods?: string;
2120
2282
  /**
2283
+ * @public
2121
2284
  * <p>An object that describes the cookies that are forwarded to the origin. Your content is
2122
2285
  * cached based on the cookies that are forwarded.</p>
2123
2286
  */
2124
2287
  forwardedCookies?: CookieObject;
2125
2288
  /**
2289
+ * @public
2126
2290
  * <p>An object that describes the headers that are forwarded to the origin. Your content is
2127
2291
  * cached based on the headers that are forwarded.</p>
2128
2292
  */
2129
2293
  forwardedHeaders?: HeaderObject;
2130
2294
  /**
2295
+ * @public
2131
2296
  * <p>An object that describes the query strings that are forwarded to the origin. Your content
2132
2297
  * is cached based on the query strings that are forwarded.</p>
2133
2298
  */
@@ -2162,6 +2327,7 @@ export type DnsRecordCreationStateCode = (typeof DnsRecordCreationStateCode)[key
2162
2327
  */
2163
2328
  export interface DnsRecordCreationState {
2164
2329
  /**
2330
+ * @public
2165
2331
  * <p>The status code for the automated DNS record creation.</p>
2166
2332
  * <p>Following are the possible values:</p>
2167
2333
  * <ul>
@@ -2182,6 +2348,7 @@ export interface DnsRecordCreationState {
2182
2348
  */
2183
2349
  code?: DnsRecordCreationStateCode | string;
2184
2350
  /**
2351
+ * @public
2185
2352
  * <p>The message that describes the reason for the status code.</p>
2186
2353
  */
2187
2354
  message?: string;
@@ -2193,14 +2360,17 @@ export interface DnsRecordCreationState {
2193
2360
  */
2194
2361
  export interface ResourceRecord {
2195
2362
  /**
2363
+ * @public
2196
2364
  * <p>The name of the record.</p>
2197
2365
  */
2198
2366
  name?: string;
2199
2367
  /**
2368
+ * @public
2200
2369
  * <p>The DNS record type.</p>
2201
2370
  */
2202
2371
  type?: string;
2203
2372
  /**
2373
+ * @public
2204
2374
  * <p>The value for the DNS record.</p>
2205
2375
  */
2206
2376
  value?: string;
@@ -2225,22 +2395,26 @@ export type CertificateDomainValidationStatus = (typeof CertificateDomainValidat
2225
2395
  */
2226
2396
  export interface DomainValidationRecord {
2227
2397
  /**
2398
+ * @public
2228
2399
  * <p>The domain name of the certificate validation record. For example,
2229
2400
  * <code>example.com</code> or <code>www.example.com</code>.</p>
2230
2401
  */
2231
2402
  domainName?: string;
2232
2403
  /**
2404
+ * @public
2233
2405
  * <p>An object that describes the DNS records to add to your domain's DNS to validate it for
2234
2406
  * the certificate.</p>
2235
2407
  */
2236
2408
  resourceRecord?: ResourceRecord;
2237
2409
  /**
2410
+ * @public
2238
2411
  * <p>An object that describes the state of the canonical name (CNAME) records that are
2239
2412
  * automatically added by Lightsail to the DNS of the domain to validate domain
2240
2413
  * ownership.</p>
2241
2414
  */
2242
2415
  dnsRecordCreationState?: DnsRecordCreationState;
2243
2416
  /**
2417
+ * @public
2244
2418
  * <p>The validation status of the record.</p>
2245
2419
  */
2246
2420
  validationStatus?: CertificateDomainValidationStatus | string;
@@ -2265,10 +2439,12 @@ export type RenewalStatus = (typeof RenewalStatus)[keyof typeof RenewalStatus];
2265
2439
  */
2266
2440
  export interface RenewalSummary {
2267
2441
  /**
2442
+ * @public
2268
2443
  * <p>An array of objects that describe the domain validation records of the certificate.</p>
2269
2444
  */
2270
2445
  domainValidationRecords?: DomainValidationRecord[];
2271
2446
  /**
2447
+ * @public
2272
2448
  * <p>The renewal status of the certificate.</p>
2273
2449
  * <p>The following renewal status are possible:</p>
2274
2450
  * <ul>
@@ -2311,10 +2487,12 @@ export interface RenewalSummary {
2311
2487
  */
2312
2488
  renewalStatus?: RenewalStatus | string;
2313
2489
  /**
2490
+ * @public
2314
2491
  * <p>The reason for the renewal status of the certificate.</p>
2315
2492
  */
2316
2493
  renewalStatusReason?: string;
2317
2494
  /**
2495
+ * @public
2318
2496
  * <p>The timestamp when the certificate was last updated.</p>
2319
2497
  */
2320
2498
  updatedAt?: Date;
@@ -2347,35 +2525,43 @@ export type CertificateStatus = (typeof CertificateStatus)[keyof typeof Certific
2347
2525
  */
2348
2526
  export interface Certificate {
2349
2527
  /**
2528
+ * @public
2350
2529
  * <p>The Amazon Resource Name (ARN) of the certificate.</p>
2351
2530
  */
2352
2531
  arn?: string;
2353
2532
  /**
2533
+ * @public
2354
2534
  * <p>The name of the certificate (e.g., <code>my-certificate</code>).</p>
2355
2535
  */
2356
2536
  name?: string;
2357
2537
  /**
2538
+ * @public
2358
2539
  * <p>The domain name of the certificate.</p>
2359
2540
  */
2360
2541
  domainName?: string;
2361
2542
  /**
2543
+ * @public
2362
2544
  * <p>The validation status of the certificate.</p>
2363
2545
  */
2364
2546
  status?: CertificateStatus | string;
2365
2547
  /**
2548
+ * @public
2366
2549
  * <p>The serial number of the certificate.</p>
2367
2550
  */
2368
2551
  serialNumber?: string;
2369
2552
  /**
2553
+ * @public
2370
2554
  * <p>An array of strings that specify the alternate domains (e.g., <code>example2.com</code>)
2371
2555
  * and subdomains (e.g., <code>blog.example.com</code>) of the certificate.</p>
2372
2556
  */
2373
2557
  subjectAlternativeNames?: string[];
2374
2558
  /**
2559
+ * @public
2375
2560
  * <p>An array of objects that describe the domain validation records of the certificate.</p>
2376
2561
  */
2377
2562
  domainValidationRecords?: DomainValidationRecord[];
2378
2563
  /**
2564
+ * @public
2379
2565
  * <p>The validation failure reason, if any, of the certificate.</p>
2380
2566
  * <p>The following failure reasons are possible:</p>
2381
2567
  * <ul>
@@ -2442,59 +2628,72 @@ export interface Certificate {
2442
2628
  */
2443
2629
  requestFailureReason?: string;
2444
2630
  /**
2631
+ * @public
2445
2632
  * <p>The number of Lightsail resources that the certificate is attached to.</p>
2446
2633
  */
2447
2634
  inUseResourceCount?: number;
2448
2635
  /**
2636
+ * @public
2449
2637
  * <p>The algorithm used to generate the key pair (the public and private key) of the
2450
2638
  * certificate.</p>
2451
2639
  */
2452
2640
  keyAlgorithm?: string;
2453
2641
  /**
2642
+ * @public
2454
2643
  * <p>The timestamp when the certificate was created.</p>
2455
2644
  */
2456
2645
  createdAt?: Date;
2457
2646
  /**
2647
+ * @public
2458
2648
  * <p>The timestamp when the certificate was issued.</p>
2459
2649
  */
2460
2650
  issuedAt?: Date;
2461
2651
  /**
2652
+ * @public
2462
2653
  * <p>The certificate authority that issued the certificate.</p>
2463
2654
  */
2464
2655
  issuerCA?: string;
2465
2656
  /**
2657
+ * @public
2466
2658
  * <p>The timestamp when the certificate is first valid.</p>
2467
2659
  */
2468
2660
  notBefore?: Date;
2469
2661
  /**
2662
+ * @public
2470
2663
  * <p>The timestamp when the certificate expires.</p>
2471
2664
  */
2472
2665
  notAfter?: Date;
2473
2666
  /**
2667
+ * @public
2474
2668
  * <p>The renewal eligibility of the certificate.</p>
2475
2669
  */
2476
2670
  eligibleToRenew?: string;
2477
2671
  /**
2672
+ * @public
2478
2673
  * <p>An object that describes the status of the certificate renewal managed by
2479
2674
  * Lightsail.</p>
2480
2675
  */
2481
2676
  renewalSummary?: RenewalSummary;
2482
2677
  /**
2678
+ * @public
2483
2679
  * <p>The timestamp when the certificate was revoked. This value is present only when the
2484
2680
  * certificate status is <code>REVOKED</code>.</p>
2485
2681
  */
2486
2682
  revokedAt?: Date;
2487
2683
  /**
2684
+ * @public
2488
2685
  * <p>The reason the certificate was revoked. This value is present only when the certificate
2489
2686
  * status is <code>REVOKED</code>.</p>
2490
2687
  */
2491
2688
  revocationReason?: string;
2492
2689
  /**
2690
+ * @public
2493
2691
  * <p>The tag keys and optional values for the resource. For more information about tags in
2494
2692
  * Lightsail, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags">Amazon Lightsail Developer Guide</a>.</p>
2495
2693
  */
2496
2694
  tags?: Tag[];
2497
2695
  /**
2696
+ * @public
2498
2697
  * <p>The support code. Include this code in your email to support when you have questions about
2499
2698
  * your Lightsail certificate. This code enables our support team to look up your Lightsail
2500
2699
  * information more easily.</p>
@@ -2507,22 +2706,27 @@ export interface Certificate {
2507
2706
  */
2508
2707
  export interface CertificateSummary {
2509
2708
  /**
2709
+ * @public
2510
2710
  * <p>The Amazon Resource Name (ARN) of the certificate.</p>
2511
2711
  */
2512
2712
  certificateArn?: string;
2513
2713
  /**
2714
+ * @public
2514
2715
  * <p>The name of the certificate.</p>
2515
2716
  */
2516
2717
  certificateName?: string;
2517
2718
  /**
2719
+ * @public
2518
2720
  * <p>The domain name of the certificate.</p>
2519
2721
  */
2520
2722
  domainName?: string;
2521
2723
  /**
2724
+ * @public
2522
2725
  * <p>An object that describes a certificate in detail.</p>
2523
2726
  */
2524
2727
  certificateDetail?: Certificate;
2525
2728
  /**
2729
+ * @public
2526
2730
  * <p>The tag keys and optional values for the resource. For more information about tags in
2527
2731
  * Lightsail, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags">Amazon Lightsail Developer Guide</a>.</p>
2528
2732
  */
@@ -2549,6 +2753,7 @@ export type NetworkProtocol = (typeof NetworkProtocol)[keyof typeof NetworkProto
2549
2753
  */
2550
2754
  export interface PortInfo {
2551
2755
  /**
2756
+ * @public
2552
2757
  * <p>The first port in a range of open ports on an instance.</p>
2553
2758
  * <p>Allowed ports:</p>
2554
2759
  * <ul>
@@ -2571,6 +2776,7 @@ export interface PortInfo {
2571
2776
  */
2572
2777
  fromPort?: number;
2573
2778
  /**
2779
+ * @public
2574
2780
  * <p>The last port in a range of open ports on an instance.</p>
2575
2781
  * <p>Allowed ports:</p>
2576
2782
  * <ul>
@@ -2593,6 +2799,7 @@ export interface PortInfo {
2593
2799
  */
2594
2800
  toPort?: number;
2595
2801
  /**
2802
+ * @public
2596
2803
  * <p>The IP protocol name.</p>
2597
2804
  * <p>The name can be one of the following:</p>
2598
2805
  * <ul>
@@ -2631,6 +2838,7 @@ export interface PortInfo {
2631
2838
  */
2632
2839
  protocol?: NetworkProtocol | string;
2633
2840
  /**
2841
+ * @public
2634
2842
  * <p>The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to
2635
2843
  * connect to an instance through the ports, and the protocol.</p>
2636
2844
  * <note>
@@ -2653,6 +2861,7 @@ export interface PortInfo {
2653
2861
  */
2654
2862
  cidrs?: string[];
2655
2863
  /**
2864
+ * @public
2656
2865
  * <p>The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to
2657
2866
  * connect to an instance through the ports, and the protocol. Only devices with an IPv6 address
2658
2867
  * can connect to an instance through IPv6; otherwise, IPv4 should be used.</p>
@@ -2665,6 +2874,7 @@ export interface PortInfo {
2665
2874
  */
2666
2875
  ipv6Cidrs?: string[];
2667
2876
  /**
2877
+ * @public
2668
2878
  * <p>An alias that defines access for a preconfigured range of IP addresses.</p>
2669
2879
  * <p>The only alias currently supported is <code>lightsail-connect</code>, which allows IP
2670
2880
  * addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your
@@ -2677,10 +2887,12 @@ export interface PortInfo {
2677
2887
  */
2678
2888
  export interface CloseInstancePublicPortsRequest {
2679
2889
  /**
2890
+ * @public
2680
2891
  * <p>An object to describe the ports to close for the specified instance.</p>
2681
2892
  */
2682
2893
  portInfo: PortInfo | undefined;
2683
2894
  /**
2895
+ * @public
2684
2896
  * <p>The name of the instance for which to close ports.</p>
2685
2897
  */
2686
2898
  instanceName: string | undefined;
@@ -2690,6 +2902,7 @@ export interface CloseInstancePublicPortsRequest {
2690
2902
  */
2691
2903
  export interface CloseInstancePublicPortsResult {
2692
2904
  /**
2905
+ * @public
2693
2906
  * <p>An object that describes the result of the action, such as the status of the request, the
2694
2907
  * timestamp of the request, and the resources affected by the request.</p>
2695
2908
  */
@@ -2701,10 +2914,12 @@ export interface CloseInstancePublicPortsResult {
2701
2914
  */
2702
2915
  export interface DestinationInfo {
2703
2916
  /**
2917
+ * @public
2704
2918
  * <p>The ID of the resource created at the destination.</p>
2705
2919
  */
2706
2920
  id?: string;
2707
2921
  /**
2922
+ * @public
2708
2923
  * <p>The destination service of the record.</p>
2709
2924
  */
2710
2925
  service?: string;
@@ -2727,14 +2942,17 @@ export type CloudFormationStackRecordSourceType = (typeof CloudFormationStackRec
2727
2942
  */
2728
2943
  export interface CloudFormationStackRecordSourceInfo {
2729
2944
  /**
2945
+ * @public
2730
2946
  * <p>The Lightsail resource type (e.g., <code>ExportSnapshotRecord</code>).</p>
2731
2947
  */
2732
2948
  resourceType?: CloudFormationStackRecordSourceType | string;
2733
2949
  /**
2950
+ * @public
2734
2951
  * <p>The name of the record.</p>
2735
2952
  */
2736
2953
  name?: string;
2737
2954
  /**
2955
+ * @public
2738
2956
  * <p>The Amazon Resource Name (ARN) of the export snapshot record.</p>
2739
2957
  */
2740
2958
  arn?: string;
@@ -2761,36 +2979,44 @@ export type RecordState = (typeof RecordState)[keyof typeof RecordState];
2761
2979
  */
2762
2980
  export interface CloudFormationStackRecord {
2763
2981
  /**
2982
+ * @public
2764
2983
  * <p>The name of the CloudFormation stack record. It starts with
2765
2984
  * <code>CloudFormationStackRecord</code> followed by a GUID.</p>
2766
2985
  */
2767
2986
  name?: string;
2768
2987
  /**
2988
+ * @public
2769
2989
  * <p>The Amazon Resource Name (ARN) of the CloudFormation stack record.</p>
2770
2990
  */
2771
2991
  arn?: string;
2772
2992
  /**
2993
+ * @public
2773
2994
  * <p>The date when the CloudFormation stack record was created.</p>
2774
2995
  */
2775
2996
  createdAt?: Date;
2776
2997
  /**
2998
+ * @public
2777
2999
  * <p>A list of objects describing the Availability Zone and Amazon Web Services Region of the
2778
3000
  * CloudFormation stack record.</p>
2779
3001
  */
2780
3002
  location?: ResourceLocation;
2781
3003
  /**
3004
+ * @public
2782
3005
  * <p>The Lightsail resource type (e.g., <code>CloudFormationStackRecord</code>).</p>
2783
3006
  */
2784
3007
  resourceType?: ResourceType | string;
2785
3008
  /**
3009
+ * @public
2786
3010
  * <p>The current state of the CloudFormation stack record.</p>
2787
3011
  */
2788
3012
  state?: RecordState | string;
2789
3013
  /**
3014
+ * @public
2790
3015
  * <p>A list of objects describing the source of the CloudFormation stack record.</p>
2791
3016
  */
2792
3017
  sourceInfo?: CloudFormationStackRecordSourceInfo[];
2793
3018
  /**
3019
+ * @public
2794
3020
  * <p>A list of objects describing the destination service, which is AWS CloudFormation, and the Amazon
2795
3021
  * Resource Name (ARN) of the AWS CloudFormation stack.</p>
2796
3022
  */
@@ -2816,11 +3042,13 @@ export type ContactMethodStatus = (typeof ContactMethodStatus)[keyof typeof Cont
2816
3042
  */
2817
3043
  export interface ContactMethod {
2818
3044
  /**
3045
+ * @public
2819
3046
  * <p>The destination of the contact method, such as an email address or a mobile phone
2820
3047
  * number.</p>
2821
3048
  */
2822
3049
  contactEndpoint?: string;
2823
3050
  /**
3051
+ * @public
2824
3052
  * <p>The current status of the contact method.</p>
2825
3053
  * <p>A contact method has the following possible status:</p>
2826
3054
  * <ul>
@@ -2842,30 +3070,37 @@ export interface ContactMethod {
2842
3070
  */
2843
3071
  status?: ContactMethodStatus | string;
2844
3072
  /**
3073
+ * @public
2845
3074
  * <p>The protocol of the contact method, such as email or SMS (text messaging).</p>
2846
3075
  */
2847
3076
  protocol?: ContactProtocol | string;
2848
3077
  /**
3078
+ * @public
2849
3079
  * <p>The name of the contact method.</p>
2850
3080
  */
2851
3081
  name?: string;
2852
3082
  /**
3083
+ * @public
2853
3084
  * <p>The Amazon Resource Name (ARN) of the contact method.</p>
2854
3085
  */
2855
3086
  arn?: string;
2856
3087
  /**
3088
+ * @public
2857
3089
  * <p>The timestamp when the contact method was created.</p>
2858
3090
  */
2859
3091
  createdAt?: Date;
2860
3092
  /**
3093
+ * @public
2861
3094
  * <p>An object that describes the location of the contact method, such as the Amazon Web Services Region and Availability Zone.</p>
2862
3095
  */
2863
3096
  location?: ResourceLocation;
2864
3097
  /**
3098
+ * @public
2865
3099
  * <p>The Lightsail resource type (e.g., <code>ContactMethod</code>).</p>
2866
3100
  */
2867
3101
  resourceType?: ResourceType | string;
2868
3102
  /**
3103
+ * @public
2869
3104
  * <p>The support code. Include this code in your email to support when you have questions about
2870
3105
  * your Lightsail contact method. This code enables our support team to look up your
2871
3106
  * Lightsail information more easily.</p>
@@ -2904,6 +3139,7 @@ export type ContainerServiceProtocol = (typeof ContainerServiceProtocol)[keyof t
2904
3139
  */
2905
3140
  export interface Container {
2906
3141
  /**
3142
+ * @public
2907
3143
  * <p>The name of the image used for the container.</p>
2908
3144
  * <p>Container images sourced from your Lightsail container service, that are registered and
2909
3145
  * stored on your service, start with a colon (<code>:</code>). For example, if your container
@@ -2919,14 +3155,17 @@ export interface Container {
2919
3155
  */
2920
3156
  image?: string;
2921
3157
  /**
3158
+ * @public
2922
3159
  * <p>The launch command for the container.</p>
2923
3160
  */
2924
3161
  command?: string[];
2925
3162
  /**
3163
+ * @public
2926
3164
  * <p>The environment variables of the container.</p>
2927
3165
  */
2928
3166
  environment?: Record<string, string>;
2929
3167
  /**
3168
+ * @public
2930
3169
  * <p>The open firewall ports of the container.</p>
2931
3170
  */
2932
3171
  ports?: Record<string, ContainerServiceProtocol | string>;
@@ -2938,14 +3177,17 @@ export interface Container {
2938
3177
  */
2939
3178
  export interface ContainerImage {
2940
3179
  /**
3180
+ * @public
2941
3181
  * <p>The name of the container image.</p>
2942
3182
  */
2943
3183
  image?: string;
2944
3184
  /**
3185
+ * @public
2945
3186
  * <p>The digest of the container image.</p>
2946
3187
  */
2947
3188
  digest?: string;
2948
3189
  /**
3190
+ * @public
2949
3191
  * <p>The timestamp when the container image was created.</p>
2950
3192
  */
2951
3193
  createdAt?: Date;
@@ -2956,31 +3198,37 @@ export interface ContainerImage {
2956
3198
  */
2957
3199
  export interface ContainerServiceHealthCheckConfig {
2958
3200
  /**
3201
+ * @public
2959
3202
  * <p>The number of consecutive health checks successes required before moving the container to
2960
3203
  * the <code>Healthy</code> state. The default value is <code>2</code>.</p>
2961
3204
  */
2962
3205
  healthyThreshold?: number;
2963
3206
  /**
3207
+ * @public
2964
3208
  * <p>The number of consecutive health check failures required before moving the container to
2965
3209
  * the <code>Unhealthy</code> state. The default value is <code>2</code>.</p>
2966
3210
  */
2967
3211
  unhealthyThreshold?: number;
2968
3212
  /**
3213
+ * @public
2969
3214
  * <p>The amount of time, in seconds, during which no response means a failed health check. You
2970
3215
  * can specify between 2 and 60 seconds. The default value is <code>2</code>.</p>
2971
3216
  */
2972
3217
  timeoutSeconds?: number;
2973
3218
  /**
3219
+ * @public
2974
3220
  * <p>The approximate interval, in seconds, between health checks of an individual container.
2975
3221
  * You can specify between 5 and 300 seconds. The default value is <code>5</code>.</p>
2976
3222
  */
2977
3223
  intervalSeconds?: number;
2978
3224
  /**
3225
+ * @public
2979
3226
  * <p>The path on the container on which to perform the health check. The default value is
2980
3227
  * <code>/</code>.</p>
2981
3228
  */
2982
3229
  path?: string;
2983
3230
  /**
3231
+ * @public
2984
3232
  * <p>The HTTP codes to use when checking for a successful response from a container. You can
2985
3233
  * specify values between <code>200</code> and <code>499</code>. You can specify multiple values
2986
3234
  * (for example, <code>200,202</code>) or a range of values (for example,
@@ -2995,15 +3243,18 @@ export interface ContainerServiceHealthCheckConfig {
2995
3243
  */
2996
3244
  export interface ContainerServiceEndpoint {
2997
3245
  /**
3246
+ * @public
2998
3247
  * <p>The name of the container entry of the deployment that the endpoint configuration applies
2999
3248
  * to.</p>
3000
3249
  */
3001
3250
  containerName?: string;
3002
3251
  /**
3252
+ * @public
3003
3253
  * <p>The port of the specified container to which traffic is forwarded to.</p>
3004
3254
  */
3005
3255
  containerPort?: number;
3006
3256
  /**
3257
+ * @public
3007
3258
  * <p>An object that describes the health check configuration of the container.</p>
3008
3259
  */
3009
3260
  healthCheck?: ContainerServiceHealthCheckConfig;
@@ -3031,10 +3282,12 @@ export type ContainerServiceDeploymentState = (typeof ContainerServiceDeployment
3031
3282
  */
3032
3283
  export interface ContainerServiceDeployment {
3033
3284
  /**
3285
+ * @public
3034
3286
  * <p>The version number of the deployment.</p>
3035
3287
  */
3036
3288
  version?: number;
3037
3289
  /**
3290
+ * @public
3038
3291
  * <p>The state of the deployment.</p>
3039
3292
  * <p>A deployment can be in one of the following states:</p>
3040
3293
  * <ul>
@@ -3063,14 +3316,17 @@ export interface ContainerServiceDeployment {
3063
3316
  */
3064
3317
  state?: ContainerServiceDeploymentState | string;
3065
3318
  /**
3319
+ * @public
3066
3320
  * <p>An object that describes the configuration for the containers of the deployment.</p>
3067
3321
  */
3068
3322
  containers?: Record<string, Container>;
3069
3323
  /**
3324
+ * @public
3070
3325
  * <p>An object that describes the endpoint of the deployment.</p>
3071
3326
  */
3072
3327
  publicEndpoint?: ContainerServiceEndpoint;
3073
3328
  /**
3329
+ * @public
3074
3330
  * <p>The timestamp when the deployment was created.</p>
3075
3331
  */
3076
3332
  createdAt?: Date;
@@ -3103,10 +3359,12 @@ export type ContainerServicePowerName = (typeof ContainerServicePowerName)[keyof
3103
3359
  */
3104
3360
  export interface ContainerServiceECRImagePullerRole {
3105
3361
  /**
3362
+ * @public
3106
3363
  * <p>A Boolean value that indicates whether the role is activated.</p>
3107
3364
  */
3108
3365
  isActive?: boolean;
3109
3366
  /**
3367
+ * @public
3110
3368
  * <p>The Amazon Resource Name (ARN) of the role, if it is activated.</p>
3111
3369
  */
3112
3370
  principalArn?: string;
@@ -3119,6 +3377,7 @@ export interface ContainerServiceECRImagePullerRole {
3119
3377
  */
3120
3378
  export interface PrivateRegistryAccess {
3121
3379
  /**
3380
+ * @public
3122
3381
  * <p>An object that describes the activation status of the role that you can use to grant a
3123
3382
  * Lightsail container service access to Amazon ECR private
3124
3383
  * repositories. If the role is activated, the Amazon Resource Name (ARN) of the role is also
@@ -3168,6 +3427,7 @@ export type ContainerServiceStateDetailCode = (typeof ContainerServiceStateDetai
3168
3427
  */
3169
3428
  export interface ContainerServiceStateDetail {
3170
3429
  /**
3430
+ * @public
3171
3431
  * <p>The state code of the container service.</p>
3172
3432
  * <p>The following state codes are possible:</p>
3173
3433
  * <ul>
@@ -3232,6 +3492,7 @@ export interface ContainerServiceStateDetail {
3232
3492
  */
3233
3493
  code?: ContainerServiceStateDetailCode | string;
3234
3494
  /**
3495
+ * @public
3235
3496
  * <p>A message that provides more information for the state code.</p>
3236
3497
  * <note>
3237
3498
  * <p>The state detail is populated only when a container service is in a
@@ -3246,42 +3507,51 @@ export interface ContainerServiceStateDetail {
3246
3507
  */
3247
3508
  export interface ContainerService {
3248
3509
  /**
3510
+ * @public
3249
3511
  * <p>The name of the container service.</p>
3250
3512
  */
3251
3513
  containerServiceName?: string;
3252
3514
  /**
3515
+ * @public
3253
3516
  * <p>The Amazon Resource Name (ARN) of the container service.</p>
3254
3517
  */
3255
3518
  arn?: string;
3256
3519
  /**
3520
+ * @public
3257
3521
  * <p>The timestamp when the container service was created.</p>
3258
3522
  */
3259
3523
  createdAt?: Date;
3260
3524
  /**
3525
+ * @public
3261
3526
  * <p>An object that describes the location of the container service, such as the Amazon Web Services Region and Availability Zone.</p>
3262
3527
  */
3263
3528
  location?: ResourceLocation;
3264
3529
  /**
3530
+ * @public
3265
3531
  * <p>The Lightsail resource type of the container service (i.e.,
3266
3532
  * <code>ContainerService</code>).</p>
3267
3533
  */
3268
3534
  resourceType?: ResourceType | string;
3269
3535
  /**
3536
+ * @public
3270
3537
  * <p>The tag keys and optional values for the resource. For more information about tags in
3271
3538
  * Lightsail, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags">Amazon Lightsail Developer Guide</a>.</p>
3272
3539
  */
3273
3540
  tags?: Tag[];
3274
3541
  /**
3542
+ * @public
3275
3543
  * <p>The power specification of the container service.</p>
3276
3544
  * <p>The power specifies the amount of RAM, the number of vCPUs, and the base price of the
3277
3545
  * container service.</p>
3278
3546
  */
3279
3547
  power?: ContainerServicePowerName | string;
3280
3548
  /**
3549
+ * @public
3281
3550
  * <p>The ID of the power of the container service.</p>
3282
3551
  */
3283
3552
  powerId?: string;
3284
3553
  /**
3554
+ * @public
3285
3555
  * <p>The current state of the container service.</p>
3286
3556
  * <p>The following container service states are possible:</p>
3287
3557
  * <ul>
@@ -3322,6 +3592,7 @@ export interface ContainerService {
3322
3592
  */
3323
3593
  state?: ContainerServiceState | string;
3324
3594
  /**
3595
+ * @public
3325
3596
  * <p>An object that describes the current state of the container service.</p>
3326
3597
  * <note>
3327
3598
  * <p>The state detail is populated only when a container service is in a
@@ -3330,37 +3601,44 @@ export interface ContainerService {
3330
3601
  */
3331
3602
  stateDetail?: ContainerServiceStateDetail;
3332
3603
  /**
3604
+ * @public
3333
3605
  * <p>The scale specification of the container service.</p>
3334
3606
  * <p>The scale specifies the allocated compute nodes of the container service.</p>
3335
3607
  */
3336
3608
  scale?: number;
3337
3609
  /**
3610
+ * @public
3338
3611
  * <p>An object that describes the current container deployment of the container service.</p>
3339
3612
  */
3340
3613
  currentDeployment?: ContainerServiceDeployment;
3341
3614
  /**
3615
+ * @public
3342
3616
  * <p>An object that describes the next deployment of the container service.</p>
3343
3617
  * <p>This value is <code>null</code> when there is no deployment in a <code>pending</code>
3344
3618
  * state.</p>
3345
3619
  */
3346
3620
  nextDeployment?: ContainerServiceDeployment;
3347
3621
  /**
3622
+ * @public
3348
3623
  * <p>A Boolean value indicating whether the container service is disabled.</p>
3349
3624
  */
3350
3625
  isDisabled?: boolean;
3351
3626
  /**
3627
+ * @public
3352
3628
  * <p>The principal ARN of the container service.</p>
3353
3629
  * <p>The principal ARN can be used to create a trust relationship between your standard Amazon Web Services account and your Lightsail container service. This allows you to give your
3354
3630
  * service permission to access resources in your standard Amazon Web Services account.</p>
3355
3631
  */
3356
3632
  principalArn?: string;
3357
3633
  /**
3634
+ * @public
3358
3635
  * <p>The private domain name of the container service.</p>
3359
3636
  * <p>The private domain name is accessible only by other resources within the default virtual
3360
3637
  * private cloud (VPC) of your Lightsail account.</p>
3361
3638
  */
3362
3639
  privateDomainName?: string;
3363
3640
  /**
3641
+ * @public
3364
3642
  * <p>The public domain name of the container service, such as <code>example.com</code> and
3365
3643
  * <code>www.example.com</code>.</p>
3366
3644
  * <p>You can specify up to four public domain names for a container service. The domain names
@@ -3379,12 +3657,14 @@ export interface ContainerService {
3379
3657
  */
3380
3658
  publicDomainNames?: Record<string, string[]>;
3381
3659
  /**
3660
+ * @public
3382
3661
  * <p>The publicly accessible URL of the container service.</p>
3383
3662
  * <p>If no public endpoint is specified in the <code>currentDeployment</code>, this URL returns
3384
3663
  * a 404 response.</p>
3385
3664
  */
3386
3665
  url?: string;
3387
3666
  /**
3667
+ * @public
3388
3668
  * <p>An object that describes the configuration for the container service to access private
3389
3669
  * container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private
3390
3670
  * repositories.</p>
@@ -3399,14 +3679,17 @@ export interface ContainerService {
3399
3679
  */
3400
3680
  export interface EndpointRequest {
3401
3681
  /**
3682
+ * @public
3402
3683
  * <p>The name of the container for the endpoint.</p>
3403
3684
  */
3404
3685
  containerName: string | undefined;
3405
3686
  /**
3687
+ * @public
3406
3688
  * <p>The port of the container to which traffic is forwarded to.</p>
3407
3689
  */
3408
3690
  containerPort: number | undefined;
3409
3691
  /**
3692
+ * @public
3410
3693
  * <p>An object that describes the health check configuration of the container.</p>
3411
3694
  */
3412
3695
  healthCheck?: ContainerServiceHealthCheckConfig;
@@ -3420,10 +3703,12 @@ export interface EndpointRequest {
3420
3703
  */
3421
3704
  export interface ContainerServiceDeploymentRequest {
3422
3705
  /**
3706
+ * @public
3423
3707
  * <p>An object that describes the configuration for the containers of the deployment.</p>
3424
3708
  */
3425
3709
  containers?: Record<string, Container>;
3426
3710
  /**
3711
+ * @public
3427
3712
  * <p>An object that describes the endpoint of the deployment.</p>
3428
3713
  */
3429
3714
  publicEndpoint?: EndpointRequest;
@@ -3440,6 +3725,7 @@ export interface ContainerServiceDeploymentRequest {
3440
3725
  */
3441
3726
  export interface ContainerServiceECRImagePullerRoleRequest {
3442
3727
  /**
3728
+ * @public
3443
3729
  * <p>A Boolean value that indicates whether to activate the role.</p>
3444
3730
  */
3445
3731
  isActive?: boolean;
@@ -3450,10 +3736,12 @@ export interface ContainerServiceECRImagePullerRoleRequest {
3450
3736
  */
3451
3737
  export interface ContainerServiceLogEvent {
3452
3738
  /**
3739
+ * @public
3453
3740
  * <p>The timestamp when the container service log event was created.</p>
3454
3741
  */
3455
3742
  createdAt?: Date;
3456
3743
  /**
3744
+ * @public
3457
3745
  * <p>The message of the container service log event.</p>
3458
3746
  */
3459
3747
  message?: string;
@@ -3479,26 +3767,32 @@ export type ContainerServiceMetricName = (typeof ContainerServiceMetricName)[key
3479
3767
  */
3480
3768
  export interface ContainerServicePower {
3481
3769
  /**
3770
+ * @public
3482
3771
  * <p>The ID of the power (e.g., <code>nano-1</code>).</p>
3483
3772
  */
3484
3773
  powerId?: string;
3485
3774
  /**
3775
+ * @public
3486
3776
  * <p>The monthly price of the power in USD.</p>
3487
3777
  */
3488
3778
  price?: number;
3489
3779
  /**
3780
+ * @public
3490
3781
  * <p>The number of vCPUs included in the power.</p>
3491
3782
  */
3492
3783
  cpuCount?: number;
3493
3784
  /**
3785
+ * @public
3494
3786
  * <p>The amount of RAM (in GB) of the power.</p>
3495
3787
  */
3496
3788
  ramSizeInGb?: number;
3497
3789
  /**
3790
+ * @public
3498
3791
  * <p>The friendly name of the power (e.g., <code>nano</code>).</p>
3499
3792
  */
3500
3793
  name?: string;
3501
3794
  /**
3795
+ * @public
3502
3796
  * <p>A Boolean value indicating whether the power is active and can be specified for container
3503
3797
  * services.</p>
3504
3798
  */
@@ -3511,16 +3805,19 @@ export interface ContainerServicePower {
3511
3805
  */
3512
3806
  export interface ContainerServiceRegistryLogin {
3513
3807
  /**
3808
+ * @public
3514
3809
  * <p>The container service registry username to use to push container images to the container
3515
3810
  * image registry of a Lightsail account.</p>
3516
3811
  */
3517
3812
  username?: string;
3518
3813
  /**
3814
+ * @public
3519
3815
  * <p>The container service registry password to use to push container images to the container
3520
3816
  * image registry of a Lightsail account</p>
3521
3817
  */
3522
3818
  password?: string;
3523
3819
  /**
3820
+ * @public
3524
3821
  * <p>The timestamp of when the container image registry sign-in credentials expire.</p>
3525
3822
  * <p>The log in credentials expire 12 hours after they are created, at which point you will
3526
3823
  * need to create a new set of log in credentials using the
@@ -3528,6 +3825,7 @@ export interface ContainerServiceRegistryLogin {
3528
3825
  */
3529
3826
  expiresAt?: Date;
3530
3827
  /**
3828
+ * @public
3531
3829
  * <p>The address to use to push container images to the container image registry of a
3532
3830
  * Lightsail account.</p>
3533
3831
  */
@@ -3538,6 +3836,7 @@ export interface ContainerServiceRegistryLogin {
3538
3836
  */
3539
3837
  export interface ContainerServicesListResult {
3540
3838
  /**
3839
+ * @public
3541
3840
  * <p>An array of objects that describe one or more container services.</p>
3542
3841
  */
3543
3842
  containerServices?: ContainerService[];
@@ -3547,6 +3846,7 @@ export interface ContainerServicesListResult {
3547
3846
  */
3548
3847
  export interface CopySnapshotRequest {
3549
3848
  /**
3849
+ * @public
3550
3850
  * <p>The name of the source manual snapshot to copy.</p>
3551
3851
  * <p>Constraint:</p>
3552
3852
  * <ul>
@@ -3558,6 +3858,7 @@ export interface CopySnapshotRequest {
3558
3858
  */
3559
3859
  sourceSnapshotName?: string;
3560
3860
  /**
3861
+ * @public
3561
3862
  * <p>The name of the source instance or disk from which the source automatic snapshot was
3562
3863
  * created.</p>
3563
3864
  * <p>Constraint:</p>
@@ -3570,6 +3871,7 @@ export interface CopySnapshotRequest {
3570
3871
  */
3571
3872
  sourceResourceName?: string;
3572
3873
  /**
3874
+ * @public
3573
3875
  * <p>The date of the source automatic snapshot to copy. Use the <code>get auto snapshots</code>
3574
3876
  * operation to identify the dates of the available automatic snapshots.</p>
3575
3877
  * <p>Constraints:</p>
@@ -3590,6 +3892,7 @@ export interface CopySnapshotRequest {
3590
3892
  */
3591
3893
  restoreDate?: string;
3592
3894
  /**
3895
+ * @public
3593
3896
  * <p>A Boolean value to indicate whether to use the latest available automatic snapshot of the
3594
3897
  * specified source instance or disk.</p>
3595
3898
  * <p>Constraints:</p>
@@ -3607,10 +3910,12 @@ export interface CopySnapshotRequest {
3607
3910
  */
3608
3911
  useLatestRestorableAutoSnapshot?: boolean;
3609
3912
  /**
3913
+ * @public
3610
3914
  * <p>The name of the new manual snapshot to be created as a copy.</p>
3611
3915
  */
3612
3916
  targetSnapshotName: string | undefined;
3613
3917
  /**
3918
+ * @public
3614
3919
  * <p>The Amazon Web Services Region where the source manual or automatic snapshot is
3615
3920
  * located.</p>
3616
3921
  */
@@ -3621,6 +3926,7 @@ export interface CopySnapshotRequest {
3621
3926
  */
3622
3927
  export interface CopySnapshotResult {
3623
3928
  /**
3929
+ * @public
3624
3930
  * <p>An array of objects that describe the result of the action, such as the status of the
3625
3931
  * request, the timestamp of the request, and the resources affected by the request.</p>
3626
3932
  */
@@ -3658,10 +3964,12 @@ export type PricingUnit = (typeof PricingUnit)[keyof typeof PricingUnit];
3658
3964
  */
3659
3965
  export interface TimePeriod {
3660
3966
  /**
3967
+ * @public
3661
3968
  * <p>The beginning of the time period. The start date is inclusive. For example, if <code>start</code> is <code>2017-01-01</code>, Lightsail for Research retrieves cost and usage data starting at <code>2017-01-01</code> up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.</p>
3662
3969
  */
3663
3970
  start?: Date;
3664
3971
  /**
3972
+ * @public
3665
3973
  * <p>The end of the time period. The end date is exclusive. For example, if <code>end</code> is <code>2017-05-01</code>, Lightsail for Research retrieves cost and usage data from the start date up to, but not including, <code>2017-05-01</code>.</p>
3666
3974
  */
3667
3975
  end?: Date;
@@ -3672,23 +3980,28 @@ export interface TimePeriod {
3672
3980
  */
3673
3981
  export interface EstimateByTime {
3674
3982
  /**
3983
+ * @public
3675
3984
  * <p>The amount of cost or usage that's measured for the cost estimate.</p>
3676
3985
  */
3677
3986
  usageCost?: number;
3678
3987
  /**
3988
+ * @public
3679
3989
  * <p>The unit of measurement that's used for the cost estimate.</p>
3680
3990
  */
3681
3991
  pricingUnit?: PricingUnit | string;
3682
3992
  /**
3993
+ * @public
3683
3994
  * <p>The number of pricing units used to calculate the total number of hours. For example, 1
3684
3995
  * unit equals 1 hour.</p>
3685
3996
  */
3686
3997
  unit?: number;
3687
3998
  /**
3999
+ * @public
3688
4000
  * <p>The currency of the estimate in USD.</p>
3689
4001
  */
3690
4002
  currency?: Currency | string;
3691
4003
  /**
4004
+ * @public
3692
4005
  * <p>The period of time, in days, that an estimate covers. The period has a start date and an end date. The start date must come before the end date.</p>
3693
4006
  */
3694
4007
  timePeriod?: TimePeriod;
@@ -3699,11 +4012,13 @@ export interface EstimateByTime {
3699
4012
  */
3700
4013
  export interface CostEstimate {
3701
4014
  /**
4015
+ * @public
3702
4016
  * <p>The types of usage that are included in the estimate, such as costs, usage, or data
3703
4017
  * transfer.</p>
3704
4018
  */
3705
4019
  usageType?: string;
3706
4020
  /**
4021
+ * @public
3707
4022
  * <p>The cost estimate result that's associated with a time period.</p>
3708
4023
  */
3709
4024
  resultsByTime?: EstimateByTime[];
@@ -3713,12 +4028,14 @@ export interface CostEstimate {
3713
4028
  */
3714
4029
  export interface CreateBucketRequest {
3715
4030
  /**
4031
+ * @public
3716
4032
  * <p>The name for the bucket.</p>
3717
4033
  * <p>For more information about bucket names, see <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/bucket-naming-rules-in-amazon-lightsail">Bucket naming rules in Amazon Lightsail</a> in the <i>Amazon Lightsail Developer
3718
4034
  * Guide</i>.</p>
3719
4035
  */
3720
4036
  bucketName: string | undefined;
3721
4037
  /**
4038
+ * @public
3722
4039
  * <p>The ID of the bundle to use for the bucket.</p>
3723
4040
  * <p>A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a
3724
4041
  * bucket.</p>
@@ -3729,12 +4046,14 @@ export interface CreateBucketRequest {
3729
4046
  */
3730
4047
  bundleId: string | undefined;
3731
4048
  /**
4049
+ * @public
3732
4050
  * <p>The tag keys and optional values to add to the bucket during creation.</p>
3733
4051
  * <p>Use the <a href="https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_TagResource.html">TagResource</a> action to tag the bucket after it's
3734
4052
  * created.</p>
3735
4053
  */
3736
4054
  tags?: Tag[];
3737
4055
  /**
4056
+ * @public
3738
4057
  * <p>A Boolean value that indicates whether to enable versioning of objects in the
3739
4058
  * bucket.</p>
3740
4059
  * <p>For more information about versioning, see <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-managing-bucket-object-versioning">Enabling and suspending object versioning in a bucket in Amazon Lightsail</a> in the
@@ -3747,10 +4066,12 @@ export interface CreateBucketRequest {
3747
4066
  */
3748
4067
  export interface CreateBucketResult {
3749
4068
  /**
4069
+ * @public
3750
4070
  * <p>An object that describes the bucket that is created.</p>
3751
4071
  */
3752
4072
  bucket?: Bucket;
3753
4073
  /**
4074
+ * @public
3754
4075
  * <p>An array of objects that describe the result of the action, such as the status of the
3755
4076
  * request, the timestamp of the request, and the resources affected by the request.</p>
3756
4077
  */
@@ -3761,6 +4082,7 @@ export interface CreateBucketResult {
3761
4082
  */
3762
4083
  export interface CreateBucketAccessKeyRequest {
3763
4084
  /**
4085
+ * @public
3764
4086
  * <p>The name of the bucket that the new access key will belong to, and grant access to.</p>
3765
4087
  */
3766
4088
  bucketName: string | undefined;
@@ -3770,10 +4092,12 @@ export interface CreateBucketAccessKeyRequest {
3770
4092
  */
3771
4093
  export interface CreateBucketAccessKeyResult {
3772
4094
  /**
4095
+ * @public
3773
4096
  * <p>An object that describes the access key that is created.</p>
3774
4097
  */
3775
4098
  accessKey?: AccessKey;
3776
4099
  /**
4100
+ * @public
3777
4101
  * <p>An array of objects that describe the result of the action, such as the status of the
3778
4102
  * request, the timestamp of the request, and the resources affected by the request.</p>
3779
4103
  */
@@ -3784,14 +4108,17 @@ export interface CreateBucketAccessKeyResult {
3784
4108
  */
3785
4109
  export interface CreateCertificateRequest {
3786
4110
  /**
4111
+ * @public
3787
4112
  * <p>The name for the certificate.</p>
3788
4113
  */
3789
4114
  certificateName: string | undefined;
3790
4115
  /**
4116
+ * @public
3791
4117
  * <p>The domain name (e.g., <code>example.com</code>) for the certificate.</p>
3792
4118
  */
3793
4119
  domainName: string | undefined;
3794
4120
  /**
4121
+ * @public
3795
4122
  * <p>An array of strings that specify the alternate domains (e.g., <code>example2.com</code>)
3796
4123
  * and subdomains (e.g., <code>blog.example.com</code>) for the certificate.</p>
3797
4124
  * <p>You can specify a maximum of nine alternate domains (in addition to the primary domain
@@ -3800,6 +4127,7 @@ export interface CreateCertificateRequest {
3800
4127
  */
3801
4128
  subjectAlternativeNames?: string[];
3802
4129
  /**
4130
+ * @public
3803
4131
  * <p>The tag keys and optional values to add to the certificate during create.</p>
3804
4132
  * <p>Use the <code>TagResource</code> action to tag a resource after it's created.</p>
3805
4133
  */
@@ -3810,10 +4138,12 @@ export interface CreateCertificateRequest {
3810
4138
  */
3811
4139
  export interface CreateCertificateResult {
3812
4140
  /**
4141
+ * @public
3813
4142
  * <p>An object that describes the certificate created.</p>
3814
4143
  */
3815
4144
  certificate?: CertificateSummary;
3816
4145
  /**
4146
+ * @public
3817
4147
  * <p>An array of objects that describe the result of the action, such as the status of the
3818
4148
  * request, the timestamp of the request, and the resources affected by the request.</p>
3819
4149
  */
@@ -3840,6 +4170,7 @@ export type PortInfoSourceType = (typeof PortInfoSourceType)[keyof typeof PortIn
3840
4170
  */
3841
4171
  export interface InstanceEntry {
3842
4172
  /**
4173
+ * @public
3843
4174
  * <p>The name of the export snapshot record, which contains the exported Lightsail instance
3844
4175
  * snapshot that will be used as the source of the new Amazon EC2 instance.</p>
3845
4176
  * <p>Use the <code>get export snapshot records</code> operation to get a list of export
@@ -3847,10 +4178,12 @@ export interface InstanceEntry {
3847
4178
  */
3848
4179
  sourceName: string | undefined;
3849
4180
  /**
4181
+ * @public
3850
4182
  * <p>The instance type (e.g., <code>t2.micro</code>) to use for the new Amazon EC2 instance.</p>
3851
4183
  */
3852
4184
  instanceType: string | undefined;
3853
4185
  /**
4186
+ * @public
3854
4187
  * <p>The port configuration to use for the new Amazon EC2 instance.</p>
3855
4188
  * <p>The following configuration options are available:</p>
3856
4189
  * <ul>
@@ -3890,6 +4223,7 @@ export interface InstanceEntry {
3890
4223
  */
3891
4224
  portInfoSource: PortInfoSourceType | string | undefined;
3892
4225
  /**
4226
+ * @public
3893
4227
  * <p>A launch script you can create that configures a server with additional user data. For
3894
4228
  * example, you might want to run <code>apt-get -y update</code>.</p>
3895
4229
  * <note>
@@ -3900,6 +4234,7 @@ export interface InstanceEntry {
3900
4234
  */
3901
4235
  userData?: string;
3902
4236
  /**
4237
+ * @public
3903
4238
  * <p>The Availability Zone for the new Amazon EC2 instance.</p>
3904
4239
  */
3905
4240
  availabilityZone: string | undefined;
@@ -3909,6 +4244,7 @@ export interface InstanceEntry {
3909
4244
  */
3910
4245
  export interface CreateCloudFormationStackRequest {
3911
4246
  /**
4247
+ * @public
3912
4248
  * <p>An array of parameters that will be used to create the new Amazon EC2 instance. You can only
3913
4249
  * pass one instance entry at a time in this array. You will get an invalid parameter error if
3914
4250
  * you pass more than one instance entry in this array.</p>
@@ -3920,6 +4256,7 @@ export interface CreateCloudFormationStackRequest {
3920
4256
  */
3921
4257
  export interface CreateCloudFormationStackResult {
3922
4258
  /**
4259
+ * @public
3923
4260
  * <p>An array of objects that describe the result of the action, such as the status of the
3924
4261
  * request, the timestamp of the request, and the resources affected by the request.</p>
3925
4262
  */
@@ -3930,6 +4267,7 @@ export interface CreateCloudFormationStackResult {
3930
4267
  */
3931
4268
  export interface CreateContactMethodRequest {
3932
4269
  /**
4270
+ * @public
3933
4271
  * <p>The protocol of the contact method, such as <code>Email</code> or <code>SMS</code> (text
3934
4272
  * messaging).</p>
3935
4273
  * <p>The <code>SMS</code> protocol is supported only in the following Amazon Web Services
@@ -3961,6 +4299,7 @@ export interface CreateContactMethodRequest {
3961
4299
  */
3962
4300
  protocol: ContactProtocol | string | undefined;
3963
4301
  /**
4302
+ * @public
3964
4303
  * <p>The destination of the contact method, such as an email address or a mobile phone
3965
4304
  * number.</p>
3966
4305
  * <p>Use the E.164 format when specifying a mobile phone number. E.164 is a standard for the
@@ -3976,6 +4315,7 @@ export interface CreateContactMethodRequest {
3976
4315
  */
3977
4316
  export interface CreateContactMethodResult {
3978
4317
  /**
4318
+ * @public
3979
4319
  * <p>An array of objects that describe the result of the action, such as the status of the
3980
4320
  * request, the timestamp of the request, and the resources affected by the request.</p>
3981
4321
  */
@@ -3989,6 +4329,7 @@ export interface CreateContactMethodResult {
3989
4329
  */
3990
4330
  export interface PrivateRegistryAccessRequest {
3991
4331
  /**
4332
+ * @public
3992
4333
  * <p>An object to describe a request to activate or deactivate the role that you can use to
3993
4334
  * grant an Amazon Lightsail container service access to Amazon Elastic Container Registry
3994
4335
  * (Amazon ECR) private repositories.</p>
@@ -4000,6 +4341,7 @@ export interface PrivateRegistryAccessRequest {
4000
4341
  */
4001
4342
  export interface CreateContainerServiceRequest {
4002
4343
  /**
4344
+ * @public
4003
4345
  * <p>The name for the container service.</p>
4004
4346
  * <p>The name that you specify for your container service will make up part of its default
4005
4347
  * domain. The default domain of a container service is typically
@@ -4028,6 +4370,7 @@ export interface CreateContainerServiceRequest {
4028
4370
  */
4029
4371
  serviceName: string | undefined;
4030
4372
  /**
4373
+ * @public
4031
4374
  * <p>The power specification for the container service.</p>
4032
4375
  * <p>The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the
4033
4376
  * container service. The <code>power</code> and <code>scale</code> of a container service makes
@@ -4039,6 +4382,7 @@ export interface CreateContainerServiceRequest {
4039
4382
  */
4040
4383
  power: ContainerServicePowerName | string | undefined;
4041
4384
  /**
4385
+ * @public
4042
4386
  * <p>The scale specification for the container service.</p>
4043
4387
  * <p>The scale specifies the allocated compute nodes of the container service. The
4044
4388
  * <code>power</code> and <code>scale</code> of a container service makes up its configured
@@ -4048,12 +4392,14 @@ export interface CreateContainerServiceRequest {
4048
4392
  */
4049
4393
  scale: number | undefined;
4050
4394
  /**
4395
+ * @public
4051
4396
  * <p>The tag keys and optional values to add to the container service during create.</p>
4052
4397
  * <p>Use the <code>TagResource</code> action to tag a resource after it's created.</p>
4053
4398
  * <p>For more information about tags in Lightsail, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags">Amazon Lightsail Developer Guide</a>.</p>
4054
4399
  */
4055
4400
  tags?: Tag[];
4056
4401
  /**
4402
+ * @public
4057
4403
  * <p>The public domain names to use with the container service, such as
4058
4404
  * <code>example.com</code> and <code>www.example.com</code>.</p>
4059
4405
  * <p>You can specify up to four public domain names for a container service. The domain names
@@ -4071,6 +4417,7 @@ export interface CreateContainerServiceRequest {
4071
4417
  */
4072
4418
  publicDomainNames?: Record<string, string[]>;
4073
4419
  /**
4420
+ * @public
4074
4421
  * <p>An object that describes a deployment for the container service.</p>
4075
4422
  * <p>A deployment specifies the containers that will be launched on the container service and
4076
4423
  * their settings, such as the ports to open, the environment variables to apply, and the launch
@@ -4080,6 +4427,7 @@ export interface CreateContainerServiceRequest {
4080
4427
  */
4081
4428
  deployment?: ContainerServiceDeploymentRequest;
4082
4429
  /**
4430
+ * @public
4083
4431
  * <p>An object to describe the configuration for the container service to access private
4084
4432
  * container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private
4085
4433
  * repositories.</p>
@@ -4092,6 +4440,7 @@ export interface CreateContainerServiceRequest {
4092
4440
  */
4093
4441
  export interface CreateContainerServiceResult {
4094
4442
  /**
4443
+ * @public
4095
4444
  * <p>An object that describes a container service.</p>
4096
4445
  */
4097
4446
  containerService?: ContainerService;
@@ -4101,15 +4450,18 @@ export interface CreateContainerServiceResult {
4101
4450
  */
4102
4451
  export interface CreateContainerServiceDeploymentRequest {
4103
4452
  /**
4453
+ * @public
4104
4454
  * <p>The name of the container service for which to create the deployment.</p>
4105
4455
  */
4106
4456
  serviceName: string | undefined;
4107
4457
  /**
4458
+ * @public
4108
4459
  * <p>An object that describes the settings of the containers that will be launched on the
4109
4460
  * container service.</p>
4110
4461
  */
4111
4462
  containers?: Record<string, Container>;
4112
4463
  /**
4464
+ * @public
4113
4465
  * <p>An object that describes the settings of the public endpoint for the container
4114
4466
  * service.</p>
4115
4467
  */
@@ -4120,6 +4472,7 @@ export interface CreateContainerServiceDeploymentRequest {
4120
4472
  */
4121
4473
  export interface CreateContainerServiceDeploymentResult {
4122
4474
  /**
4475
+ * @public
4123
4476
  * <p>An object that describes a container service.</p>
4124
4477
  */
4125
4478
  containerService?: ContainerService;
@@ -4134,6 +4487,7 @@ export interface CreateContainerServiceRegistryLoginRequest {
4134
4487
  */
4135
4488
  export interface CreateContainerServiceRegistryLoginResult {
4136
4489
  /**
4490
+ * @public
4137
4491
  * <p>An object that describes the log in information for the container service registry of your
4138
4492
  * Lightsail account.</p>
4139
4493
  */
@@ -4144,10 +4498,12 @@ export interface CreateContainerServiceRegistryLoginResult {
4144
4498
  */
4145
4499
  export interface CreateDiskRequest {
4146
4500
  /**
4501
+ * @public
4147
4502
  * <p>The unique Lightsail disk name (e.g., <code>my-disk</code>).</p>
4148
4503
  */
4149
4504
  diskName: string | undefined;
4150
4505
  /**
4506
+ * @public
4151
4507
  * <p>The Availability Zone where you want to create the disk (e.g., <code>us-east-2a</code>).
4152
4508
  * Use the same Availability Zone as the Lightsail instance to which you want to attach the
4153
4509
  * disk.</p>
@@ -4156,15 +4512,18 @@ export interface CreateDiskRequest {
4156
4512
  */
4157
4513
  availabilityZone: string | undefined;
4158
4514
  /**
4515
+ * @public
4159
4516
  * <p>The size of the disk in GB (e.g., <code>32</code>).</p>
4160
4517
  */
4161
4518
  sizeInGb: number | undefined;
4162
4519
  /**
4520
+ * @public
4163
4521
  * <p>The tag keys and optional values to add to the resource during create.</p>
4164
4522
  * <p>Use the <code>TagResource</code> action to tag a resource after it's created.</p>
4165
4523
  */
4166
4524
  tags?: Tag[];
4167
4525
  /**
4526
+ * @public
4168
4527
  * <p>An array of objects that represent the add-ons to enable for the new disk.</p>
4169
4528
  */
4170
4529
  addOns?: AddOnRequest[];
@@ -4174,6 +4533,7 @@ export interface CreateDiskRequest {
4174
4533
  */
4175
4534
  export interface CreateDiskResult {
4176
4535
  /**
4536
+ * @public
4177
4537
  * <p>An array of objects that describe the result of the action, such as the status of the
4178
4538
  * request, the timestamp of the request, and the resources affected by the request.</p>
4179
4539
  */
@@ -4184,10 +4544,12 @@ export interface CreateDiskResult {
4184
4544
  */
4185
4545
  export interface CreateDiskFromSnapshotRequest {
4186
4546
  /**
4547
+ * @public
4187
4548
  * <p>The unique Lightsail disk name (e.g., <code>my-disk</code>).</p>
4188
4549
  */
4189
4550
  diskName: string | undefined;
4190
4551
  /**
4552
+ * @public
4191
4553
  * <p>The name of the disk snapshot (e.g., <code>my-snapshot</code>) from which to create the
4192
4554
  * new storage disk.</p>
4193
4555
  * <p>Constraint:</p>
@@ -4201,6 +4563,7 @@ export interface CreateDiskFromSnapshotRequest {
4201
4563
  */
4202
4564
  diskSnapshotName?: string;
4203
4565
  /**
4566
+ * @public
4204
4567
  * <p>The Availability Zone where you want to create the disk (e.g., <code>us-east-2a</code>).
4205
4568
  * Choose the same Availability Zone as the Lightsail instance where you want to create the
4206
4569
  * disk.</p>
@@ -4209,19 +4572,23 @@ export interface CreateDiskFromSnapshotRequest {
4209
4572
  */
4210
4573
  availabilityZone: string | undefined;
4211
4574
  /**
4575
+ * @public
4212
4576
  * <p>The size of the disk in GB (e.g., <code>32</code>).</p>
4213
4577
  */
4214
4578
  sizeInGb: number | undefined;
4215
4579
  /**
4580
+ * @public
4216
4581
  * <p>The tag keys and optional values to add to the resource during create.</p>
4217
4582
  * <p>Use the <code>TagResource</code> action to tag a resource after it's created.</p>
4218
4583
  */
4219
4584
  tags?: Tag[];
4220
4585
  /**
4586
+ * @public
4221
4587
  * <p>An array of objects that represent the add-ons to enable for the new disk.</p>
4222
4588
  */
4223
4589
  addOns?: AddOnRequest[];
4224
4590
  /**
4591
+ * @public
4225
4592
  * <p>The name of the source disk from which the source automatic snapshot was created.</p>
4226
4593
  * <p>Constraints:</p>
4227
4594
  * <ul>
@@ -4238,6 +4605,7 @@ export interface CreateDiskFromSnapshotRequest {
4238
4605
  */
4239
4606
  sourceDiskName?: string;
4240
4607
  /**
4608
+ * @public
4241
4609
  * <p>The date of the automatic snapshot to use for the new disk. Use the <code>get auto
4242
4610
  * snapshots</code> operation to identify the dates of the available automatic
4243
4611
  * snapshots.</p>
@@ -4259,6 +4627,7 @@ export interface CreateDiskFromSnapshotRequest {
4259
4627
  */
4260
4628
  restoreDate?: string;
4261
4629
  /**
4630
+ * @public
4262
4631
  * <p>A Boolean value to indicate whether to use the latest available automatic snapshot.</p>
4263
4632
  * <p>Constraints:</p>
4264
4633
  * <ul>
@@ -4280,6 +4649,7 @@ export interface CreateDiskFromSnapshotRequest {
4280
4649
  */
4281
4650
  export interface CreateDiskFromSnapshotResult {
4282
4651
  /**
4652
+ * @public
4283
4653
  * <p>An array of objects that describe the result of the action, such as the status of the
4284
4654
  * request, the timestamp of the request, and the resources affected by the request.</p>
4285
4655
  */
@@ -4290,6 +4660,7 @@ export interface CreateDiskFromSnapshotResult {
4290
4660
  */
4291
4661
  export interface CreateDiskSnapshotRequest {
4292
4662
  /**
4663
+ * @public
4293
4664
  * <p>The unique name of the source disk (e.g., <code>Disk-Virginia-1</code>).</p>
4294
4665
  * <note>
4295
4666
  * <p>This parameter cannot be defined together with the <code>instance name</code> parameter.
@@ -4299,11 +4670,13 @@ export interface CreateDiskSnapshotRequest {
4299
4670
  */
4300
4671
  diskName?: string;
4301
4672
  /**
4673
+ * @public
4302
4674
  * <p>The name of the destination disk snapshot (e.g., <code>my-disk-snapshot</code>) based on
4303
4675
  * the source disk.</p>
4304
4676
  */
4305
4677
  diskSnapshotName: string | undefined;
4306
4678
  /**
4679
+ * @public
4307
4680
  * <p>The unique name of the source instance (e.g., <code>Amazon_Linux-512MB-Virginia-1</code>).
4308
4681
  * When this is defined, a snapshot of the instance's system volume is created.</p>
4309
4682
  * <note>
@@ -4314,6 +4687,7 @@ export interface CreateDiskSnapshotRequest {
4314
4687
  */
4315
4688
  instanceName?: string;
4316
4689
  /**
4690
+ * @public
4317
4691
  * <p>The tag keys and optional values to add to the resource during create.</p>
4318
4692
  * <p>Use the <code>TagResource</code> action to tag a resource after it's created.</p>
4319
4693
  */
@@ -4324,6 +4698,7 @@ export interface CreateDiskSnapshotRequest {
4324
4698
  */
4325
4699
  export interface CreateDiskSnapshotResult {
4326
4700
  /**
4701
+ * @public
4327
4702
  * <p>An array of objects that describe the result of the action, such as the status of the
4328
4703
  * request, the timestamp of the request, and the resources affected by the request.</p>
4329
4704
  */
@@ -4363,14 +4738,17 @@ export type OriginProtocolPolicyEnum = (typeof OriginProtocolPolicyEnum)[keyof t
4363
4738
  */
4364
4739
  export interface InputOrigin {
4365
4740
  /**
4741
+ * @public
4366
4742
  * <p>The name of the origin resource.</p>
4367
4743
  */
4368
4744
  name?: string;
4369
4745
  /**
4746
+ * @public
4370
4747
  * <p>The AWS Region name of the origin resource.</p>
4371
4748
  */
4372
4749
  regionName?: RegionName | string;
4373
4750
  /**
4751
+ * @public
4374
4752
  * <p>The protocol that your Amazon Lightsail distribution uses when establishing a connection
4375
4753
  * with your origin to pull content.</p>
4376
4754
  */
@@ -4381,28 +4759,34 @@ export interface InputOrigin {
4381
4759
  */
4382
4760
  export interface CreateDistributionRequest {
4383
4761
  /**
4762
+ * @public
4384
4763
  * <p>The name for the distribution.</p>
4385
4764
  */
4386
4765
  distributionName: string | undefined;
4387
4766
  /**
4767
+ * @public
4388
4768
  * <p>An object that describes the origin resource for the distribution, such as a Lightsail
4389
4769
  * instance, bucket, or load balancer.</p>
4390
4770
  * <p>The distribution pulls, caches, and serves content from the origin.</p>
4391
4771
  */
4392
4772
  origin: InputOrigin | undefined;
4393
4773
  /**
4774
+ * @public
4394
4775
  * <p>An object that describes the default cache behavior for the distribution.</p>
4395
4776
  */
4396
4777
  defaultCacheBehavior: CacheBehavior | undefined;
4397
4778
  /**
4779
+ * @public
4398
4780
  * <p>An object that describes the cache behavior settings for the distribution.</p>
4399
4781
  */
4400
4782
  cacheBehaviorSettings?: CacheSettings;
4401
4783
  /**
4784
+ * @public
4402
4785
  * <p>An array of objects that describe the per-path cache behavior for the distribution.</p>
4403
4786
  */
4404
4787
  cacheBehaviors?: CacheBehaviorPerPath[];
4405
4788
  /**
4789
+ * @public
4406
4790
  * <p>The bundle ID to use for the distribution.</p>
4407
4791
  * <p>A distribution bundle describes the specifications of your distribution, such as the
4408
4792
  * monthly cost and monthly network transfer quota.</p>
@@ -4411,6 +4795,7 @@ export interface CreateDistributionRequest {
4411
4795
  */
4412
4796
  bundleId: string | undefined;
4413
4797
  /**
4798
+ * @public
4414
4799
  * <p>The IP address type for the distribution.</p>
4415
4800
  * <p>The possible values are <code>ipv4</code> for IPv4 only, and <code>dualstack</code> for
4416
4801
  * IPv4 and IPv6.</p>
@@ -4418,6 +4803,7 @@ export interface CreateDistributionRequest {
4418
4803
  */
4419
4804
  ipAddressType?: IpAddressType | string;
4420
4805
  /**
4806
+ * @public
4421
4807
  * <p>The tag keys and optional values to add to the distribution during create.</p>
4422
4808
  * <p>Use the <code>TagResource</code> action to tag a resource after it's created.</p>
4423
4809
  */
@@ -4433,18 +4819,22 @@ export interface CreateDistributionRequest {
4433
4819
  */
4434
4820
  export interface Origin {
4435
4821
  /**
4822
+ * @public
4436
4823
  * <p>The name of the origin resource.</p>
4437
4824
  */
4438
4825
  name?: string;
4439
4826
  /**
4827
+ * @public
4440
4828
  * <p>The resource type of the origin resource (e.g., <i>Instance</i>).</p>
4441
4829
  */
4442
4830
  resourceType?: ResourceType | string;
4443
4831
  /**
4832
+ * @public
4444
4833
  * <p>The AWS Region name of the origin resource.</p>
4445
4834
  */
4446
4835
  regionName?: RegionName | string;
4447
4836
  /**
4837
+ * @public
4448
4838
  * <p>The protocol that your Amazon Lightsail distribution uses when establishing a connection
4449
4839
  * with your origin to pull content.</p>
4450
4840
  */
@@ -4456,24 +4846,29 @@ export interface Origin {
4456
4846
  */
4457
4847
  export interface LightsailDistribution {
4458
4848
  /**
4849
+ * @public
4459
4850
  * <p>The name of the distribution.</p>
4460
4851
  */
4461
4852
  name?: string;
4462
4853
  /**
4854
+ * @public
4463
4855
  * <p>The Amazon Resource Name (ARN) of the distribution.</p>
4464
4856
  */
4465
4857
  arn?: string;
4466
4858
  /**
4859
+ * @public
4467
4860
  * <p>The support code. Include this code in your email to support when you have questions about
4468
4861
  * your Lightsail distribution. This code enables our support team to look up your Lightsail
4469
4862
  * information more easily.</p>
4470
4863
  */
4471
4864
  supportCode?: string;
4472
4865
  /**
4866
+ * @public
4473
4867
  * <p>The timestamp when the distribution was created.</p>
4474
4868
  */
4475
4869
  createdAt?: Date;
4476
4870
  /**
4871
+ * @public
4477
4872
  * <p>An object that describes the location of the distribution, such as the Amazon Web Services
4478
4873
  * Region and Availability Zone.</p>
4479
4874
  * <note>
@@ -4484,56 +4879,69 @@ export interface LightsailDistribution {
4484
4879
  */
4485
4880
  location?: ResourceLocation;
4486
4881
  /**
4882
+ * @public
4487
4883
  * <p>The Lightsail resource type (e.g., <code>Distribution</code>).</p>
4488
4884
  */
4489
4885
  resourceType?: ResourceType | string;
4490
4886
  /**
4887
+ * @public
4491
4888
  * <p>The alternate domain names of the distribution.</p>
4492
4889
  */
4493
4890
  alternativeDomainNames?: string[];
4494
4891
  /**
4892
+ * @public
4495
4893
  * <p>The status of the distribution.</p>
4496
4894
  */
4497
4895
  status?: string;
4498
4896
  /**
4897
+ * @public
4499
4898
  * <p>Indicates whether the distribution is enabled.</p>
4500
4899
  */
4501
4900
  isEnabled?: boolean;
4502
4901
  /**
4902
+ * @public
4503
4903
  * <p>The domain name of the distribution.</p>
4504
4904
  */
4505
4905
  domainName?: string;
4506
4906
  /**
4907
+ * @public
4507
4908
  * <p>The ID of the bundle currently applied to the distribution.</p>
4508
4909
  */
4509
4910
  bundleId?: string;
4510
4911
  /**
4912
+ * @public
4511
4913
  * <p>The name of the SSL/TLS certificate attached to the distribution, if any.</p>
4512
4914
  */
4513
4915
  certificateName?: string;
4514
4916
  /**
4917
+ * @public
4515
4918
  * <p>An object that describes the origin resource of the distribution, such as a Lightsail
4516
4919
  * instance, bucket, or load balancer.</p>
4517
4920
  * <p>The distribution pulls, caches, and serves content from the origin.</p>
4518
4921
  */
4519
4922
  origin?: Origin;
4520
4923
  /**
4924
+ * @public
4521
4925
  * <p>The public DNS of the origin.</p>
4522
4926
  */
4523
4927
  originPublicDNS?: string;
4524
4928
  /**
4929
+ * @public
4525
4930
  * <p>An object that describes the default cache behavior of the distribution.</p>
4526
4931
  */
4527
4932
  defaultCacheBehavior?: CacheBehavior;
4528
4933
  /**
4934
+ * @public
4529
4935
  * <p>An object that describes the cache behavior settings of the distribution.</p>
4530
4936
  */
4531
4937
  cacheBehaviorSettings?: CacheSettings;
4532
4938
  /**
4939
+ * @public
4533
4940
  * <p>An array of objects that describe the per-path cache behavior of the distribution.</p>
4534
4941
  */
4535
4942
  cacheBehaviors?: CacheBehaviorPerPath[];
4536
4943
  /**
4944
+ * @public
4537
4945
  * <p>Indicates whether the bundle that is currently applied to your distribution, specified
4538
4946
  * using the <code>distributionName</code> parameter, can be changed to another bundle.</p>
4539
4947
  * <p>Use the <code>UpdateDistributionBundle</code> action to change your distribution's
@@ -4541,12 +4949,14 @@ export interface LightsailDistribution {
4541
4949
  */
4542
4950
  ableToUpdateBundle?: boolean;
4543
4951
  /**
4952
+ * @public
4544
4953
  * <p>The IP address type of the distribution.</p>
4545
4954
  * <p>The possible values are <code>ipv4</code> for IPv4 only, and <code>dualstack</code> for
4546
4955
  * IPv4 and IPv6.</p>
4547
4956
  */
4548
4957
  ipAddressType?: IpAddressType | string;
4549
4958
  /**
4959
+ * @public
4550
4960
  * <p>The tag keys and optional values for the resource. For more information about tags in
4551
4961
  * Lightsail, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags">Amazon Lightsail Developer Guide</a>.</p>
4552
4962
  */
@@ -4557,10 +4967,12 @@ export interface LightsailDistribution {
4557
4967
  */
4558
4968
  export interface CreateDistributionResult {
4559
4969
  /**
4970
+ * @public
4560
4971
  * <p>An object that describes the distribution created.</p>
4561
4972
  */
4562
4973
  distribution?: LightsailDistribution;
4563
4974
  /**
4975
+ * @public
4564
4976
  * <p>An array of objects that describe the result of the action, such as the status of the
4565
4977
  * request, the timestamp of the request, and the resources affected by the request.</p>
4566
4978
  */
@@ -4571,10 +4983,12 @@ export interface CreateDistributionResult {
4571
4983
  */
4572
4984
  export interface CreateDomainRequest {
4573
4985
  /**
4986
+ * @public
4574
4987
  * <p>The domain name to manage (e.g., <code>example.com</code>).</p>
4575
4988
  */
4576
4989
  domainName: string | undefined;
4577
4990
  /**
4991
+ * @public
4578
4992
  * <p>The tag keys and optional values to add to the resource during create.</p>
4579
4993
  * <p>Use the <code>TagResource</code> action to tag a resource after it's created.</p>
4580
4994
  */
@@ -4585,6 +4999,7 @@ export interface CreateDomainRequest {
4585
4999
  */
4586
5000
  export interface CreateDomainResult {
4587
5001
  /**
5002
+ * @public
4588
5003
  * <p>An array of objects that describe the result of the action, such as the status of the
4589
5004
  * request, the timestamp of the request, and the resources affected by the request.</p>
4590
5005
  */
@@ -4596,14 +5011,17 @@ export interface CreateDomainResult {
4596
5011
  */
4597
5012
  export interface DomainEntry {
4598
5013
  /**
5014
+ * @public
4599
5015
  * <p>The ID of the domain recordset entry.</p>
4600
5016
  */
4601
5017
  id?: string;
4602
5018
  /**
5019
+ * @public
4603
5020
  * <p>The name of the domain.</p>
4604
5021
  */
4605
5022
  name?: string;
4606
5023
  /**
5024
+ * @public
4607
5025
  * <p>The target IP address (e.g., <code>192.0.2.0</code>), or AWS name server (e.g.,
4608
5026
  * <code>ns-111.awsdns-22.com.</code>).</p>
4609
5027
  * <p>For Lightsail load balancers, the value looks like
@@ -4616,6 +5034,7 @@ export interface DomainEntry {
4616
5034
  */
4617
5035
  target?: string;
4618
5036
  /**
5037
+ * @public
4619
5038
  * <p>When <code>true</code>, specifies whether the domain entry is an alias used by the Lightsail load balancer, Lightsail container service, Lightsail content delivery network (CDN) distribution, or another Amazon Web Services
4620
5039
  * resource. You can include an alias (A type) record in your request, which points to the DNS
4621
5040
  * name of a load balancer, container service, CDN distribution, or other Amazon Web Services
@@ -4623,6 +5042,7 @@ export interface DomainEntry {
4623
5042
  */
4624
5043
  isAlias?: boolean;
4625
5044
  /**
5045
+ * @public
4626
5046
  * <p>The type of domain entry, such as address for IPv4 (A), address for IPv6 (AAAA), canonical
4627
5047
  * name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator
4628
5048
  * (SRV), or text (TXT).</p>
@@ -4672,6 +5092,7 @@ export interface DomainEntry {
4672
5092
  */
4673
5093
  type?: string;
4674
5094
  /**
5095
+ * @public
4675
5096
  * @deprecated
4676
5097
  *
4677
5098
  * <p>(Deprecated) The options for the domain entry.</p>
@@ -4687,11 +5108,13 @@ export interface DomainEntry {
4687
5108
  */
4688
5109
  export interface CreateDomainEntryRequest {
4689
5110
  /**
5111
+ * @public
4690
5112
  * <p>The domain name (e.g., <code>example.com</code>) for which you want to create the domain
4691
5113
  * entry.</p>
4692
5114
  */
4693
5115
  domainName: string | undefined;
4694
5116
  /**
5117
+ * @public
4695
5118
  * <p>An array of key-value pairs containing information about the domain entry request.</p>
4696
5119
  */
4697
5120
  domainEntry: DomainEntry | undefined;
@@ -4701,6 +5124,7 @@ export interface CreateDomainEntryRequest {
4701
5124
  */
4702
5125
  export interface CreateDomainEntryResult {
4703
5126
  /**
5127
+ * @public
4704
5128
  * <p>An array of objects that describe the result of the action, such as the status of the
4705
5129
  * request, the timestamp of the request, and the resources affected by the request.</p>
4706
5130
  */
@@ -4711,6 +5135,7 @@ export interface CreateDomainEntryResult {
4711
5135
  */
4712
5136
  export interface CreateGUISessionAccessDetailsRequest {
4713
5137
  /**
5138
+ * @public
4714
5139
  * <p>The resource name.</p>
4715
5140
  */
4716
5141
  resourceName: string | undefined;
@@ -4722,14 +5147,17 @@ export interface CreateGUISessionAccessDetailsRequest {
4722
5147
  */
4723
5148
  export interface Session {
4724
5149
  /**
5150
+ * @public
4725
5151
  * <p>The session name.</p>
4726
5152
  */
4727
5153
  name?: string;
4728
5154
  /**
5155
+ * @public
4729
5156
  * <p>The session URL.</p>
4730
5157
  */
4731
5158
  url?: string;
4732
5159
  /**
5160
+ * @public
4733
5161
  * <p>When true, this Boolean value indicates the primary session for the specified
4734
5162
  * resource.</p>
4735
5163
  */
@@ -4760,22 +5188,27 @@ export type Status = (typeof Status)[keyof typeof Status];
4760
5188
  */
4761
5189
  export interface CreateGUISessionAccessDetailsResult {
4762
5190
  /**
5191
+ * @public
4763
5192
  * <p>The resource name.</p>
4764
5193
  */
4765
5194
  resourceName?: string;
4766
5195
  /**
5196
+ * @public
4767
5197
  * <p>The status of the operation.</p>
4768
5198
  */
4769
5199
  status?: Status | string;
4770
5200
  /**
5201
+ * @public
4771
5202
  * <p>The percentage of completion for the operation.</p>
4772
5203
  */
4773
5204
  percentageComplete?: number;
4774
5205
  /**
5206
+ * @public
4775
5207
  * <p>The reason the operation failed.</p>
4776
5208
  */
4777
5209
  failureReason?: string;
4778
5210
  /**
5211
+ * @public
4779
5212
  * <p>Returns information about the specified NICE DCV GUI session.</p>
4780
5213
  */
4781
5214
  sessions?: Session[];
@@ -4785,6 +5218,7 @@ export interface CreateGUISessionAccessDetailsResult {
4785
5218
  */
4786
5219
  export interface CreateInstancesRequest {
4787
5220
  /**
5221
+ * @public
4788
5222
  * <p>The names to use for your new Lightsail instances. Separate multiple values using
4789
5223
  * quotation marks and commas, for example:
4790
5224
  * <code>["MyFirstInstance","MySecondInstance"]</code>
@@ -4792,6 +5226,7 @@ export interface CreateInstancesRequest {
4792
5226
  */
4793
5227
  instanceNames: string[] | undefined;
4794
5228
  /**
5229
+ * @public
4795
5230
  * <p>The Availability Zone in which to create your instance. Use the following format:
4796
5231
  * <code>us-east-2a</code> (case sensitive). You can get a list of Availability Zones by using
4797
5232
  * the <a href="http://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRegions.html">get
@@ -4800,6 +5235,7 @@ export interface CreateInstancesRequest {
4800
5235
  */
4801
5236
  availabilityZone: string | undefined;
4802
5237
  /**
5238
+ * @public
4803
5239
  * @deprecated
4804
5240
  *
4805
5241
  * <p>(Deprecated) The name for your custom image.</p>
@@ -4810,6 +5246,7 @@ export interface CreateInstancesRequest {
4810
5246
  */
4811
5247
  customImageName?: string;
4812
5248
  /**
5249
+ * @public
4813
5250
  * <p>The ID for a virtual private server image (e.g., <code>app_wordpress_4_4</code> or
4814
5251
  * <code>app_lamp_7_0</code>). Use the <code>get blueprints</code> operation to return a list
4815
5252
  * of available images (or <i>blueprints</i>).</p>
@@ -4822,12 +5259,14 @@ export interface CreateInstancesRequest {
4822
5259
  */
4823
5260
  blueprintId: string | undefined;
4824
5261
  /**
5262
+ * @public
4825
5263
  * <p>The bundle of specification information for your virtual private server (or
4826
5264
  * <i>instance</i>), including the pricing plan (e.g.,
4827
5265
  * <code>micro_1_0</code>).</p>
4828
5266
  */
4829
5267
  bundleId: string | undefined;
4830
5268
  /**
5269
+ * @public
4831
5270
  * <p>A launch script you can create that configures a server with additional user data. For
4832
5271
  * example, you might want to run <code>apt-get -y update</code>.</p>
4833
5272
  * <note>
@@ -4839,19 +5278,23 @@ export interface CreateInstancesRequest {
4839
5278
  */
4840
5279
  userData?: string;
4841
5280
  /**
5281
+ * @public
4842
5282
  * <p>The name of your key pair.</p>
4843
5283
  */
4844
5284
  keyPairName?: string;
4845
5285
  /**
5286
+ * @public
4846
5287
  * <p>The tag keys and optional values to add to the resource during create.</p>
4847
5288
  * <p>Use the <code>TagResource</code> action to tag a resource after it's created.</p>
4848
5289
  */
4849
5290
  tags?: Tag[];
4850
5291
  /**
5292
+ * @public
4851
5293
  * <p>An array of objects representing the add-ons to enable for the new instance.</p>
4852
5294
  */
4853
5295
  addOns?: AddOnRequest[];
4854
5296
  /**
5297
+ * @public
4855
5298
  * <p>The IP address type for the instance.</p>
4856
5299
  * <p>The possible values are <code>ipv4</code> for IPv4 only, and <code>dualstack</code> for
4857
5300
  * IPv4 and IPv6.</p>
@@ -4864,6 +5307,7 @@ export interface CreateInstancesRequest {
4864
5307
  */
4865
5308
  export interface CreateInstancesResult {
4866
5309
  /**
5310
+ * @public
4867
5311
  * <p>An array of objects that describe the result of the action, such as the status of the
4868
5312
  * request, the timestamp of the request, and the resources affected by the request.</p>
4869
5313
  */
@@ -4874,14 +5318,17 @@ export interface CreateInstancesResult {
4874
5318
  */
4875
5319
  export interface CreateInstancesFromSnapshotRequest {
4876
5320
  /**
5321
+ * @public
4877
5322
  * <p>The names for your new instances.</p>
4878
5323
  */
4879
5324
  instanceNames: string[] | undefined;
4880
5325
  /**
5326
+ * @public
4881
5327
  * <p>An object containing information about one or more disk mappings.</p>
4882
5328
  */
4883
5329
  attachedDiskMapping?: Record<string, DiskMap[]>;
4884
5330
  /**
5331
+ * @public
4885
5332
  * <p>The Availability Zone where you want to create your instances. Use the following
4886
5333
  * formatting: <code>us-east-2a</code> (case sensitive). You can get a list of Availability Zones
4887
5334
  * by using the <a href="http://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRegions.html">get
@@ -4890,6 +5337,7 @@ export interface CreateInstancesFromSnapshotRequest {
4890
5337
  */
4891
5338
  availabilityZone: string | undefined;
4892
5339
  /**
5340
+ * @public
4893
5341
  * <p>The name of the instance snapshot on which you are basing your new instances. Use the get
4894
5342
  * instance snapshots operation to return information about your existing snapshots.</p>
4895
5343
  * <p>Constraint:</p>
@@ -4903,12 +5351,14 @@ export interface CreateInstancesFromSnapshotRequest {
4903
5351
  */
4904
5352
  instanceSnapshotName?: string;
4905
5353
  /**
5354
+ * @public
4906
5355
  * <p>The bundle of specification information for your virtual private server (or
4907
5356
  * <i>instance</i>), including the pricing plan (e.g.,
4908
5357
  * <code>micro_1_0</code>).</p>
4909
5358
  */
4910
5359
  bundleId: string | undefined;
4911
5360
  /**
5361
+ * @public
4912
5362
  * <p>You can create a launch script that configures a server with additional user data. For
4913
5363
  * example, <code>apt-get -y update</code>.</p>
4914
5364
  * <note>
@@ -4920,19 +5370,23 @@ export interface CreateInstancesFromSnapshotRequest {
4920
5370
  */
4921
5371
  userData?: string;
4922
5372
  /**
5373
+ * @public
4923
5374
  * <p>The name for your key pair.</p>
4924
5375
  */
4925
5376
  keyPairName?: string;
4926
5377
  /**
5378
+ * @public
4927
5379
  * <p>The tag keys and optional values to add to the resource during create.</p>
4928
5380
  * <p>Use the <code>TagResource</code> action to tag a resource after it's created.</p>
4929
5381
  */
4930
5382
  tags?: Tag[];
4931
5383
  /**
5384
+ * @public
4932
5385
  * <p>An array of objects representing the add-ons to enable for the new instance.</p>
4933
5386
  */
4934
5387
  addOns?: AddOnRequest[];
4935
5388
  /**
5389
+ * @public
4936
5390
  * <p>The IP address type for the instance.</p>
4937
5391
  * <p>The possible values are <code>ipv4</code> for IPv4 only, and <code>dualstack</code> for
4938
5392
  * IPv4 and IPv6.</p>
@@ -4940,6 +5394,7 @@ export interface CreateInstancesFromSnapshotRequest {
4940
5394
  */
4941
5395
  ipAddressType?: IpAddressType | string;
4942
5396
  /**
5397
+ * @public
4943
5398
  * <p>The name of the source instance from which the source automatic snapshot was
4944
5399
  * created.</p>
4945
5400
  * <p>Constraints:</p>
@@ -4957,6 +5412,7 @@ export interface CreateInstancesFromSnapshotRequest {
4957
5412
  */
4958
5413
  sourceInstanceName?: string;
4959
5414
  /**
5415
+ * @public
4960
5416
  * <p>The date of the automatic snapshot to use for the new instance. Use the <code>get auto
4961
5417
  * snapshots</code> operation to identify the dates of the available automatic
4962
5418
  * snapshots.</p>
@@ -4978,6 +5434,7 @@ export interface CreateInstancesFromSnapshotRequest {
4978
5434
  */
4979
5435
  restoreDate?: string;
4980
5436
  /**
5437
+ * @public
4981
5438
  * <p>A Boolean value to indicate whether to use the latest available automatic snapshot.</p>
4982
5439
  * <p>Constraints:</p>
4983
5440
  * <ul>
@@ -4999,6 +5456,7 @@ export interface CreateInstancesFromSnapshotRequest {
4999
5456
  */
5000
5457
  export interface CreateInstancesFromSnapshotResult {
5001
5458
  /**
5459
+ * @public
5002
5460
  * <p>An array of objects that describe the result of the action, such as the status of the
5003
5461
  * request, the timestamp of the request, and the resources affected by the request.</p>
5004
5462
  */
@@ -5009,14 +5467,17 @@ export interface CreateInstancesFromSnapshotResult {
5009
5467
  */
5010
5468
  export interface CreateInstanceSnapshotRequest {
5011
5469
  /**
5470
+ * @public
5012
5471
  * <p>The name for your new snapshot.</p>
5013
5472
  */
5014
5473
  instanceSnapshotName: string | undefined;
5015
5474
  /**
5475
+ * @public
5016
5476
  * <p>The Lightsail instance on which to base your snapshot.</p>
5017
5477
  */
5018
5478
  instanceName: string | undefined;
5019
5479
  /**
5480
+ * @public
5020
5481
  * <p>The tag keys and optional values to add to the resource during create.</p>
5021
5482
  * <p>Use the <code>TagResource</code> action to tag a resource after it's created.</p>
5022
5483
  */
@@ -5027,6 +5488,7 @@ export interface CreateInstanceSnapshotRequest {
5027
5488
  */
5028
5489
  export interface CreateInstanceSnapshotResult {
5029
5490
  /**
5491
+ * @public
5030
5492
  * <p>An array of objects that describe the result of the action, such as the status of the
5031
5493
  * request, the timestamp of the request, and the resources affected by the request.</p>
5032
5494
  */
@@ -5037,10 +5499,12 @@ export interface CreateInstanceSnapshotResult {
5037
5499
  */
5038
5500
  export interface CreateKeyPairRequest {
5039
5501
  /**
5502
+ * @public
5040
5503
  * <p>The name for your new key pair.</p>
5041
5504
  */
5042
5505
  keyPairName: string | undefined;
5043
5506
  /**
5507
+ * @public
5044
5508
  * <p>The tag keys and optional values to add to the resource during create.</p>
5045
5509
  * <p>Use the <code>TagResource</code> action to tag a resource after it's created.</p>
5046
5510
  */
@@ -5052,38 +5516,46 @@ export interface CreateKeyPairRequest {
5052
5516
  */
5053
5517
  export interface KeyPair {
5054
5518
  /**
5519
+ * @public
5055
5520
  * <p>The friendly name of the SSH key pair.</p>
5056
5521
  */
5057
5522
  name?: string;
5058
5523
  /**
5524
+ * @public
5059
5525
  * <p>The Amazon Resource Name (ARN) of the key pair (e.g.,
5060
5526
  * <code>arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE</code>).</p>
5061
5527
  */
5062
5528
  arn?: string;
5063
5529
  /**
5530
+ * @public
5064
5531
  * <p>The support code. Include this code in your email to support when you have questions about
5065
5532
  * an instance or another resource in Lightsail. This code enables our support team to look up
5066
5533
  * your Lightsail information more easily.</p>
5067
5534
  */
5068
5535
  supportCode?: string;
5069
5536
  /**
5537
+ * @public
5070
5538
  * <p>The timestamp when the key pair was created (e.g., <code>1479816991.349</code>).</p>
5071
5539
  */
5072
5540
  createdAt?: Date;
5073
5541
  /**
5542
+ * @public
5074
5543
  * <p>The region name and Availability Zone where the key pair was created.</p>
5075
5544
  */
5076
5545
  location?: ResourceLocation;
5077
5546
  /**
5547
+ * @public
5078
5548
  * <p>The resource type (usually <code>KeyPair</code>).</p>
5079
5549
  */
5080
5550
  resourceType?: ResourceType | string;
5081
5551
  /**
5552
+ * @public
5082
5553
  * <p>The tag keys and optional values for the resource. For more information about tags in
5083
5554
  * Lightsail, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags">Amazon Lightsail Developer Guide</a>.</p>
5084
5555
  */
5085
5556
  tags?: Tag[];
5086
5557
  /**
5558
+ * @public
5087
5559
  * <p>The RSA fingerprint of the key pair.</p>
5088
5560
  */
5089
5561
  fingerprint?: string;
@@ -5093,19 +5565,23 @@ export interface KeyPair {
5093
5565
  */
5094
5566
  export interface CreateKeyPairResult {
5095
5567
  /**
5568
+ * @public
5096
5569
  * <p>An array of key-value pairs containing information about the new key pair you just
5097
5570
  * created.</p>
5098
5571
  */
5099
5572
  keyPair?: KeyPair;
5100
5573
  /**
5574
+ * @public
5101
5575
  * <p>A base64-encoded public key of the <code>ssh-rsa</code> type.</p>
5102
5576
  */
5103
5577
  publicKeyBase64?: string;
5104
5578
  /**
5579
+ * @public
5105
5580
  * <p>A base64-encoded RSA private key.</p>
5106
5581
  */
5107
5582
  privateKeyBase64?: string;
5108
5583
  /**
5584
+ * @public
5109
5585
  * <p>An array of objects that describe the result of the action, such as the status of the
5110
5586
  * request, the timestamp of the request, and the resources affected by the request.</p>
5111
5587
  */
@@ -5116,14 +5592,17 @@ export interface CreateKeyPairResult {
5116
5592
  */
5117
5593
  export interface CreateLoadBalancerRequest {
5118
5594
  /**
5595
+ * @public
5119
5596
  * <p>The name of your load balancer.</p>
5120
5597
  */
5121
5598
  loadBalancerName: string | undefined;
5122
5599
  /**
5600
+ * @public
5123
5601
  * <p>The instance port where you're creating your load balancer.</p>
5124
5602
  */
5125
5603
  instancePort: number | undefined;
5126
5604
  /**
5605
+ * @public
5127
5606
  * <p>The path you provided to perform the load balancer health check. If you didn't specify a
5128
5607
  * health check path, Lightsail uses the root path of your website (e.g.,
5129
5608
  * <code>"/"</code>).</p>
@@ -5132,12 +5611,14 @@ export interface CreateLoadBalancerRequest {
5132
5611
  */
5133
5612
  healthCheckPath?: string;
5134
5613
  /**
5614
+ * @public
5135
5615
  * <p>The name of the SSL/TLS certificate.</p>
5136
5616
  * <p>If you specify <code>certificateName</code>, then <code>certificateDomainName</code> is
5137
5617
  * required (and vice-versa).</p>
5138
5618
  */
5139
5619
  certificateName?: string;
5140
5620
  /**
5621
+ * @public
5141
5622
  * <p>The domain name with which your certificate is associated (e.g.,
5142
5623
  * <code>example.com</code>).</p>
5143
5624
  * <p>If you specify <code>certificateDomainName</code>, then <code>certificateName</code> is
@@ -5145,17 +5626,20 @@ export interface CreateLoadBalancerRequest {
5145
5626
  */
5146
5627
  certificateDomainName?: string;
5147
5628
  /**
5629
+ * @public
5148
5630
  * <p>The optional alternative domains and subdomains to use with your SSL/TLS certificate
5149
5631
  * (e.g., <code>www.example.com</code>, <code>example.com</code>, <code>m.example.com</code>,
5150
5632
  * <code>blog.example.com</code>).</p>
5151
5633
  */
5152
5634
  certificateAlternativeNames?: string[];
5153
5635
  /**
5636
+ * @public
5154
5637
  * <p>The tag keys and optional values to add to the resource during create.</p>
5155
5638
  * <p>Use the <code>TagResource</code> action to tag a resource after it's created.</p>
5156
5639
  */
5157
5640
  tags?: Tag[];
5158
5641
  /**
5642
+ * @public
5159
5643
  * <p>The IP address type for the load balancer.</p>
5160
5644
  * <p>The possible values are <code>ipv4</code> for IPv4 only, and <code>dualstack</code> for
5161
5645
  * IPv4 and IPv6.</p>
@@ -5163,6 +5647,7 @@ export interface CreateLoadBalancerRequest {
5163
5647
  */
5164
5648
  ipAddressType?: IpAddressType | string;
5165
5649
  /**
5650
+ * @public
5166
5651
  * <p>The name of the TLS policy to apply to the load balancer.</p>
5167
5652
  * <p>Use the <a href="https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetLoadBalancerTlsPolicies.html">GetLoadBalancerTlsPolicies</a> action to get a list of TLS policy names that you can
5168
5653
  * specify.</p>
@@ -5176,6 +5661,7 @@ export interface CreateLoadBalancerRequest {
5176
5661
  */
5177
5662
  export interface CreateLoadBalancerResult {
5178
5663
  /**
5664
+ * @public
5179
5665
  * <p>An array of objects that describe the result of the action, such as the status of the
5180
5666
  * request, the timestamp of the request, and the resources affected by the request.</p>
5181
5667
  */
@@ -5186,10 +5672,12 @@ export interface CreateLoadBalancerResult {
5186
5672
  */
5187
5673
  export interface CreateLoadBalancerTlsCertificateRequest {
5188
5674
  /**
5675
+ * @public
5189
5676
  * <p>The load balancer name where you want to create the SSL/TLS certificate.</p>
5190
5677
  */
5191
5678
  loadBalancerName: string | undefined;
5192
5679
  /**
5680
+ * @public
5193
5681
  * <p>The SSL/TLS certificate name.</p>
5194
5682
  * <p>You can have up to 10 certificates in your account at one time. Each Lightsail load
5195
5683
  * balancer can have up to 2 certificates associated with it at one time. There is also an
@@ -5198,10 +5686,12 @@ export interface CreateLoadBalancerTlsCertificateRequest {
5198
5686
  */
5199
5687
  certificateName: string | undefined;
5200
5688
  /**
5689
+ * @public
5201
5690
  * <p>The domain name (e.g., <code>example.com</code>) for your SSL/TLS certificate.</p>
5202
5691
  */
5203
5692
  certificateDomainName: string | undefined;
5204
5693
  /**
5694
+ * @public
5205
5695
  * <p>An array of strings listing alternative domains and subdomains for your SSL/TLS
5206
5696
  * certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9
5207
5697
  * alternative names (in addition to the 1 primary domain). We do not support wildcards (e.g.,
@@ -5209,6 +5699,7 @@ export interface CreateLoadBalancerTlsCertificateRequest {
5209
5699
  */
5210
5700
  certificateAlternativeNames?: string[];
5211
5701
  /**
5702
+ * @public
5212
5703
  * <p>The tag keys and optional values to add to the resource during create.</p>
5213
5704
  * <p>Use the <code>TagResource</code> action to tag a resource after it's created.</p>
5214
5705
  */
@@ -5219,6 +5710,7 @@ export interface CreateLoadBalancerTlsCertificateRequest {
5219
5710
  */
5220
5711
  export interface CreateLoadBalancerTlsCertificateResult {
5221
5712
  /**
5713
+ * @public
5222
5714
  * <p>An array of objects that describe the result of the action, such as the status of the
5223
5715
  * request, the timestamp of the request, and the resources affected by the request.</p>
5224
5716
  */
@@ -5229,6 +5721,7 @@ export interface CreateLoadBalancerTlsCertificateResult {
5229
5721
  */
5230
5722
  export interface CreateRelationalDatabaseRequest {
5231
5723
  /**
5724
+ * @public
5232
5725
  * <p>The name to use for your new Lightsail database resource.</p>
5233
5726
  * <p>Constraints:</p>
5234
5727
  * <ul>
@@ -5242,6 +5735,7 @@ export interface CreateRelationalDatabaseRequest {
5242
5735
  */
5243
5736
  relationalDatabaseName: string | undefined;
5244
5737
  /**
5738
+ * @public
5245
5739
  * <p>The Availability Zone in which to create your new database. Use the
5246
5740
  * <code>us-east-2a</code> case-sensitive format.</p>
5247
5741
  * <p>You can get a list of Availability Zones by using the <code>get regions</code> operation.
@@ -5250,6 +5744,7 @@ export interface CreateRelationalDatabaseRequest {
5250
5744
  */
5251
5745
  availabilityZone?: string;
5252
5746
  /**
5747
+ * @public
5253
5748
  * <p>The blueprint ID for your new database. A blueprint describes the major engine version of
5254
5749
  * a database.</p>
5255
5750
  * <p>You can get a list of database blueprints IDs by using the <code>get relational database
@@ -5257,6 +5752,7 @@ export interface CreateRelationalDatabaseRequest {
5257
5752
  */
5258
5753
  relationalDatabaseBlueprintId: string | undefined;
5259
5754
  /**
5755
+ * @public
5260
5756
  * <p>The bundle ID for your new database. A bundle describes the performance specifications for
5261
5757
  * your database.</p>
5262
5758
  * <p>You can get a list of database bundle IDs by using the <code>get relational database
@@ -5264,6 +5760,7 @@ export interface CreateRelationalDatabaseRequest {
5264
5760
  */
5265
5761
  relationalDatabaseBundleId: string | undefined;
5266
5762
  /**
5763
+ * @public
5267
5764
  * <p>The meaning of this parameter differs according to the database engine you use.</p>
5268
5765
  * <p>
5269
5766
  * <b>MySQL</b>
@@ -5311,6 +5808,7 @@ export interface CreateRelationalDatabaseRequest {
5311
5808
  */
5312
5809
  masterDatabaseName: string | undefined;
5313
5810
  /**
5811
+ * @public
5314
5812
  * <p>The name for the master user.</p>
5315
5813
  * <p>
5316
5814
  * <b>MySQL</b>
@@ -5358,6 +5856,7 @@ export interface CreateRelationalDatabaseRequest {
5358
5856
  */
5359
5857
  masterUsername: string | undefined;
5360
5858
  /**
5859
+ * @public
5361
5860
  * <p>The password for the master user. The password can include any printable ASCII character
5362
5861
  * except "/", """, or "@". It cannot contain spaces.</p>
5363
5862
  * <p>
@@ -5371,6 +5870,7 @@ export interface CreateRelationalDatabaseRequest {
5371
5870
  */
5372
5871
  masterUserPassword?: string;
5373
5872
  /**
5873
+ * @public
5374
5874
  * <p>The daily time range during which automated backups are created for your new database if
5375
5875
  * automated backups are enabled.</p>
5376
5876
  * <p>The default is a 30-minute window selected at random from an 8-hour block of time for each
@@ -5396,6 +5896,7 @@ export interface CreateRelationalDatabaseRequest {
5396
5896
  */
5397
5897
  preferredBackupWindow?: string;
5398
5898
  /**
5899
+ * @public
5399
5900
  * <p>The weekly time range during which system maintenance can occur on your new
5400
5901
  * database.</p>
5401
5902
  * <p>The default is a 30-minute window selected at random from an 8-hour block of time for each
@@ -5422,6 +5923,7 @@ export interface CreateRelationalDatabaseRequest {
5422
5923
  */
5423
5924
  preferredMaintenanceWindow?: string;
5424
5925
  /**
5926
+ * @public
5425
5927
  * <p>Specifies the accessibility options for your new database. A value of <code>true</code>
5426
5928
  * specifies a database that is available to resources outside of your Lightsail account. A
5427
5929
  * value of <code>false</code> specifies a database that is available only to your Lightsail
@@ -5429,6 +5931,7 @@ export interface CreateRelationalDatabaseRequest {
5429
5931
  */
5430
5932
  publiclyAccessible?: boolean;
5431
5933
  /**
5934
+ * @public
5432
5935
  * <p>The tag keys and optional values to add to the resource during create.</p>
5433
5936
  * <p>Use the <code>TagResource</code> action to tag a resource after it's created.</p>
5434
5937
  */
@@ -5439,6 +5942,7 @@ export interface CreateRelationalDatabaseRequest {
5439
5942
  */
5440
5943
  export interface CreateRelationalDatabaseResult {
5441
5944
  /**
5945
+ * @public
5442
5946
  * <p>An array of objects that describe the result of the action, such as the status of the
5443
5947
  * request, the timestamp of the request, and the resources affected by the request.</p>
5444
5948
  */
@@ -5449,6 +5953,7 @@ export interface CreateRelationalDatabaseResult {
5449
5953
  */
5450
5954
  export interface CreateRelationalDatabaseFromSnapshotRequest {
5451
5955
  /**
5956
+ * @public
5452
5957
  * <p>The name to use for your new Lightsail database resource.</p>
5453
5958
  * <p>Constraints:</p>
5454
5959
  * <ul>
@@ -5462,6 +5967,7 @@ export interface CreateRelationalDatabaseFromSnapshotRequest {
5462
5967
  */
5463
5968
  relationalDatabaseName: string | undefined;
5464
5969
  /**
5970
+ * @public
5465
5971
  * <p>The Availability Zone in which to create your new database. Use the
5466
5972
  * <code>us-east-2a</code> case-sensitive format.</p>
5467
5973
  * <p>You can get a list of Availability Zones by using the <code>get regions</code> operation.
@@ -5470,6 +5976,7 @@ export interface CreateRelationalDatabaseFromSnapshotRequest {
5470
5976
  */
5471
5977
  availabilityZone?: string;
5472
5978
  /**
5979
+ * @public
5473
5980
  * <p>Specifies the accessibility options for your new database. A value of <code>true</code>
5474
5981
  * specifies a database that is available to resources outside of your Lightsail account. A
5475
5982
  * value of <code>false</code> specifies a database that is available only to your Lightsail
@@ -5477,10 +5984,12 @@ export interface CreateRelationalDatabaseFromSnapshotRequest {
5477
5984
  */
5478
5985
  publiclyAccessible?: boolean;
5479
5986
  /**
5987
+ * @public
5480
5988
  * <p>The name of the database snapshot from which to create your new database.</p>
5481
5989
  */
5482
5990
  relationalDatabaseSnapshotName?: string;
5483
5991
  /**
5992
+ * @public
5484
5993
  * <p>The bundle ID for your new database. A bundle describes the performance specifications for
5485
5994
  * your database.</p>
5486
5995
  * <p>You can get a list of database bundle IDs by using the <code>get relational database
@@ -5490,10 +5999,12 @@ export interface CreateRelationalDatabaseFromSnapshotRequest {
5490
5999
  */
5491
6000
  relationalDatabaseBundleId?: string;
5492
6001
  /**
6002
+ * @public
5493
6003
  * <p>The name of the source database.</p>
5494
6004
  */
5495
6005
  sourceRelationalDatabaseName?: string;
5496
6006
  /**
6007
+ * @public
5497
6008
  * <p>The date and time to restore your database from.</p>
5498
6009
  * <p>Constraints:</p>
5499
6010
  * <ul>
@@ -5516,6 +6027,7 @@ export interface CreateRelationalDatabaseFromSnapshotRequest {
5516
6027
  */
5517
6028
  restoreTime?: Date;
5518
6029
  /**
6030
+ * @public
5519
6031
  * <p>Specifies whether your database is restored from the latest backup time. A value of
5520
6032
  * <code>true</code> restores from the latest backup time. </p>
5521
6033
  * <p>Default: <code>false</code>
@@ -5525,6 +6037,7 @@ export interface CreateRelationalDatabaseFromSnapshotRequest {
5525
6037
  */
5526
6038
  useLatestRestorableTime?: boolean;
5527
6039
  /**
6040
+ * @public
5528
6041
  * <p>The tag keys and optional values to add to the resource during create.</p>
5529
6042
  * <p>Use the <code>TagResource</code> action to tag a resource after it's created.</p>
5530
6043
  */
@@ -5535,6 +6048,7 @@ export interface CreateRelationalDatabaseFromSnapshotRequest {
5535
6048
  */
5536
6049
  export interface CreateRelationalDatabaseFromSnapshotResult {
5537
6050
  /**
6051
+ * @public
5538
6052
  * <p>An array of objects that describe the result of the action, such as the status of the
5539
6053
  * request, the timestamp of the request, and the resources affected by the request.</p>
5540
6054
  */
@@ -5545,10 +6059,12 @@ export interface CreateRelationalDatabaseFromSnapshotResult {
5545
6059
  */
5546
6060
  export interface CreateRelationalDatabaseSnapshotRequest {
5547
6061
  /**
6062
+ * @public
5548
6063
  * <p>The name of the database on which to base your new snapshot.</p>
5549
6064
  */
5550
6065
  relationalDatabaseName: string | undefined;
5551
6066
  /**
6067
+ * @public
5552
6068
  * <p>The name for your new database snapshot.</p>
5553
6069
  * <p>Constraints:</p>
5554
6070
  * <ul>
@@ -5562,6 +6078,7 @@ export interface CreateRelationalDatabaseSnapshotRequest {
5562
6078
  */
5563
6079
  relationalDatabaseSnapshotName: string | undefined;
5564
6080
  /**
6081
+ * @public
5565
6082
  * <p>The tag keys and optional values to add to the resource during create.</p>
5566
6083
  * <p>Use the <code>TagResource</code> action to tag a resource after it's created.</p>
5567
6084
  */
@@ -5572,6 +6089,7 @@ export interface CreateRelationalDatabaseSnapshotRequest {
5572
6089
  */
5573
6090
  export interface CreateRelationalDatabaseSnapshotResult {
5574
6091
  /**
6092
+ * @public
5575
6093
  * <p>An array of objects that describe the result of the action, such as the status of the
5576
6094
  * request, the timestamp of the request, and the resources affected by the request.</p>
5577
6095
  */
@@ -5582,6 +6100,7 @@ export interface CreateRelationalDatabaseSnapshotResult {
5582
6100
  */
5583
6101
  export interface DeleteAlarmRequest {
5584
6102
  /**
6103
+ * @public
5585
6104
  * <p>The name of the alarm to delete.</p>
5586
6105
  */
5587
6106
  alarmName: string | undefined;
@@ -5591,6 +6110,7 @@ export interface DeleteAlarmRequest {
5591
6110
  */
5592
6111
  export interface DeleteAlarmResult {
5593
6112
  /**
6113
+ * @public
5594
6114
  * <p>An array of objects that describe the result of the action, such as the status of the
5595
6115
  * request, the timestamp of the request, and the resources affected by the request.</p>
5596
6116
  */
@@ -5601,11 +6121,13 @@ export interface DeleteAlarmResult {
5601
6121
  */
5602
6122
  export interface DeleteAutoSnapshotRequest {
5603
6123
  /**
6124
+ * @public
5604
6125
  * <p>The name of the source instance or disk from which to delete the automatic
5605
6126
  * snapshot.</p>
5606
6127
  */
5607
6128
  resourceName: string | undefined;
5608
6129
  /**
6130
+ * @public
5609
6131
  * <p>The date of the automatic snapshot to delete in <code>YYYY-MM-DD</code> format. Use the
5610
6132
  * <code>get auto snapshots</code> operation to get the available automatic snapshots for a
5611
6133
  * resource.</p>
@@ -5617,6 +6139,7 @@ export interface DeleteAutoSnapshotRequest {
5617
6139
  */
5618
6140
  export interface DeleteAutoSnapshotResult {
5619
6141
  /**
6142
+ * @public
5620
6143
  * <p>An array of objects that describe the result of the action, such as the status of the
5621
6144
  * request, the timestamp of the request, and the resources affected by the request.</p>
5622
6145
  */
@@ -5627,12 +6150,14 @@ export interface DeleteAutoSnapshotResult {
5627
6150
  */
5628
6151
  export interface DeleteBucketRequest {
5629
6152
  /**
6153
+ * @public
5630
6154
  * <p>The name of the bucket to delete.</p>
5631
6155
  * <p>Use the <a href="https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBuckets.html">GetBuckets</a> action to get a list of bucket names
5632
6156
  * that you can specify.</p>
5633
6157
  */
5634
6158
  bucketName: string | undefined;
5635
6159
  /**
6160
+ * @public
5636
6161
  * <p>A Boolean value that indicates whether to force delete the bucket.</p>
5637
6162
  * <p>You must force delete the bucket if it has one of the following conditions:</p>
5638
6163
  * <ul>
@@ -5661,6 +6186,7 @@ export interface DeleteBucketRequest {
5661
6186
  */
5662
6187
  export interface DeleteBucketResult {
5663
6188
  /**
6189
+ * @public
5664
6190
  * <p>An array of objects that describe the result of the action, such as the status of the
5665
6191
  * request, the timestamp of the request, and the resources affected by the request.</p>
5666
6192
  */
@@ -5671,10 +6197,12 @@ export interface DeleteBucketResult {
5671
6197
  */
5672
6198
  export interface DeleteBucketAccessKeyRequest {
5673
6199
  /**
6200
+ * @public
5674
6201
  * <p>The name of the bucket that the access key belongs to.</p>
5675
6202
  */
5676
6203
  bucketName: string | undefined;
5677
6204
  /**
6205
+ * @public
5678
6206
  * <p>The ID of the access key to delete.</p>
5679
6207
  * <p>Use the <a href="https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketAccessKeys.html">GetBucketAccessKeys</a> action to get a
5680
6208
  * list of access key IDs that you can specify.</p>
@@ -5686,6 +6214,7 @@ export interface DeleteBucketAccessKeyRequest {
5686
6214
  */
5687
6215
  export interface DeleteBucketAccessKeyResult {
5688
6216
  /**
6217
+ * @public
5689
6218
  * <p>An array of objects that describe the result of the action, such as the status of the
5690
6219
  * request, the timestamp of the request, and the resources affected by the request.</p>
5691
6220
  */
@@ -5696,6 +6225,7 @@ export interface DeleteBucketAccessKeyResult {
5696
6225
  */
5697
6226
  export interface DeleteCertificateRequest {
5698
6227
  /**
6228
+ * @public
5699
6229
  * <p>The name of the certificate to delete.</p>
5700
6230
  * <p>Use the <code>GetCertificates</code> action to get a list of certificate names that you
5701
6231
  * can specify.</p>
@@ -5707,6 +6237,7 @@ export interface DeleteCertificateRequest {
5707
6237
  */
5708
6238
  export interface DeleteCertificateResult {
5709
6239
  /**
6240
+ * @public
5710
6241
  * <p>An array of objects that describe the result of the action, such as the status of the
5711
6242
  * request, the timestamp of the request, and the resources affected by the request.</p>
5712
6243
  */
@@ -5717,6 +6248,7 @@ export interface DeleteCertificateResult {
5717
6248
  */
5718
6249
  export interface DeleteContactMethodRequest {
5719
6250
  /**
6251
+ * @public
5720
6252
  * <p>The protocol that will be deleted, such as <code>Email</code> or <code>SMS</code> (text
5721
6253
  * messaging).</p>
5722
6254
  * <note>
@@ -5732,6 +6264,7 @@ export interface DeleteContactMethodRequest {
5732
6264
  */
5733
6265
  export interface DeleteContactMethodResult {
5734
6266
  /**
6267
+ * @public
5735
6268
  * <p>An array of objects that describe the result of the action, such as the status of the
5736
6269
  * request, the timestamp of the request, and the resources affected by the request.</p>
5737
6270
  */
@@ -5742,10 +6275,12 @@ export interface DeleteContactMethodResult {
5742
6275
  */
5743
6276
  export interface DeleteContainerImageRequest {
5744
6277
  /**
6278
+ * @public
5745
6279
  * <p>The name of the container service for which to delete a registered container image.</p>
5746
6280
  */
5747
6281
  serviceName: string | undefined;
5748
6282
  /**
6283
+ * @public
5749
6284
  * <p>The name of the container image to delete from the container service.</p>
5750
6285
  * <p>Use the <code>GetContainerImages</code> action to get the name of the container images
5751
6286
  * that are registered to a container service.</p>
@@ -5769,6 +6304,7 @@ export interface DeleteContainerImageResult {
5769
6304
  */
5770
6305
  export interface DeleteContainerServiceRequest {
5771
6306
  /**
6307
+ * @public
5772
6308
  * <p>The name of the container service to delete.</p>
5773
6309
  */
5774
6310
  serviceName: string | undefined;
@@ -5783,10 +6319,12 @@ export interface DeleteContainerServiceResult {
5783
6319
  */
5784
6320
  export interface DeleteDiskRequest {
5785
6321
  /**
6322
+ * @public
5786
6323
  * <p>The unique name of the disk you want to delete (e.g., <code>my-disk</code>).</p>
5787
6324
  */
5788
6325
  diskName: string | undefined;
5789
6326
  /**
6327
+ * @public
5790
6328
  * <p>A Boolean value to indicate whether to delete all add-ons for the disk.</p>
5791
6329
  */
5792
6330
  forceDeleteAddOns?: boolean;
@@ -5796,6 +6334,7 @@ export interface DeleteDiskRequest {
5796
6334
  */
5797
6335
  export interface DeleteDiskResult {
5798
6336
  /**
6337
+ * @public
5799
6338
  * <p>An array of objects that describe the result of the action, such as the status of the
5800
6339
  * request, the timestamp of the request, and the resources affected by the request.</p>
5801
6340
  */
@@ -5806,6 +6345,7 @@ export interface DeleteDiskResult {
5806
6345
  */
5807
6346
  export interface DeleteDiskSnapshotRequest {
5808
6347
  /**
6348
+ * @public
5809
6349
  * <p>The name of the disk snapshot you want to delete (e.g.,
5810
6350
  * <code>my-disk-snapshot</code>).</p>
5811
6351
  */
@@ -5816,6 +6356,7 @@ export interface DeleteDiskSnapshotRequest {
5816
6356
  */
5817
6357
  export interface DeleteDiskSnapshotResult {
5818
6358
  /**
6359
+ * @public
5819
6360
  * <p>An array of objects that describe the result of the action, such as the status of the
5820
6361
  * request, the timestamp of the request, and the resources affected by the request.</p>
5821
6362
  */
@@ -5826,6 +6367,7 @@ export interface DeleteDiskSnapshotResult {
5826
6367
  */
5827
6368
  export interface DeleteDistributionRequest {
5828
6369
  /**
6370
+ * @public
5829
6371
  * <p>The name of the distribution to delete.</p>
5830
6372
  * <p>Use the <code>GetDistributions</code> action to get a list of distribution names that you
5831
6373
  * can specify.</p>
@@ -5837,6 +6379,7 @@ export interface DeleteDistributionRequest {
5837
6379
  */
5838
6380
  export interface DeleteDistributionResult {
5839
6381
  /**
6382
+ * @public
5840
6383
  * <p>An object that describes the result of the action, such as the status of the request, the
5841
6384
  * timestamp of the request, and the resources affected by the request.</p>
5842
6385
  */
@@ -5847,6 +6390,7 @@ export interface DeleteDistributionResult {
5847
6390
  */
5848
6391
  export interface DeleteDomainRequest {
5849
6392
  /**
6393
+ * @public
5850
6394
  * <p>The specific domain name to delete.</p>
5851
6395
  */
5852
6396
  domainName: string | undefined;
@@ -5856,6 +6400,7 @@ export interface DeleteDomainRequest {
5856
6400
  */
5857
6401
  export interface DeleteDomainResult {
5858
6402
  /**
6403
+ * @public
5859
6404
  * <p>An array of objects that describe the result of the action, such as the status of the
5860
6405
  * request, the timestamp of the request, and the resources affected by the request.</p>
5861
6406
  */
@@ -5866,10 +6411,12 @@ export interface DeleteDomainResult {
5866
6411
  */
5867
6412
  export interface DeleteDomainEntryRequest {
5868
6413
  /**
6414
+ * @public
5869
6415
  * <p>The name of the domain entry to delete.</p>
5870
6416
  */
5871
6417
  domainName: string | undefined;
5872
6418
  /**
6419
+ * @public
5873
6420
  * <p>An array of key-value pairs containing information about your domain entries.</p>
5874
6421
  */
5875
6422
  domainEntry: DomainEntry | undefined;
@@ -5879,6 +6426,7 @@ export interface DeleteDomainEntryRequest {
5879
6426
  */
5880
6427
  export interface DeleteDomainEntryResult {
5881
6428
  /**
6429
+ * @public
5882
6430
  * <p>An array of objects that describe the result of the action, such as the status of the
5883
6431
  * request, the timestamp of the request, and the resources affected by the request.</p>
5884
6432
  */
@@ -5889,10 +6437,12 @@ export interface DeleteDomainEntryResult {
5889
6437
  */
5890
6438
  export interface DeleteInstanceRequest {
5891
6439
  /**
6440
+ * @public
5892
6441
  * <p>The name of the instance to delete.</p>
5893
6442
  */
5894
6443
  instanceName: string | undefined;
5895
6444
  /**
6445
+ * @public
5896
6446
  * <p>A Boolean value to indicate whether to delete all add-ons for the instance.</p>
5897
6447
  */
5898
6448
  forceDeleteAddOns?: boolean;
@@ -5902,6 +6452,7 @@ export interface DeleteInstanceRequest {
5902
6452
  */
5903
6453
  export interface DeleteInstanceResult {
5904
6454
  /**
6455
+ * @public
5905
6456
  * <p>An array of objects that describe the result of the action, such as the status of the
5906
6457
  * request, the timestamp of the request, and the resources affected by the request.</p>
5907
6458
  */
@@ -5912,6 +6463,7 @@ export interface DeleteInstanceResult {
5912
6463
  */
5913
6464
  export interface DeleteInstanceSnapshotRequest {
5914
6465
  /**
6466
+ * @public
5915
6467
  * <p>The name of the snapshot to delete.</p>
5916
6468
  */
5917
6469
  instanceSnapshotName: string | undefined;
@@ -5921,6 +6473,7 @@ export interface DeleteInstanceSnapshotRequest {
5921
6473
  */
5922
6474
  export interface DeleteInstanceSnapshotResult {
5923
6475
  /**
6476
+ * @public
5924
6477
  * <p>An array of objects that describe the result of the action, such as the status of the
5925
6478
  * request, the timestamp of the request, and the resources affected by the request.</p>
5926
6479
  */
@@ -5931,10 +6484,12 @@ export interface DeleteInstanceSnapshotResult {
5931
6484
  */
5932
6485
  export interface DeleteKeyPairRequest {
5933
6486
  /**
6487
+ * @public
5934
6488
  * <p>The name of the key pair to delete.</p>
5935
6489
  */
5936
6490
  keyPairName: string | undefined;
5937
6491
  /**
6492
+ * @public
5938
6493
  * <p>The RSA fingerprint of the Lightsail default key pair to delete.</p>
5939
6494
  * <note>
5940
6495
  * <p>The <code>expectedFingerprint</code> parameter is required only when specifying to
@@ -5948,6 +6503,7 @@ export interface DeleteKeyPairRequest {
5948
6503
  */
5949
6504
  export interface DeleteKeyPairResult {
5950
6505
  /**
6506
+ * @public
5951
6507
  * <p>An array of objects that describe the result of the action, such as the status of the
5952
6508
  * request, the timestamp of the request, and the resources affected by the request.</p>
5953
6509
  */
@@ -5958,6 +6514,7 @@ export interface DeleteKeyPairResult {
5958
6514
  */
5959
6515
  export interface DeleteKnownHostKeysRequest {
5960
6516
  /**
6517
+ * @public
5961
6518
  * <p>The name of the instance for which you want to reset the host key or certificate.</p>
5962
6519
  */
5963
6520
  instanceName: string | undefined;
@@ -5967,6 +6524,7 @@ export interface DeleteKnownHostKeysRequest {
5967
6524
  */
5968
6525
  export interface DeleteKnownHostKeysResult {
5969
6526
  /**
6527
+ * @public
5970
6528
  * <p>An array of objects that describe the result of the action, such as the status of the
5971
6529
  * request, the timestamp of the request, and the resources affected by the request.</p>
5972
6530
  */
@@ -5977,6 +6535,7 @@ export interface DeleteKnownHostKeysResult {
5977
6535
  */
5978
6536
  export interface DeleteLoadBalancerRequest {
5979
6537
  /**
6538
+ * @public
5980
6539
  * <p>The name of the load balancer you want to delete.</p>
5981
6540
  */
5982
6541
  loadBalancerName: string | undefined;
@@ -5986,6 +6545,7 @@ export interface DeleteLoadBalancerRequest {
5986
6545
  */
5987
6546
  export interface DeleteLoadBalancerResult {
5988
6547
  /**
6548
+ * @public
5989
6549
  * <p>An array of objects that describe the result of the action, such as the status of the
5990
6550
  * request, the timestamp of the request, and the resources affected by the request.</p>
5991
6551
  */
@@ -5996,14 +6556,17 @@ export interface DeleteLoadBalancerResult {
5996
6556
  */
5997
6557
  export interface DeleteLoadBalancerTlsCertificateRequest {
5998
6558
  /**
6559
+ * @public
5999
6560
  * <p>The load balancer name.</p>
6000
6561
  */
6001
6562
  loadBalancerName: string | undefined;
6002
6563
  /**
6564
+ * @public
6003
6565
  * <p>The SSL/TLS certificate name.</p>
6004
6566
  */
6005
6567
  certificateName: string | undefined;
6006
6568
  /**
6569
+ * @public
6007
6570
  * <p>When <code>true</code>, forces the deletion of an SSL/TLS certificate.</p>
6008
6571
  * <p>There can be two certificates associated with a Lightsail load balancer: the primary and
6009
6572
  * the backup. The <code>force</code> parameter is required when the primary SSL/TLS certificate
@@ -6016,6 +6579,7 @@ export interface DeleteLoadBalancerTlsCertificateRequest {
6016
6579
  */
6017
6580
  export interface DeleteLoadBalancerTlsCertificateResult {
6018
6581
  /**
6582
+ * @public
6019
6583
  * <p>An array of objects that describe the result of the action, such as the status of the
6020
6584
  * request, the timestamp of the request, and the resources affected by the request.</p>
6021
6585
  */
@@ -6026,10 +6590,12 @@ export interface DeleteLoadBalancerTlsCertificateResult {
6026
6590
  */
6027
6591
  export interface DeleteRelationalDatabaseRequest {
6028
6592
  /**
6593
+ * @public
6029
6594
  * <p>The name of the database that you are deleting.</p>
6030
6595
  */
6031
6596
  relationalDatabaseName: string | undefined;
6032
6597
  /**
6598
+ * @public
6033
6599
  * <p>Determines whether a final database snapshot is created before your database is deleted.
6034
6600
  * If <code>true</code> is specified, no database snapshot is created. If <code>false</code> is
6035
6601
  * specified, a database snapshot is created before your database is deleted.</p>
@@ -6040,6 +6606,7 @@ export interface DeleteRelationalDatabaseRequest {
6040
6606
  */
6041
6607
  skipFinalSnapshot?: boolean;
6042
6608
  /**
6609
+ * @public
6043
6610
  * <p>The name of the database snapshot created if <code>skip final snapshot</code> is
6044
6611
  * <code>false</code>, which is the default value for that parameter.</p>
6045
6612
  * <note>
@@ -6063,6 +6630,7 @@ export interface DeleteRelationalDatabaseRequest {
6063
6630
  */
6064
6631
  export interface DeleteRelationalDatabaseResult {
6065
6632
  /**
6633
+ * @public
6066
6634
  * <p>An array of objects that describe the result of the action, such as the status of the
6067
6635
  * request, the timestamp of the request, and the resources affected by the request.</p>
6068
6636
  */
@@ -6073,6 +6641,7 @@ export interface DeleteRelationalDatabaseResult {
6073
6641
  */
6074
6642
  export interface DeleteRelationalDatabaseSnapshotRequest {
6075
6643
  /**
6644
+ * @public
6076
6645
  * <p>The name of the database snapshot that you are deleting.</p>
6077
6646
  */
6078
6647
  relationalDatabaseSnapshotName: string | undefined;
@@ -6082,6 +6651,7 @@ export interface DeleteRelationalDatabaseSnapshotRequest {
6082
6651
  */
6083
6652
  export interface DeleteRelationalDatabaseSnapshotResult {
6084
6653
  /**
6654
+ * @public
6085
6655
  * <p>An array of objects that describe the result of the action, such as the status of the
6086
6656
  * request, the timestamp of the request, and the resources affected by the request.</p>
6087
6657
  */
@@ -6092,6 +6662,7 @@ export interface DeleteRelationalDatabaseSnapshotResult {
6092
6662
  */
6093
6663
  export interface DetachCertificateFromDistributionRequest {
6094
6664
  /**
6665
+ * @public
6095
6666
  * <p>The name of the distribution from which to detach the certificate.</p>
6096
6667
  * <p>Use the <code>GetDistributions</code> action to get a list of distribution names that you
6097
6668
  * can specify.</p>
@@ -6103,6 +6674,7 @@ export interface DetachCertificateFromDistributionRequest {
6103
6674
  */
6104
6675
  export interface DetachCertificateFromDistributionResult {
6105
6676
  /**
6677
+ * @public
6106
6678
  * <p>An object that describes the result of the action, such as the status of the request, the
6107
6679
  * timestamp of the request, and the resources affected by the request.</p>
6108
6680
  */
@@ -6113,6 +6685,7 @@ export interface DetachCertificateFromDistributionResult {
6113
6685
  */
6114
6686
  export interface DetachDiskRequest {
6115
6687
  /**
6688
+ * @public
6116
6689
  * <p>The unique name of the disk you want to detach from your instance (e.g.,
6117
6690
  * <code>my-disk</code>).</p>
6118
6691
  */
@@ -6123,6 +6696,7 @@ export interface DetachDiskRequest {
6123
6696
  */
6124
6697
  export interface DetachDiskResult {
6125
6698
  /**
6699
+ * @public
6126
6700
  * <p>An array of objects that describe the result of the action, such as the status of the
6127
6701
  * request, the timestamp of the request, and the resources affected by the request.</p>
6128
6702
  */
@@ -6133,10 +6707,12 @@ export interface DetachDiskResult {
6133
6707
  */
6134
6708
  export interface DetachInstancesFromLoadBalancerRequest {
6135
6709
  /**
6710
+ * @public
6136
6711
  * <p>The name of the Lightsail load balancer.</p>
6137
6712
  */
6138
6713
  loadBalancerName: string | undefined;
6139
6714
  /**
6715
+ * @public
6140
6716
  * <p>An array of strings containing the names of the instances you want to detach from the load
6141
6717
  * balancer.</p>
6142
6718
  */
@@ -6147,6 +6723,7 @@ export interface DetachInstancesFromLoadBalancerRequest {
6147
6723
  */
6148
6724
  export interface DetachInstancesFromLoadBalancerResult {
6149
6725
  /**
6726
+ * @public
6150
6727
  * <p>An array of objects that describe the result of the action, such as the status of the
6151
6728
  * request, the timestamp of the request, and the resources affected by the request.</p>
6152
6729
  */
@@ -6157,6 +6734,7 @@ export interface DetachInstancesFromLoadBalancerResult {
6157
6734
  */
6158
6735
  export interface DetachStaticIpRequest {
6159
6736
  /**
6737
+ * @public
6160
6738
  * <p>The name of the static IP to detach from the instance.</p>
6161
6739
  */
6162
6740
  staticIpName: string | undefined;
@@ -6166,6 +6744,7 @@ export interface DetachStaticIpRequest {
6166
6744
  */
6167
6745
  export interface DetachStaticIpResult {
6168
6746
  /**
6747
+ * @public
6169
6748
  * <p>An array of objects that describe the result of the action, such as the status of the
6170
6749
  * request, the timestamp of the request, and the resources affected by the request.</p>
6171
6750
  */
@@ -6176,10 +6755,12 @@ export interface DetachStaticIpResult {
6176
6755
  */
6177
6756
  export interface DisableAddOnRequest {
6178
6757
  /**
6758
+ * @public
6179
6759
  * <p>The add-on type to disable.</p>
6180
6760
  */
6181
6761
  addOnType: AddOnType | string | undefined;
6182
6762
  /**
6763
+ * @public
6183
6764
  * <p>The name of the source resource for which to disable the add-on.</p>
6184
6765
  */
6185
6766
  resourceName: string | undefined;
@@ -6189,6 +6770,7 @@ export interface DisableAddOnRequest {
6189
6770
  */
6190
6771
  export interface DisableAddOnResult {
6191
6772
  /**
6773
+ * @public
6192
6774
  * <p>An array of objects that describe the result of the action, such as the status of the
6193
6775
  * request, the timestamp of the request, and the resources affected by the request.</p>
6194
6776
  */
@@ -6215,70 +6797,86 @@ export type DiskState = (typeof DiskState)[keyof typeof DiskState];
6215
6797
  */
6216
6798
  export interface Disk {
6217
6799
  /**
6800
+ * @public
6218
6801
  * <p>The unique name of the disk.</p>
6219
6802
  */
6220
6803
  name?: string;
6221
6804
  /**
6805
+ * @public
6222
6806
  * <p>The Amazon Resource Name (ARN) of the disk.</p>
6223
6807
  */
6224
6808
  arn?: string;
6225
6809
  /**
6810
+ * @public
6226
6811
  * <p>The support code. Include this code in your email to support when you have questions about
6227
6812
  * an instance or another resource in Lightsail. This code enables our support team to look up
6228
6813
  * your Lightsail information more easily.</p>
6229
6814
  */
6230
6815
  supportCode?: string;
6231
6816
  /**
6817
+ * @public
6232
6818
  * <p>The date when the disk was created.</p>
6233
6819
  */
6234
6820
  createdAt?: Date;
6235
6821
  /**
6822
+ * @public
6236
6823
  * <p>The AWS Region and Availability Zone where the disk is located.</p>
6237
6824
  */
6238
6825
  location?: ResourceLocation;
6239
6826
  /**
6827
+ * @public
6240
6828
  * <p>The Lightsail resource type (e.g., <code>Disk</code>).</p>
6241
6829
  */
6242
6830
  resourceType?: ResourceType | string;
6243
6831
  /**
6832
+ * @public
6244
6833
  * <p>The tag keys and optional values for the resource. For more information about tags in
6245
6834
  * Lightsail, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags">Amazon Lightsail Developer Guide</a>.</p>
6246
6835
  */
6247
6836
  tags?: Tag[];
6248
6837
  /**
6838
+ * @public
6249
6839
  * <p>An array of objects representing the add-ons enabled on the disk.</p>
6250
6840
  */
6251
6841
  addOns?: AddOn[];
6252
6842
  /**
6843
+ * @public
6253
6844
  * <p>The size of the disk in GB.</p>
6254
6845
  */
6255
6846
  sizeInGb?: number;
6256
6847
  /**
6848
+ * @public
6257
6849
  * <p>A Boolean value indicating whether this disk is a system disk (has an operating system
6258
6850
  * loaded on it).</p>
6259
6851
  */
6260
6852
  isSystemDisk?: boolean;
6261
6853
  /**
6854
+ * @public
6262
6855
  * <p>The input/output operations per second (IOPS) of the disk.</p>
6263
6856
  */
6264
6857
  iops?: number;
6265
6858
  /**
6859
+ * @public
6266
6860
  * <p>The disk path.</p>
6267
6861
  */
6268
6862
  path?: string;
6269
6863
  /**
6864
+ * @public
6270
6865
  * <p>Describes the status of the disk.</p>
6271
6866
  */
6272
6867
  state?: DiskState | string;
6273
6868
  /**
6869
+ * @public
6274
6870
  * <p>The resources to which the disk is attached.</p>
6275
6871
  */
6276
6872
  attachedTo?: string;
6277
6873
  /**
6874
+ * @public
6278
6875
  * <p>A Boolean value indicating whether the disk is attached.</p>
6279
6876
  */
6280
6877
  isAttached?: boolean;
6281
6878
  /**
6879
+ * @public
6282
6880
  * @deprecated
6283
6881
  *
6284
6882
  * <p>(Deprecated) The attachment state of the disk.</p>
@@ -6290,6 +6888,7 @@ export interface Disk {
6290
6888
  */
6291
6889
  attachmentState?: string;
6292
6890
  /**
6891
+ * @public
6293
6892
  * @deprecated
6294
6893
  *
6295
6894
  * <p>(Deprecated) The number of GB in use by the disk.</p>
@@ -6300,6 +6899,7 @@ export interface Disk {
6300
6899
  */
6301
6900
  gbInUse?: number;
6302
6901
  /**
6902
+ * @public
6303
6903
  * <p>The status of automatically mounting a storage disk to a virtual computer.</p>
6304
6904
  * <important>
6305
6905
  * <p>This parameter only applies to Lightsail for Research resources.</p>
@@ -6313,18 +6913,22 @@ export interface Disk {
6313
6913
  */
6314
6914
  export interface DiskInfo {
6315
6915
  /**
6916
+ * @public
6316
6917
  * <p>The disk name.</p>
6317
6918
  */
6318
6919
  name?: string;
6319
6920
  /**
6921
+ * @public
6320
6922
  * <p>The disk path.</p>
6321
6923
  */
6322
6924
  path?: string;
6323
6925
  /**
6926
+ * @public
6324
6927
  * <p>The size of the disk in GB (e.g., <code>32</code>).</p>
6325
6928
  */
6326
6929
  sizeInGb?: number;
6327
6930
  /**
6931
+ * @public
6328
6932
  * <p>A Boolean value indicating whether this disk is a system disk (has an operating system
6329
6933
  * loaded on it).</p>
6330
6934
  */
@@ -6350,68 +6954,83 @@ export type DiskSnapshotState = (typeof DiskSnapshotState)[keyof typeof DiskSnap
6350
6954
  */
6351
6955
  export interface DiskSnapshot {
6352
6956
  /**
6957
+ * @public
6353
6958
  * <p>The name of the disk snapshot (e.g., <code>my-disk-snapshot</code>).</p>
6354
6959
  */
6355
6960
  name?: string;
6356
6961
  /**
6962
+ * @public
6357
6963
  * <p>The Amazon Resource Name (ARN) of the disk snapshot.</p>
6358
6964
  */
6359
6965
  arn?: string;
6360
6966
  /**
6967
+ * @public
6361
6968
  * <p>The support code. Include this code in your email to support when you have questions about
6362
6969
  * an instance or another resource in Lightsail. This code enables our support team to look up
6363
6970
  * your Lightsail information more easily.</p>
6364
6971
  */
6365
6972
  supportCode?: string;
6366
6973
  /**
6974
+ * @public
6367
6975
  * <p>The date when the disk snapshot was created.</p>
6368
6976
  */
6369
6977
  createdAt?: Date;
6370
6978
  /**
6979
+ * @public
6371
6980
  * <p>The AWS Region and Availability Zone where the disk snapshot was created.</p>
6372
6981
  */
6373
6982
  location?: ResourceLocation;
6374
6983
  /**
6984
+ * @public
6375
6985
  * <p>The Lightsail resource type (e.g., <code>DiskSnapshot</code>).</p>
6376
6986
  */
6377
6987
  resourceType?: ResourceType | string;
6378
6988
  /**
6989
+ * @public
6379
6990
  * <p>The tag keys and optional values for the resource. For more information about tags in
6380
6991
  * Lightsail, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags">Amazon Lightsail Developer Guide</a>.</p>
6381
6992
  */
6382
6993
  tags?: Tag[];
6383
6994
  /**
6995
+ * @public
6384
6996
  * <p>The size of the disk in GB.</p>
6385
6997
  */
6386
6998
  sizeInGb?: number;
6387
6999
  /**
7000
+ * @public
6388
7001
  * <p>The status of the disk snapshot operation.</p>
6389
7002
  */
6390
7003
  state?: DiskSnapshotState | string;
6391
7004
  /**
7005
+ * @public
6392
7006
  * <p>The progress of the snapshot.</p>
6393
7007
  */
6394
7008
  progress?: string;
6395
7009
  /**
7010
+ * @public
6396
7011
  * <p>The unique name of the source disk from which the disk snapshot was created.</p>
6397
7012
  */
6398
7013
  fromDiskName?: string;
6399
7014
  /**
7015
+ * @public
6400
7016
  * <p>The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was
6401
7017
  * created.</p>
6402
7018
  */
6403
7019
  fromDiskArn?: string;
6404
7020
  /**
7021
+ * @public
6405
7022
  * <p>The unique name of the source instance from which the disk (system volume) snapshot was
6406
7023
  * created.</p>
6407
7024
  */
6408
7025
  fromInstanceName?: string;
6409
7026
  /**
7027
+ * @public
6410
7028
  * <p>The Amazon Resource Name (ARN) of the source instance from which the disk (system volume)
6411
7029
  * snapshot was created.</p>
6412
7030
  */
6413
7031
  fromInstanceArn?: string;
6414
7032
  /**
7033
+ * @public
6415
7034
  * <p>A Boolean value indicating whether the snapshot was created from an automatic
6416
7035
  * snapshot.</p>
6417
7036
  */
@@ -6423,6 +7042,7 @@ export interface DiskSnapshot {
6423
7042
  */
6424
7043
  export interface DiskSnapshotInfo {
6425
7044
  /**
7045
+ * @public
6426
7046
  * <p>The size of the disk in GB (e.g., <code>32</code>).</p>
6427
7047
  */
6428
7048
  sizeInGb?: number;
@@ -6433,22 +7053,27 @@ export interface DiskSnapshotInfo {
6433
7053
  */
6434
7054
  export interface DistributionBundle {
6435
7055
  /**
7056
+ * @public
6436
7057
  * <p>The ID of the bundle.</p>
6437
7058
  */
6438
7059
  bundleId?: string;
6439
7060
  /**
7061
+ * @public
6440
7062
  * <p>The name of the distribution bundle.</p>
6441
7063
  */
6442
7064
  name?: string;
6443
7065
  /**
7066
+ * @public
6444
7067
  * <p>The monthly price, in US dollars, of the bundle.</p>
6445
7068
  */
6446
7069
  price?: number;
6447
7070
  /**
7071
+ * @public
6448
7072
  * <p>The monthly network transfer quota of the bundle.</p>
6449
7073
  */
6450
7074
  transferPerMonthInGb?: number;
6451
7075
  /**
7076
+ * @public
6452
7077
  * <p>Indicates whether the bundle is active, and can be specified for a new or existing
6453
7078
  * distribution.</p>
6454
7079
  */
@@ -6493,6 +7118,7 @@ export type NameServersUpdateStateCode = (typeof NameServersUpdateStateCode)[key
6493
7118
  */
6494
7119
  export interface NameServersUpdateState {
6495
7120
  /**
7121
+ * @public
6496
7122
  * <p>The status code for the name servers update.</p>
6497
7123
  * <p>Following are the possible values:</p>
6498
7124
  * <ul>
@@ -6516,6 +7142,7 @@ export interface NameServersUpdateState {
6516
7142
  */
6517
7143
  code?: NameServersUpdateStateCode | string;
6518
7144
  /**
7145
+ * @public
6519
7146
  * <p>The message that describes the reason for the status code.</p>
6520
7147
  */
6521
7148
  message?: string;
@@ -6541,6 +7168,7 @@ export type R53HostedZoneDeletionStateCode = (typeof R53HostedZoneDeletionStateC
6541
7168
  */
6542
7169
  export interface R53HostedZoneDeletionState {
6543
7170
  /**
7171
+ * @public
6544
7172
  * <p>The status code for the deletion state.</p>
6545
7173
  * <p>Following are the possible values:</p>
6546
7174
  * <ul>
@@ -6564,6 +7192,7 @@ export interface R53HostedZoneDeletionState {
6564
7192
  */
6565
7193
  code?: R53HostedZoneDeletionStateCode | string;
6566
7194
  /**
7195
+ * @public
6567
7196
  * <p>The message that describes the reason for the status code.</p>
6568
7197
  */
6569
7198
  message?: string;
@@ -6598,11 +7227,13 @@ export interface R53HostedZoneDeletionState {
6598
7227
  */
6599
7228
  export interface RegisteredDomainDelegationInfo {
6600
7229
  /**
7230
+ * @public
6601
7231
  * <p>An object that describes the state of the name server records that are automatically added
6602
7232
  * to the Route 53 domain by Lightsail.</p>
6603
7233
  */
6604
7234
  nameServersUpdateState?: NameServersUpdateState;
6605
7235
  /**
7236
+ * @public
6606
7237
  * <p>Describes the deletion state of an Amazon Route 53 hosted zone for a domain that is
6607
7238
  * being automatically delegated to an Amazon Lightsail DNS zone.</p>
6608
7239
  */
@@ -6614,42 +7245,51 @@ export interface RegisteredDomainDelegationInfo {
6614
7245
  */
6615
7246
  export interface Domain {
6616
7247
  /**
7248
+ * @public
6617
7249
  * <p>The name of the domain.</p>
6618
7250
  */
6619
7251
  name?: string;
6620
7252
  /**
7253
+ * @public
6621
7254
  * <p>The Amazon Resource Name (ARN) of the domain recordset (e.g.,
6622
7255
  * <code>arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE</code>).</p>
6623
7256
  */
6624
7257
  arn?: string;
6625
7258
  /**
7259
+ * @public
6626
7260
  * <p>The support code. Include this code in your email to support when you have questions about
6627
7261
  * an instance or another resource in Lightsail. This code enables our support team to look up
6628
7262
  * your Lightsail information more easily.</p>
6629
7263
  */
6630
7264
  supportCode?: string;
6631
7265
  /**
7266
+ * @public
6632
7267
  * <p>The date when the domain recordset was created.</p>
6633
7268
  */
6634
7269
  createdAt?: Date;
6635
7270
  /**
7271
+ * @public
6636
7272
  * <p>The AWS Region and Availability Zones where the domain recordset was created.</p>
6637
7273
  */
6638
7274
  location?: ResourceLocation;
6639
7275
  /**
7276
+ * @public
6640
7277
  * <p>The resource type. </p>
6641
7278
  */
6642
7279
  resourceType?: ResourceType | string;
6643
7280
  /**
7281
+ * @public
6644
7282
  * <p>The tag keys and optional values for the resource. For more information about tags in
6645
7283
  * Lightsail, see the <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags">Amazon Lightsail Developer Guide</a>.</p>
6646
7284
  */
6647
7285
  tags?: Tag[];
6648
7286
  /**
7287
+ * @public
6649
7288
  * <p>An array of key-value pairs containing information about the domain entries.</p>
6650
7289
  */
6651
7290
  domainEntries?: DomainEntry[];
6652
7291
  /**
7292
+ * @public
6653
7293
  * <p>An object that describes the state of the Route 53 domain delegation to a
6654
7294
  * Lightsail DNS zone.</p>
6655
7295
  */
@@ -6665,14 +7305,17 @@ export interface DownloadDefaultKeyPairRequest {
6665
7305
  */
6666
7306
  export interface DownloadDefaultKeyPairResult {
6667
7307
  /**
7308
+ * @public
6668
7309
  * <p>A base64-encoded public key of the <code>ssh-rsa</code> type.</p>
6669
7310
  */
6670
7311
  publicKeyBase64?: string;
6671
7312
  /**
7313
+ * @public
6672
7314
  * <p>A base64-encoded RSA private key.</p>
6673
7315
  */
6674
7316
  privateKeyBase64?: string;
6675
7317
  /**
7318
+ * @public
6676
7319
  * <p>The timestamp when the default key pair was created.</p>
6677
7320
  */
6678
7321
  createdAt?: Date;
@@ -6682,10 +7325,12 @@ export interface DownloadDefaultKeyPairResult {
6682
7325
  */
6683
7326
  export interface EnableAddOnRequest {
6684
7327
  /**
7328
+ * @public
6685
7329
  * <p>The name of the source resource for which to enable or modify the add-on.</p>
6686
7330
  */
6687
7331
  resourceName: string | undefined;
6688
7332
  /**
7333
+ * @public
6689
7334
  * <p>An array of strings representing the add-on to enable or modify.</p>
6690
7335
  */
6691
7336
  addOnRequest: AddOnRequest | undefined;
@@ -6695,6 +7340,7 @@ export interface EnableAddOnRequest {
6695
7340
  */
6696
7341
  export interface EnableAddOnResult {
6697
7342
  /**
7343
+ * @public
6698
7344
  * <p>An array of objects that describe the result of the action, such as the status of the
6699
7345
  * request, the timestamp of the request, and the resources affected by the request.</p>
6700
7346
  */
@@ -6705,6 +7351,7 @@ export interface EnableAddOnResult {
6705
7351
  */
6706
7352
  export interface ExportSnapshotRequest {
6707
7353
  /**
7354
+ * @public
6708
7355
  * <p>The name of the instance or disk snapshot to be exported to Amazon EC2.</p>
6709
7356
  */
6710
7357
  sourceSnapshotName: string | undefined;
@@ -6714,6 +7361,7 @@ export interface ExportSnapshotRequest {
6714
7361
  */
6715
7362
  export interface ExportSnapshotResult {
6716
7363
  /**
7364
+ * @public
6717
7365
  * <p>An array of objects that describe the result of the action, such as the status of the
6718
7366
  * request, the timestamp of the request, and the resources affected by the request.</p>
6719
7367
  */
@@ -6725,15 +7373,18 @@ export interface ExportSnapshotResult {
6725
7373
  */
6726
7374
  export interface InstanceSnapshotInfo {
6727
7375
  /**
7376
+ * @public
6728
7377
  * <p>The bundle ID from which the source instance was created (e.g.,
6729
7378
  * <code>micro_1_0</code>).</p>
6730
7379
  */
6731
7380
  fromBundleId?: string;
6732
7381
  /**
7382
+ * @public
6733
7383
  * <p>The blueprint ID from which the source instance (e.g., <code>os_debian_8_3</code>).</p>
6734
7384
  */
6735
7385
  fromBlueprintId?: string;
6736
7386
  /**
7387
+ * @public
6737
7388
  * <p>A list of objects describing the disks that were attached to the source instance.</p>
6738
7389
  */
6739
7390
  fromDiskInfo?: DiskInfo[];
@@ -6756,35 +7407,43 @@ export type ExportSnapshotRecordSourceType = (typeof ExportSnapshotRecordSourceT
6756
7407
  */
6757
7408
  export interface ExportSnapshotRecordSourceInfo {
6758
7409
  /**
7410
+ * @public
6759
7411
  * <p>The Lightsail resource type (e.g., <code>InstanceSnapshot</code> or
6760
7412
  * <code>DiskSnapshot</code>).</p>
6761
7413
  */
6762
7414
  resourceType?: ExportSnapshotRecordSourceType | string;
6763
7415
  /**
7416
+ * @public
6764
7417
  * <p>The date when the source instance or disk snapshot was created.</p>
6765
7418
  */
6766
7419
  createdAt?: Date;
6767
7420
  /**
7421
+ * @public
6768
7422
  * <p>The name of the source instance or disk snapshot.</p>
6769
7423
  */
6770
7424
  name?: string;
6771
7425
  /**
7426
+ * @public
6772
7427
  * <p>The Amazon Resource Name (ARN) of the source instance or disk snapshot.</p>
6773
7428
  */
6774
7429
  arn?: string;
6775
7430
  /**
7431
+ * @public
6776
7432
  * <p>The name of the snapshot's source instance or disk.</p>
6777
7433
  */
6778
7434
  fromResourceName?: string;
6779
7435
  /**
7436
+ * @public
6780
7437
  * <p>The Amazon Resource Name (ARN) of the snapshot's source instance or disk.</p>
6781
7438
  */
6782
7439
  fromResourceArn?: string;
6783
7440
  /**
7441
+ * @public
6784
7442
  * <p>A list of objects describing an instance snapshot.</p>
6785
7443
  */
6786
7444
  instanceSnapshotInfo?: InstanceSnapshotInfo;
6787
7445
  /**
7446
+ * @public
6788
7447
  * <p>A list of objects describing a disk snapshot.</p>
6789
7448
  */
6790
7449
  diskSnapshotInfo?: DiskSnapshotInfo;
@@ -6795,34 +7454,42 @@ export interface ExportSnapshotRecordSourceInfo {
6795
7454
  */
6796
7455
  export interface ExportSnapshotRecord {
6797
7456
  /**
7457
+ * @public
6798
7458
  * <p>The export snapshot record name.</p>
6799
7459
  */
6800
7460
  name?: string;
6801
7461
  /**
7462
+ * @public
6802
7463
  * <p>The Amazon Resource Name (ARN) of the export snapshot record.</p>
6803
7464
  */
6804
7465
  arn?: string;
6805
7466
  /**
7467
+ * @public
6806
7468
  * <p>The date when the export snapshot record was created.</p>
6807
7469
  */
6808
7470
  createdAt?: Date;
6809
7471
  /**
7472
+ * @public
6810
7473
  * <p>The AWS Region and Availability Zone where the export snapshot record is located.</p>
6811
7474
  */
6812
7475
  location?: ResourceLocation;
6813
7476
  /**
7477
+ * @public
6814
7478
  * <p>The Lightsail resource type (e.g., <code>ExportSnapshotRecord</code>).</p>
6815
7479
  */
6816
7480
  resourceType?: ResourceType | string;
6817
7481
  /**
7482
+ * @public
6818
7483
  * <p>The state of the export snapshot record.</p>
6819
7484
  */
6820
7485
  state?: RecordState | string;
6821
7486
  /**
7487
+ * @public
6822
7488
  * <p>A list of objects describing the source of the export snapshot record.</p>
6823
7489
  */
6824
7490
  sourceInfo?: ExportSnapshotRecordSourceInfo;
6825
7491
  /**
7492
+ * @public
6826
7493
  * <p>A list of objects describing the destination of the export snapshot record.</p>
6827
7494
  */
6828
7495
  destinationInfo?: DestinationInfo;
@@ -6832,6 +7499,7 @@ export interface ExportSnapshotRecord {
6832
7499
  */
6833
7500
  export interface GetActiveNamesRequest {
6834
7501
  /**
7502
+ * @public
6835
7503
  * <p>The token to advance to the next page of results from your request.</p>
6836
7504
  * <p>To get a page token, perform an initial <code>GetActiveNames</code> request. If your
6837
7505
  * results are paginated, the response will return a next page token that you can specify as the
@@ -6844,10 +7512,12 @@ export interface GetActiveNamesRequest {
6844
7512
  */
6845
7513
  export interface GetActiveNamesResult {
6846
7514
  /**
7515
+ * @public
6847
7516
  * <p>The list of active names returned by the get active names request.</p>
6848
7517
  */
6849
7518
  activeNames?: string[];
6850
7519
  /**
7520
+ * @public
6851
7521
  * <p>The token to advance to the next page of results from your request.</p>
6852
7522
  * <p>A next page token is not returned if there are no more results to display.</p>
6853
7523
  * <p>To get the next page of results, perform another <code>GetActiveNames</code> request and
@@ -6860,11 +7530,13 @@ export interface GetActiveNamesResult {
6860
7530
  */
6861
7531
  export interface GetAlarmsRequest {
6862
7532
  /**
7533
+ * @public
6863
7534
  * <p>The name of the alarm.</p>
6864
7535
  * <p>Specify an alarm name to return information about a specific alarm.</p>
6865
7536
  */
6866
7537
  alarmName?: string;
6867
7538
  /**
7539
+ * @public
6868
7540
  * <p>The token to advance to the next page of results from your request.</p>
6869
7541
  * <p>To get a page token, perform an initial <code>GetAlarms</code> request. If your results
6870
7542
  * are paginated, the response will return a next page token that you can specify as the page
@@ -6872,6 +7544,7 @@ export interface GetAlarmsRequest {
6872
7544
  */
6873
7545
  pageToken?: string;
6874
7546
  /**
7547
+ * @public
6875
7548
  * <p>The name of the Lightsail resource being monitored by the alarm.</p>
6876
7549
  * <p>Specify a monitored resource name to return information about all alarms for a specific
6877
7550
  * resource.</p>
@@ -6883,10 +7556,12 @@ export interface GetAlarmsRequest {
6883
7556
  */
6884
7557
  export interface GetAlarmsResult {
6885
7558
  /**
7559
+ * @public
6886
7560
  * <p>An array of objects that describe the alarms.</p>
6887
7561
  */
6888
7562
  alarms?: Alarm[];
6889
7563
  /**
7564
+ * @public
6890
7565
  * <p>The token to advance to the next page of results from your request.</p>
6891
7566
  * <p>A next page token is not returned if there are no more results to display.</p>
6892
7567
  * <p>To get the next page of results, perform another <code>GetAlarms</code> request and
@@ -6899,6 +7574,7 @@ export interface GetAlarmsResult {
6899
7574
  */
6900
7575
  export interface GetAutoSnapshotsRequest {
6901
7576
  /**
7577
+ * @public
6902
7578
  * <p>The name of the source instance or disk from which to get automatic snapshot
6903
7579
  * information.</p>
6904
7580
  */
@@ -6909,14 +7585,17 @@ export interface GetAutoSnapshotsRequest {
6909
7585
  */
6910
7586
  export interface GetAutoSnapshotsResult {
6911
7587
  /**
7588
+ * @public
6912
7589
  * <p>The name of the source instance or disk for the automatic snapshots.</p>
6913
7590
  */
6914
7591
  resourceName?: string;
6915
7592
  /**
7593
+ * @public
6916
7594
  * <p>The resource type (e.g., <code>Instance</code> or <code>Disk</code>).</p>
6917
7595
  */
6918
7596
  resourceType?: ResourceType | string;
6919
7597
  /**
7598
+ * @public
6920
7599
  * <p>An array of objects that describe the automatic snapshots that are available for the
6921
7600
  * specified source instance or disk.</p>
6922
7601
  */
@@ -6927,11 +7606,13 @@ export interface GetAutoSnapshotsResult {
6927
7606
  */
6928
7607
  export interface GetBlueprintsRequest {
6929
7608
  /**
7609
+ * @public
6930
7610
  * <p>A Boolean value that indicates whether to include inactive (unavailable) blueprints in the
6931
7611
  * response of your request.</p>
6932
7612
  */
6933
7613
  includeInactive?: boolean;
6934
7614
  /**
7615
+ * @public
6935
7616
  * <p>The token to advance to the next page of results from your request.</p>
6936
7617
  * <p>To get a page token, perform an initial <code>GetBlueprints</code> request. If your
6937
7618
  * results are paginated, the response will return a next page token that you can specify as the
@@ -6939,6 +7620,7 @@ export interface GetBlueprintsRequest {
6939
7620
  */
6940
7621
  pageToken?: string;
6941
7622
  /**
7623
+ * @public
6942
7624
  * <p>Returns a list of blueprints that are specific to Lightsail for Research.</p>
6943
7625
  * <important>
6944
7626
  * <p>You must use this parameter to view Lightsail for Research blueprints.</p>
@@ -6951,11 +7633,13 @@ export interface GetBlueprintsRequest {
6951
7633
  */
6952
7634
  export interface GetBlueprintsResult {
6953
7635
  /**
7636
+ * @public
6954
7637
  * <p>An array of key-value pairs that contains information about the available
6955
7638
  * blueprints.</p>
6956
7639
  */
6957
7640
  blueprints?: Blueprint[];
6958
7641
  /**
7642
+ * @public
6959
7643
  * <p>The token to advance to the next page of results from your request.</p>
6960
7644
  * <p>A next page token is not returned if there are no more results to display.</p>
6961
7645
  * <p>To get the next page of results, perform another <code>GetBlueprints</code> request and
@@ -6968,6 +7652,7 @@ export interface GetBlueprintsResult {
6968
7652
  */
6969
7653
  export interface GetBucketAccessKeysRequest {
6970
7654
  /**
7655
+ * @public
6971
7656
  * <p>The name of the bucket for which to return access keys.</p>
6972
7657
  */
6973
7658
  bucketName: string | undefined;
@@ -6977,6 +7662,7 @@ export interface GetBucketAccessKeysRequest {
6977
7662
  */
6978
7663
  export interface GetBucketAccessKeysResult {
6979
7664
  /**
7665
+ * @public
6980
7666
  * <p>An object that describes the access keys for the specified bucket.</p>
6981
7667
  */
6982
7668
  accessKeys?: AccessKey[];
@@ -6986,6 +7672,7 @@ export interface GetBucketAccessKeysResult {
6986
7672
  */
6987
7673
  export interface GetBucketBundlesRequest {
6988
7674
  /**
7675
+ * @public
6989
7676
  * <p>A Boolean value that indicates whether to include inactive (unavailable) bundles in the
6990
7677
  * response of your request.</p>
6991
7678
  */
@@ -6996,6 +7683,7 @@ export interface GetBucketBundlesRequest {
6996
7683
  */
6997
7684
  export interface GetBucketBundlesResult {
6998
7685
  /**
7686
+ * @public
6999
7687
  * <p>An object that describes bucket bundles.</p>
7000
7688
  */
7001
7689
  bundles?: BucketBundle[];
@@ -7005,10 +7693,12 @@ export interface GetBucketBundlesResult {
7005
7693
  */
7006
7694
  export interface GetBucketMetricDataRequest {
7007
7695
  /**
7696
+ * @public
7008
7697
  * <p>The name of the bucket for which to get metric data.</p>
7009
7698
  */
7010
7699
  bucketName: string | undefined;
7011
7700
  /**
7701
+ * @public
7012
7702
  * <p>The metric for which you want to return information.</p>
7013
7703
  * <p>Valid bucket metric names are listed below, along with the most useful statistics to
7014
7704
  * include in your request, and the published unit value.</p>
@@ -7042,14 +7732,17 @@ export interface GetBucketMetricDataRequest {
7042
7732
  */
7043
7733
  metricName: BucketMetricName | string | undefined;
7044
7734
  /**
7735
+ * @public
7045
7736
  * <p>The timestamp indicating the earliest data to be returned.</p>
7046
7737
  */
7047
7738
  startTime: Date | undefined;
7048
7739
  /**
7740
+ * @public
7049
7741
  * <p>The timestamp indicating the latest data to be returned.</p>
7050
7742
  */
7051
7743
  endTime: Date | undefined;
7052
7744
  /**
7745
+ * @public
7053
7746
  * <p>The granularity, in seconds, of the returned data points.</p>
7054
7747
  * <note>
7055
7748
  * <p>Bucket storage metrics are reported once per day. Therefore, you should specify a period
@@ -7058,6 +7751,7 @@ export interface GetBucketMetricDataRequest {
7058
7751
  */
7059
7752
  period: number | undefined;
7060
7753
  /**
7754
+ * @public
7061
7755
  * <p>The statistic for the metric.</p>
7062
7756
  * <p>The following statistics are available:</p>
7063
7757
  * <ul>
@@ -7093,6 +7787,7 @@ export interface GetBucketMetricDataRequest {
7093
7787
  */
7094
7788
  statistics: (MetricStatistic | string)[] | undefined;
7095
7789
  /**
7790
+ * @public
7096
7791
  * <p>The unit for the metric data request.</p>
7097
7792
  * <p>Valid units depend on the metric data being requested. For the valid units with each
7098
7793
  * available metric, see the <code>metricName</code> parameter.</p>
@@ -7105,30 +7800,37 @@ export interface GetBucketMetricDataRequest {
7105
7800
  */
7106
7801
  export interface MetricDatapoint {
7107
7802
  /**
7803
+ * @public
7108
7804
  * <p>The average.</p>
7109
7805
  */
7110
7806
  average?: number;
7111
7807
  /**
7808
+ * @public
7112
7809
  * <p>The maximum.</p>
7113
7810
  */
7114
7811
  maximum?: number;
7115
7812
  /**
7813
+ * @public
7116
7814
  * <p>The minimum.</p>
7117
7815
  */
7118
7816
  minimum?: number;
7119
7817
  /**
7818
+ * @public
7120
7819
  * <p>The sample count.</p>
7121
7820
  */
7122
7821
  sampleCount?: number;
7123
7822
  /**
7823
+ * @public
7124
7824
  * <p>The sum.</p>
7125
7825
  */
7126
7826
  sum?: number;
7127
7827
  /**
7828
+ * @public
7128
7829
  * <p>The timestamp (e.g., <code>1479816991.349</code>).</p>
7129
7830
  */
7130
7831
  timestamp?: Date;
7131
7832
  /**
7833
+ * @public
7132
7834
  * <p>The unit. </p>
7133
7835
  */
7134
7836
  unit?: MetricUnit | string;
@@ -7138,10 +7840,12 @@ export interface MetricDatapoint {
7138
7840
  */
7139
7841
  export interface GetBucketMetricDataResult {
7140
7842
  /**
7843
+ * @public
7141
7844
  * <p>The name of the metric returned.</p>
7142
7845
  */
7143
7846
  metricName?: BucketMetricName | string;
7144
7847
  /**
7848
+ * @public
7145
7849
  * <p>An array of objects that describe the metric data returned.</p>
7146
7850
  */
7147
7851
  metricData?: MetricDatapoint[];
@@ -7151,12 +7855,14 @@ export interface GetBucketMetricDataResult {
7151
7855
  */
7152
7856
  export interface GetBucketsRequest {
7153
7857
  /**
7858
+ * @public
7154
7859
  * <p>The name of the bucket for which to return information.</p>
7155
7860
  * <p>When omitted, the response includes all of your buckets in the Amazon Web Services Region
7156
7861
  * where the request is made.</p>
7157
7862
  */
7158
7863
  bucketName?: string;
7159
7864
  /**
7865
+ * @public
7160
7866
  * <p>The token to advance to the next page of results from your request.</p>
7161
7867
  * <p>To get a page token, perform an initial <code>GetBuckets</code> request. If your results
7162
7868
  * are paginated, the response will return a next page token that you can specify as the page
@@ -7164,6 +7870,7 @@ export interface GetBucketsRequest {
7164
7870
  */
7165
7871
  pageToken?: string;
7166
7872
  /**
7873
+ * @public
7167
7874
  * <p>A Boolean value that indicates whether to include Lightsail instances that were given
7168
7875
  * access to the bucket using the <a href="https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_SetResourceAccessForBucket.html">SetResourceAccessForBucket</a>
7169
7876
  * action.</p>
@@ -7175,10 +7882,12 @@ export interface GetBucketsRequest {
7175
7882
  */
7176
7883
  export interface GetBucketsResult {
7177
7884
  /**
7885
+ * @public
7178
7886
  * <p>An array of objects that describe buckets.</p>
7179
7887
  */
7180
7888
  buckets?: Bucket[];
7181
7889
  /**
7890
+ * @public
7182
7891
  * <p>The token to advance to the next page of results from your request.</p>
7183
7892
  * <p>A next page token is not returned if there are no more results to display.</p>
7184
7893
  * <p>To get the next page of results, perform another <code>GetBuckets</code> request and
@@ -7186,6 +7895,7 @@ export interface GetBucketsResult {
7186
7895
  */
7187
7896
  nextPageToken?: string;
7188
7897
  /**
7898
+ * @public
7189
7899
  * <p>An object that describes the synchronization status of the Amazon S3 account-level
7190
7900
  * block public access feature for your Lightsail buckets.</p>
7191
7901
  * <p>For more information about this feature and how it affects Lightsail buckets, see <a href="https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-block-public-access-for-buckets">Block public access for buckets in Amazon Lightsail</a>.</p>
@@ -7197,11 +7907,13 @@ export interface GetBucketsResult {
7197
7907
  */
7198
7908
  export interface GetBundlesRequest {
7199
7909
  /**
7910
+ * @public
7200
7911
  * <p>A Boolean value that indicates whether to include inactive (unavailable) bundles in the
7201
7912
  * response of your request.</p>
7202
7913
  */
7203
7914
  includeInactive?: boolean;
7204
7915
  /**
7916
+ * @public
7205
7917
  * <p>The token to advance to the next page of results from your request.</p>
7206
7918
  * <p>To get a page token, perform an initial <code>GetBundles</code> request. If your results
7207
7919
  * are paginated, the response will return a next page token that you can specify as the page
@@ -7209,6 +7921,7 @@ export interface GetBundlesRequest {
7209
7921
  */
7210
7922
  pageToken?: string;
7211
7923
  /**
7924
+ * @public
7212
7925
  * <p>Returns a list of bundles that are specific to Lightsail for Research.</p>
7213
7926
  * <important>
7214
7927
  * <p>You must use this parameter to view Lightsail for Research bundles.</p>
@@ -7221,10 +7934,12 @@ export interface GetBundlesRequest {
7221
7934
  */
7222
7935
  export interface GetBundlesResult {
7223
7936
  /**
7937
+ * @public
7224
7938
  * <p>An array of key-value pairs that contains information about the available bundles.</p>
7225
7939
  */
7226
7940
  bundles?: Bundle[];
7227
7941
  /**
7942
+ * @public
7228
7943
  * <p>The token to advance to the next page of results from your request.</p>
7229
7944
  * <p>A next page token is not returned if there are no more results to display.</p>
7230
7945
  * <p>To get the next page of results, perform another <code>GetBundles</code> request and
@@ -7237,6 +7952,7 @@ export interface GetBundlesResult {
7237
7952
  */
7238
7953
  export interface GetCertificatesRequest {
7239
7954
  /**
7955
+ * @public
7240
7956
  * <p>The status of the certificates for which to return information.</p>
7241
7957
  * <p>For example, specify <code>ISSUED</code> to return only certificates with an
7242
7958
  * <code>ISSUED</code> status.</p>
@@ -7245,6 +7961,7 @@ export interface GetCertificatesRequest {
7245
7961
  */
7246
7962
  certificateStatuses?: (CertificateStatus | string)[];
7247
7963
  /**
7964
+ * @public
7248
7965
  * <p>Indicates whether to include detailed information about the certificates in the
7249
7966
  * response.</p>
7250
7967
  * <p>When omitted, the response includes only the certificate names, Amazon Resource Names
@@ -7252,12 +7969,14 @@ export interface GetCertificatesRequest {
7252
7969
  */
7253
7970
  includeCertificateDetails?: boolean;
7254
7971
  /**
7972
+ * @public
7255
7973
  * <p>The name for the certificate for which to return information.</p>
7256
7974
  * <p>When omitted, the response includes all of your certificates in the Amazon Web Services
7257
7975
  * Region where the request is made.</p>
7258
7976
  */
7259
7977
  certificateName?: string;
7260
7978
  /**
7979
+ * @public
7261
7980
  * <p>The token to advance to the next page of results from your request.</p>
7262
7981
  * <p>To get a page token, perform an initial <code>GetCertificates</code> request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.</p>
7263
7982
  */
@@ -7268,10 +7987,12 @@ export interface GetCertificatesRequest {
7268
7987
  */
7269
7988
  export interface GetCertificatesResult {
7270
7989
  /**
7990
+ * @public
7271
7991
  * <p>An object that describes certificates.</p>
7272
7992
  */
7273
7993
  certificates?: CertificateSummary[];
7274
7994
  /**
7995
+ * @public
7275
7996
  * <p>If <code>NextPageToken</code> is returned there are more results available. The value of <code>NextPageToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.</p>
7276
7997
  */
7277
7998
  nextPageToken?: string;
@@ -7281,6 +8002,7 @@ export interface GetCertificatesResult {
7281
8002
  */
7282
8003
  export interface GetCloudFormationStackRecordsRequest {
7283
8004
  /**
8005
+ * @public
7284
8006
  * <p>The token to advance to the next page of results from your request.</p>
7285
8007
  * <p>To get a page token, perform an initial <code>GetClouFormationStackRecords</code> request.
7286
8008
  * If your results are paginated, the response will return a next page token that you can specify
@@ -7293,10 +8015,12 @@ export interface GetCloudFormationStackRecordsRequest {
7293
8015
  */
7294
8016
  export interface GetCloudFormationStackRecordsResult {
7295
8017
  /**
8018
+ * @public
7296
8019
  * <p>A list of objects describing the CloudFormation stack records.</p>
7297
8020
  */
7298
8021
  cloudFormationStackRecords?: CloudFormationStackRecord[];
7299
8022
  /**
8023
+ * @public
7300
8024
  * <p>The token to advance to the next page of results from your request.</p>
7301
8025
  * <p>A next page token is not returned if there are no more results to display.</p>
7302
8026
  * <p>To get the next page of results, perform another
@@ -7310,6 +8034,7 @@ export interface GetCloudFormationStackRecordsResult {
7310
8034
  */
7311
8035
  export interface GetContactMethodsRequest {
7312
8036
  /**
8037
+ * @public
7313
8038
  * <p>The protocols used to send notifications, such as <code>Email</code>, or <code>SMS</code>
7314
8039
  * (text messaging).</p>
7315
8040
  * <p>Specify a protocol in your request to return information about a specific contact method
@@ -7322,6 +8047,7 @@ export interface GetContactMethodsRequest {
7322
8047
  */
7323
8048
  export interface GetContactMethodsResult {
7324
8049
  /**
8050
+ * @public
7325
8051
  * <p>An array of objects that describe the contact methods.</p>
7326
8052
  */
7327
8053
  contactMethods?: ContactMethod[];
@@ -7336,6 +8062,7 @@ export interface GetContainerAPIMetadataRequest {
7336
8062
  */
7337
8063
  export interface GetContainerAPIMetadataResult {
7338
8064
  /**
8065
+ * @public
7339
8066
  * <p>Metadata about Lightsail containers, such as the current version of the Lightsail
7340
8067
  * Control (lightsailctl) plugin.</p>
7341
8068
  */
@@ -7346,6 +8073,7 @@ export interface GetContainerAPIMetadataResult {
7346
8073
  */
7347
8074
  export interface GetContainerImagesRequest {
7348
8075
  /**
8076
+ * @public
7349
8077
  * <p>The name of the container service for which to return registered container images.</p>
7350
8078
  */
7351
8079
  serviceName: string | undefined;
@@ -7355,6 +8083,7 @@ export interface GetContainerImagesRequest {
7355
8083
  */
7356
8084
  export interface GetContainerImagesResult {
7357
8085
  /**
8086
+ * @public
7358
8087
  * <p>An array of objects that describe container images that are registered to the container
7359
8088
  * service.</p>
7360
8089
  */
@@ -7365,15 +8094,18 @@ export interface GetContainerImagesResult {
7365
8094
  */
7366
8095
  export interface GetContainerLogRequest {
7367
8096
  /**
8097
+ * @public
7368
8098
  * <p>The name of the container service for which to get a container log.</p>
7369
8099
  */
7370
8100
  serviceName: string | undefined;
7371
8101
  /**
8102
+ * @public
7372
8103
  * <p>The name of the container that is either running or previously ran on the container
7373
8104
  * service for which to return a log.</p>
7374
8105
  */
7375
8106
  containerName: string | undefined;
7376
8107
  /**
8108
+ * @public
7377
8109
  * <p>The start of the time interval for which to get log data.</p>
7378
8110
  * <p>Constraints:</p>
7379
8111
  * <ul>
@@ -7390,6 +8122,7 @@ export interface GetContainerLogRequest {
7390
8122
  */
7391
8123
  startTime?: Date;
7392
8124
  /**
8125
+ * @public
7393
8126
  * <p>The end of the time interval for which to get log data.</p>
7394
8127
  * <p>Constraints:</p>
7395
8128
  * <ul>
@@ -7406,6 +8139,7 @@ export interface GetContainerLogRequest {
7406
8139
  */
7407
8140
  endTime?: Date;
7408
8141
  /**
8142
+ * @public
7409
8143
  * <p>The pattern to use to filter the returned log events to a specific term.</p>
7410
8144
  * <p>The following are a few examples of filter patterns that you can specify:</p>
7411
8145
  * <ul>
@@ -7434,6 +8168,7 @@ export interface GetContainerLogRequest {
7434
8168
  */
7435
8169
  filterPattern?: string;
7436
8170
  /**
8171
+ * @public
7437
8172
  * <p>The token to advance to the next page of results from your request.</p>
7438
8173
  * <p>To get a page token, perform an initial <code>GetContainerLog</code> request. If your
7439
8174
  * results are paginated, the response will return a next page token that you can specify as the
@@ -7446,10 +8181,12 @@ export interface GetContainerLogRequest {
7446
8181
  */
7447
8182
  export interface GetContainerLogResult {
7448
8183
  /**
8184
+ * @public
7449
8185
  * <p>An array of objects that describe the log events of a container.</p>
7450
8186
  */
7451
8187
  logEvents?: ContainerServiceLogEvent[];
7452
8188
  /**
8189
+ * @public
7453
8190
  * <p>The token to advance to the next page of results from your request.</p>
7454
8191
  * <p>A next page token is not returned if there are no more results to display.</p>
7455
8192
  * <p>To get the next page of results, perform another <code>GetContainerLog</code> request and
@@ -7462,6 +8199,7 @@ export interface GetContainerLogResult {
7462
8199
  */
7463
8200
  export interface GetContainerServiceDeploymentsRequest {
7464
8201
  /**
8202
+ * @public
7465
8203
  * <p>The name of the container service for which to return deployments.</p>
7466
8204
  */
7467
8205
  serviceName: string | undefined;
@@ -7471,6 +8209,7 @@ export interface GetContainerServiceDeploymentsRequest {
7471
8209
  */
7472
8210
  export interface GetContainerServiceDeploymentsResult {
7473
8211
  /**
8212
+ * @public
7474
8213
  * <p>An array of objects that describe deployments for a container service.</p>
7475
8214
  */
7476
8215
  deployments?: ContainerServiceDeployment[];
@@ -7480,10 +8219,12 @@ export interface GetContainerServiceDeploymentsResult {
7480
8219
  */
7481
8220
  export interface GetContainerServiceMetricDataRequest {
7482
8221
  /**
8222
+ * @public
7483
8223
  * <p>The name of the container service for which to get metric data.</p>
7484
8224
  */
7485
8225
  serviceName: string | undefined;
7486
8226
  /**
8227
+ * @public
7487
8228
  * <p>The metric for which you want to return information.</p>
7488
8229
  * <p>Valid container service metric names are listed below, along with the most useful
7489
8230
  * statistics to include in your request, and the published unit value.</p>
@@ -7510,20 +8251,24 @@ export interface GetContainerServiceMetricDataRequest {
7510
8251
  */
7511
8252
  metricName: ContainerServiceMetricName | string | undefined;
7512
8253
  /**
8254
+ * @public
7513
8255
  * <p>The start time of the time period.</p>
7514
8256
  */
7515
8257
  startTime: Date | undefined;
7516
8258
  /**
8259
+ * @public
7517
8260
  * <p>The end time of the time period.</p>
7518
8261
  */
7519
8262
  endTime: Date | undefined;
7520
8263
  /**
8264
+ * @public
7521
8265
  * <p>The granularity, in seconds, of the returned data points.</p>
7522
8266
  * <p>All container service metric data is available in 5-minute (300 seconds)
7523
8267
  * granularity.</p>
7524
8268
  */
7525
8269
  period: number | undefined;
7526
8270
  /**
8271
+ * @public
7527
8272
  * <p>The statistic for the metric.</p>
7528
8273
  * <p>The following statistics are available:</p>
7529
8274
  * <ul>
@@ -7564,10 +8309,12 @@ export interface GetContainerServiceMetricDataRequest {
7564
8309
  */
7565
8310
  export interface GetContainerServiceMetricDataResult {
7566
8311
  /**
8312
+ * @public
7567
8313
  * <p>The name of the metric returned. </p>
7568
8314
  */
7569
8315
  metricName?: ContainerServiceMetricName | string;
7570
8316
  /**
8317
+ * @public
7571
8318
  * <p>An array of objects that describe the metric data returned.</p>
7572
8319
  */
7573
8320
  metricData?: MetricDatapoint[];
@@ -7582,6 +8329,7 @@ export interface GetContainerServicePowersRequest {
7582
8329
  */
7583
8330
  export interface GetContainerServicePowersResult {
7584
8331
  /**
8332
+ * @public
7585
8333
  * <p>An array of objects that describe the powers that can be specified for a container
7586
8334
  * service.</p>
7587
8335
  */
@@ -7592,6 +8340,7 @@ export interface GetContainerServicePowersResult {
7592
8340
  */
7593
8341
  export interface GetContainerServicesRequest {
7594
8342
  /**
8343
+ * @public
7595
8344
  * <p>The name of the container service for which to return information.</p>
7596
8345
  * <p>When omitted, the response includes all of your container services in the Amazon Web Services Region where the request is made.</p>
7597
8346
  */