aws-sdk 2.627.0 → 2.628.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.
@@ -36,11 +36,11 @@ declare class Lightsail extends Service {
36
36
  */
37
37
  attachInstancesToLoadBalancer(callback?: (err: AWSError, data: Lightsail.Types.AttachInstancesToLoadBalancerResult) => void): Request<Lightsail.Types.AttachInstancesToLoadBalancerResult, AWSError>;
38
38
  /**
39
- * Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the attach load balancer tls certificate operation with the non-attached certificate, and it will replace the existing one and become the attached certificate. The attach load balancer tls certificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
39
+ * Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the AttachLoadBalancerTlsCertificate action with the non-attached certificate, and it will replace the existing one and become the attached certificate. The AttachLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
40
40
  */
41
41
  attachLoadBalancerTlsCertificate(params: Lightsail.Types.AttachLoadBalancerTlsCertificateRequest, callback?: (err: AWSError, data: Lightsail.Types.AttachLoadBalancerTlsCertificateResult) => void): Request<Lightsail.Types.AttachLoadBalancerTlsCertificateResult, AWSError>;
42
42
  /**
43
- * Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the attach load balancer tls certificate operation with the non-attached certificate, and it will replace the existing one and become the attached certificate. The attach load balancer tls certificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
43
+ * Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the AttachLoadBalancerTlsCertificate action with the non-attached certificate, and it will replace the existing one and become the attached certificate. The AttachLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
44
44
  */
45
45
  attachLoadBalancerTlsCertificate(callback?: (err: AWSError, data: Lightsail.Types.AttachLoadBalancerTlsCertificateResult) => void): Request<Lightsail.Types.AttachLoadBalancerTlsCertificateResult, AWSError>;
46
46
  /**
@@ -75,6 +75,14 @@ declare class Lightsail extends Service {
75
75
  * Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot. This operation results in a CloudFormation stack record that can be used to track the AWS CloudFormation stack created. Use the get cloud formation stack records operation to get a list of the CloudFormation stacks created. Wait until after your new Amazon EC2 instance is created before running the create cloud formation stack operation again with the same export snapshot record.
76
76
  */
77
77
  createCloudFormationStack(callback?: (err: AWSError, data: Lightsail.Types.CreateCloudFormationStackResult) => void): Request<Lightsail.Types.CreateCloudFormationStackResult, AWSError>;
78
+ /**
79
+ * Creates an email or SMS text message contact method. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
80
+ */
81
+ createContactMethod(params: Lightsail.Types.CreateContactMethodRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateContactMethodResult) => void): Request<Lightsail.Types.CreateContactMethodResult, AWSError>;
82
+ /**
83
+ * Creates an email or SMS text message contact method. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
84
+ */
85
+ createContactMethod(callback?: (err: AWSError, data: Lightsail.Types.CreateContactMethodResult) => void): Request<Lightsail.Types.CreateContactMethodResult, AWSError>;
78
86
  /**
79
87
  * Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a). The create disk operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
80
88
  */
@@ -156,11 +164,11 @@ declare class Lightsail extends Service {
156
164
  */
157
165
  createLoadBalancer(callback?: (err: AWSError, data: Lightsail.Types.CreateLoadBalancerResult) => void): Request<Lightsail.Types.CreateLoadBalancerResult, AWSError>;
158
166
  /**
159
- * Creates a Lightsail load balancer TLS certificate. TLS is just an updated, more secure version of Secure Socket Layer (SSL). The create load balancer tls certificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
167
+ * Creates a Lightsail load balancer TLS certificate. TLS is just an updated, more secure version of Secure Socket Layer (SSL). The CreateLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
160
168
  */
161
169
  createLoadBalancerTlsCertificate(params: Lightsail.Types.CreateLoadBalancerTlsCertificateRequest, callback?: (err: AWSError, data: Lightsail.Types.CreateLoadBalancerTlsCertificateResult) => void): Request<Lightsail.Types.CreateLoadBalancerTlsCertificateResult, AWSError>;
162
170
  /**
163
- * Creates a Lightsail load balancer TLS certificate. TLS is just an updated, more secure version of Secure Socket Layer (SSL). The create load balancer tls certificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
171
+ * Creates a Lightsail load balancer TLS certificate. TLS is just an updated, more secure version of Secure Socket Layer (SSL). The CreateLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
164
172
  */
165
173
  createLoadBalancerTlsCertificate(callback?: (err: AWSError, data: Lightsail.Types.CreateLoadBalancerTlsCertificateResult) => void): Request<Lightsail.Types.CreateLoadBalancerTlsCertificateResult, AWSError>;
166
174
  /**
@@ -187,6 +195,14 @@ declare class Lightsail extends Service {
187
195
  * Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database. The create relational database snapshot operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.
188
196
  */
189
197
  createRelationalDatabaseSnapshot(callback?: (err: AWSError, data: Lightsail.Types.CreateRelationalDatabaseSnapshotResult) => void): Request<Lightsail.Types.CreateRelationalDatabaseSnapshotResult, AWSError>;
198
+ /**
199
+ * Deletes an alarm. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
200
+ */
201
+ deleteAlarm(params: Lightsail.Types.DeleteAlarmRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteAlarmResult) => void): Request<Lightsail.Types.DeleteAlarmResult, AWSError>;
202
+ /**
203
+ * Deletes an alarm. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
204
+ */
205
+ deleteAlarm(callback?: (err: AWSError, data: Lightsail.Types.DeleteAlarmResult) => void): Request<Lightsail.Types.DeleteAlarmResult, AWSError>;
190
206
  /**
191
207
  * Deletes an automatic snapshot of an instance or disk. For more information, see the Lightsail Dev Guide.
192
208
  */
@@ -195,6 +211,14 @@ declare class Lightsail extends Service {
195
211
  * Deletes an automatic snapshot of an instance or disk. For more information, see the Lightsail Dev Guide.
196
212
  */
197
213
  deleteAutoSnapshot(callback?: (err: AWSError, data: Lightsail.Types.DeleteAutoSnapshotResult) => void): Request<Lightsail.Types.DeleteAutoSnapshotResult, AWSError>;
214
+ /**
215
+ * Deletes a contact method. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
216
+ */
217
+ deleteContactMethod(params: Lightsail.Types.DeleteContactMethodRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteContactMethodResult) => void): Request<Lightsail.Types.DeleteContactMethodResult, AWSError>;
218
+ /**
219
+ * Deletes a contact method. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
220
+ */
221
+ deleteContactMethod(callback?: (err: AWSError, data: Lightsail.Types.DeleteContactMethodResult) => void): Request<Lightsail.Types.DeleteContactMethodResult, AWSError>;
198
222
  /**
199
223
  * Deletes the specified block storage disk. The disk must be in the available state (not attached to a Lightsail instance). The disk may remain in the deleting state for several minutes. The delete disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Lightsail Dev Guide.
200
224
  */
@@ -268,11 +292,11 @@ declare class Lightsail extends Service {
268
292
  */
269
293
  deleteLoadBalancer(callback?: (err: AWSError, data: Lightsail.Types.DeleteLoadBalancerResult) => void): Request<Lightsail.Types.DeleteLoadBalancerResult, AWSError>;
270
294
  /**
271
- * Deletes an SSL/TLS certificate associated with a Lightsail load balancer. The delete load balancer tls certificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
295
+ * Deletes an SSL/TLS certificate associated with a Lightsail load balancer. The DeleteLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
272
296
  */
273
297
  deleteLoadBalancerTlsCertificate(params: Lightsail.Types.DeleteLoadBalancerTlsCertificateRequest, callback?: (err: AWSError, data: Lightsail.Types.DeleteLoadBalancerTlsCertificateResult) => void): Request<Lightsail.Types.DeleteLoadBalancerTlsCertificateResult, AWSError>;
274
298
  /**
275
- * Deletes an SSL/TLS certificate associated with a Lightsail load balancer. The delete load balancer tls certificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
299
+ * Deletes an SSL/TLS certificate associated with a Lightsail load balancer. The DeleteLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
276
300
  */
277
301
  deleteLoadBalancerTlsCertificate(callback?: (err: AWSError, data: Lightsail.Types.DeleteLoadBalancerTlsCertificateResult) => void): Request<Lightsail.Types.DeleteLoadBalancerTlsCertificateResult, AWSError>;
278
302
  /**
@@ -355,6 +379,14 @@ declare class Lightsail extends Service {
355
379
  * Returns the names of all active (not deleted) resources.
356
380
  */
357
381
  getActiveNames(callback?: (err: AWSError, data: Lightsail.Types.GetActiveNamesResult) => void): Request<Lightsail.Types.GetActiveNamesResult, AWSError>;
382
+ /**
383
+ * Returns information about the configured alarms. Specify an alarm name in your request to return information about a specific alarm, or specify a monitored resource name to return information about all alarms for a specific resource. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
384
+ */
385
+ getAlarms(params: Lightsail.Types.GetAlarmsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetAlarmsResult) => void): Request<Lightsail.Types.GetAlarmsResult, AWSError>;
386
+ /**
387
+ * Returns information about the configured alarms. Specify an alarm name in your request to return information about a specific alarm, or specify a monitored resource name to return information about all alarms for a specific resource. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
388
+ */
389
+ getAlarms(callback?: (err: AWSError, data: Lightsail.Types.GetAlarmsResult) => void): Request<Lightsail.Types.GetAlarmsResult, AWSError>;
358
390
  /**
359
391
  * Returns the available automatic snapshots for an instance or disk. For more information, see the Lightsail Dev Guide.
360
392
  */
@@ -387,6 +419,14 @@ declare class Lightsail extends Service {
387
419
  * Returns the CloudFormation stack record created as a result of the create cloud formation stack operation. An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail snapshot.
388
420
  */
389
421
  getCloudFormationStackRecords(callback?: (err: AWSError, data: Lightsail.Types.GetCloudFormationStackRecordsResult) => void): Request<Lightsail.Types.GetCloudFormationStackRecordsResult, AWSError>;
422
+ /**
423
+ * Returns information about the configured contact methods. Specify a protocol in your request to return information about a specific contact method. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
424
+ */
425
+ getContactMethods(params: Lightsail.Types.GetContactMethodsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetContactMethodsResult) => void): Request<Lightsail.Types.GetContactMethodsResult, AWSError>;
426
+ /**
427
+ * Returns information about the configured contact methods. Specify a protocol in your request to return information about a specific contact method. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
428
+ */
429
+ getContactMethods(callback?: (err: AWSError, data: Lightsail.Types.GetContactMethodsResult) => void): Request<Lightsail.Types.GetContactMethodsResult, AWSError>;
390
430
  /**
391
431
  * Returns information about a specific block storage disk.
392
432
  */
@@ -404,19 +444,19 @@ declare class Lightsail extends Service {
404
444
  */
405
445
  getDiskSnapshot(callback?: (err: AWSError, data: Lightsail.Types.GetDiskSnapshotResult) => void): Request<Lightsail.Types.GetDiskSnapshotResult, AWSError>;
406
446
  /**
407
- * Returns information about all block storage disk snapshots in your AWS account and region. If you are describing a long list of disk snapshots, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
447
+ * Returns information about all block storage disk snapshots in your AWS account and region.
408
448
  */
409
449
  getDiskSnapshots(params: Lightsail.Types.GetDiskSnapshotsRequest, callback?: (err: AWSError, data: Lightsail.Types.GetDiskSnapshotsResult) => void): Request<Lightsail.Types.GetDiskSnapshotsResult, AWSError>;
410
450
  /**
411
- * Returns information about all block storage disk snapshots in your AWS account and region. If you are describing a long list of disk snapshots, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
451
+ * Returns information about all block storage disk snapshots in your AWS account and region.
412
452
  */
413
453
  getDiskSnapshots(callback?: (err: AWSError, data: Lightsail.Types.GetDiskSnapshotsResult) => void): Request<Lightsail.Types.GetDiskSnapshotsResult, AWSError>;
414
454
  /**
415
- * Returns information about all block storage disks in your AWS account and region. If you are describing a long list of disks, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
455
+ * Returns information about all block storage disks in your AWS account and region.
416
456
  */
417
457
  getDisks(params: Lightsail.Types.GetDisksRequest, callback?: (err: AWSError, data: Lightsail.Types.GetDisksResult) => void): Request<Lightsail.Types.GetDisksResult, AWSError>;
418
458
  /**
419
- * Returns information about all block storage disks in your AWS account and region. If you are describing a long list of disks, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
459
+ * Returns information about all block storage disks in your AWS account and region.
420
460
  */
421
461
  getDisks(callback?: (err: AWSError, data: Lightsail.Types.GetDisksResult) => void): Request<Lightsail.Types.GetDisksResult, AWSError>;
422
462
  /**
@@ -548,11 +588,11 @@ declare class Lightsail extends Service {
548
588
  */
549
589
  getLoadBalancerTlsCertificates(callback?: (err: AWSError, data: Lightsail.Types.GetLoadBalancerTlsCertificatesResult) => void): Request<Lightsail.Types.GetLoadBalancerTlsCertificatesResult, AWSError>;
550
590
  /**
551
- * Returns information about all load balancers in an account. If you are describing a long list of load balancers, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
591
+ * Returns information about all load balancers in an account.
552
592
  */
553
593
  getLoadBalancers(params: Lightsail.Types.GetLoadBalancersRequest, callback?: (err: AWSError, data: Lightsail.Types.GetLoadBalancersResult) => void): Request<Lightsail.Types.GetLoadBalancersResult, AWSError>;
554
594
  /**
555
- * Returns information about all load balancers in an account. If you are describing a long list of load balancers, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
595
+ * Returns information about all load balancers in an account.
556
596
  */
557
597
  getLoadBalancers(callback?: (err: AWSError, data: Lightsail.Types.GetLoadBalancersResult) => void): Request<Lightsail.Types.GetLoadBalancersResult, AWSError>;
558
598
  /**
@@ -731,6 +771,14 @@ declare class Lightsail extends Service {
731
771
  * Tries to peer the Lightsail VPC with the user's default VPC.
732
772
  */
733
773
  peerVpc(callback?: (err: AWSError, data: Lightsail.Types.PeerVpcResult) => void): Request<Lightsail.Types.PeerVpcResult, AWSError>;
774
+ /**
775
+ * Creates or updates an alarm, and associates it with the specified metric. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail. When this action creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. The alarm is then evaluated with the updated configuration.
776
+ */
777
+ putAlarm(params: Lightsail.Types.PutAlarmRequest, callback?: (err: AWSError, data: Lightsail.Types.PutAlarmResult) => void): Request<Lightsail.Types.PutAlarmResult, AWSError>;
778
+ /**
779
+ * Creates or updates an alarm, and associates it with the specified metric. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail. When this action creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. The alarm is then evaluated with the updated configuration.
780
+ */
781
+ putAlarm(callback?: (err: AWSError, data: Lightsail.Types.PutAlarmResult) => void): Request<Lightsail.Types.PutAlarmResult, AWSError>;
734
782
  /**
735
783
  * Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not included in the current request. The put instance public ports operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide.
736
784
  */
@@ -763,6 +811,14 @@ declare class Lightsail extends Service {
763
811
  * Deletes a specific static IP from your account.
764
812
  */
765
813
  releaseStaticIp(callback?: (err: AWSError, data: Lightsail.Types.ReleaseStaticIpResult) => void): Request<Lightsail.Types.ReleaseStaticIpResult, AWSError>;
814
+ /**
815
+ * Sends a verification request to an email contact method to ensure it’s owned by the requester. SMS contact methods don’t need to be verified. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail. A verification request is sent to the contact method when you initially create it. Use this action to send another verification request if a previous verification request was deleted, or has expired. Notifications are not sent to an email contact method until after it is verified, and confirmed as valid.
816
+ */
817
+ sendContactMethodVerification(params: Lightsail.Types.SendContactMethodVerificationRequest, callback?: (err: AWSError, data: Lightsail.Types.SendContactMethodVerificationResult) => void): Request<Lightsail.Types.SendContactMethodVerificationResult, AWSError>;
818
+ /**
819
+ * Sends a verification request to an email contact method to ensure it’s owned by the requester. SMS contact methods don’t need to be verified. A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail. A verification request is sent to the contact method when you initially create it. Use this action to send another verification request if a previous verification request was deleted, or has expired. Notifications are not sent to an email contact method until after it is verified, and confirmed as valid.
820
+ */
821
+ sendContactMethodVerification(callback?: (err: AWSError, data: Lightsail.Types.SendContactMethodVerificationResult) => void): Request<Lightsail.Types.SendContactMethodVerificationResult, AWSError>;
766
822
  /**
767
823
  * Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation. When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Lightsail Dev Guide. The start instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide.
768
824
  */
@@ -803,6 +859,14 @@ declare class Lightsail extends Service {
803
859
  * Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the Lightsail Dev Guide. The tag resource operation supports tag-based access control via request tags and resource tags applied to the resource identified by resource name. For more information, see the Lightsail Dev Guide.
804
860
  */
805
861
  tagResource(callback?: (err: AWSError, data: Lightsail.Types.TagResourceResult) => void): Request<Lightsail.Types.TagResourceResult, AWSError>;
862
+ /**
863
+ * Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification trigger is configured for the specified alarm, the test also sends a notification to the notification protocol (Email and/or SMS) configured for the alarm. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
864
+ */
865
+ testAlarm(params: Lightsail.Types.TestAlarmRequest, callback?: (err: AWSError, data: Lightsail.Types.TestAlarmResult) => void): Request<Lightsail.Types.TestAlarmResult, AWSError>;
866
+ /**
867
+ * Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification trigger is configured for the specified alarm, the test also sends a notification to the notification protocol (Email and/or SMS) configured for the alarm. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
868
+ */
869
+ testAlarm(callback?: (err: AWSError, data: Lightsail.Types.TestAlarmResult) => void): Request<Lightsail.Types.TestAlarmResult, AWSError>;
806
870
  /**
807
871
  * Attempts to unpeer the Lightsail VPC from the user's default VPC.
808
872
  */
@@ -885,6 +949,90 @@ declare namespace Lightsail {
885
949
  }
886
950
  export type AddOnRequestList = AddOnRequest[];
887
951
  export type AddOnType = "AutoSnapshot"|string;
952
+ export interface Alarm {
953
+ /**
954
+ * The name of the alarm.
955
+ */
956
+ name?: ResourceName;
957
+ /**
958
+ * The Amazon Resource Name (ARN) of the alarm.
959
+ */
960
+ arn?: NonEmptyString;
961
+ /**
962
+ * The timestamp when the alarm was created.
963
+ */
964
+ createdAt?: IsoDate;
965
+ /**
966
+ * An object that lists information about the location of the alarm.
967
+ */
968
+ location?: ResourceLocation;
969
+ /**
970
+ * The Lightsail resource type (e.g., Alarm).
971
+ */
972
+ resourceType?: ResourceType;
973
+ /**
974
+ * The support code. Include this code in your email to support when you have questions about your Lightsail alarm. This code enables our support team to look up your Lightsail information more easily.
975
+ */
976
+ supportCode?: string;
977
+ /**
978
+ * An object that lists information about the resource monitored by the alarm.
979
+ */
980
+ monitoredResourceInfo?: MonitoredResourceInfo;
981
+ /**
982
+ * The arithmetic operation used when comparing the specified statistic and threshold.
983
+ */
984
+ comparisonOperator?: ComparisonOperator;
985
+ /**
986
+ * The number of periods over which data is compared to the specified threshold.
987
+ */
988
+ evaluationPeriods?: integer;
989
+ /**
990
+ * The period, in seconds, over which the statistic is applied.
991
+ */
992
+ period?: MetricPeriod;
993
+ /**
994
+ * The value against which the specified statistic is compared.
995
+ */
996
+ threshold?: double;
997
+ /**
998
+ * The number of data points that must not within the specified threshold to trigger the alarm.
999
+ */
1000
+ datapointsToAlarm?: integer;
1001
+ /**
1002
+ * Specifies how the alarm handles missing data points. An alarm can treat missing data in the following ways: breaching — Assume the missing data is not within the threshold. Missing data counts towards the number of times the metric is not within the threshold. notBreaching — Assume the missing data is within the threshold. Missing data does not count towards the number of times the metric is not within the threshold. ignore — Ignore the missing data. Maintains the current alarm state. missing — Missing data is treated as missing.
1003
+ */
1004
+ treatMissingData?: TreatMissingData;
1005
+ /**
1006
+ * The statistic for the metric associated with the alarm. The following statistics are available: Minimum — The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application. Maximum — The highest value observed during the specified period. Use this value to determine high volumes of activity for your application. Sum — All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric. Average — The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources. SampleCount — The count, or number, of data points used for the statistical calculation.
1007
+ */
1008
+ statistic?: MetricStatistic;
1009
+ /**
1010
+ * The name of the metric associated with the alarm.
1011
+ */
1012
+ metricName?: MetricName;
1013
+ /**
1014
+ * The current state of the alarm. An alarm has the following possible states: ALARM — The metric is outside of the defined threshold. INSUFFICIENT_DATA — The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state. OK — The metric is within the defined threshold.
1015
+ */
1016
+ state?: AlarmState;
1017
+ /**
1018
+ * The unit of the metric associated with the alarm.
1019
+ */
1020
+ unit?: MetricUnit;
1021
+ /**
1022
+ * The contact protocols for the alarm, such as Email, SMS (text messaging), or both.
1023
+ */
1024
+ contactProtocols?: ContactProtocolsList;
1025
+ /**
1026
+ * The alarm states that trigger a notification.
1027
+ */
1028
+ notificationTriggers?: NotificationTriggerList;
1029
+ /**
1030
+ * Indicates whether the alarm is enabled.
1031
+ */
1032
+ notificationEnabled?: boolean;
1033
+ }
1034
+ export type AlarmState = "OK"|"ALARM"|"INSUFFICIENT_DATA"|string;
1035
+ export type AlarmsList = Alarm[];
888
1036
  export interface AllocateStaticIpRequest {
889
1037
  /**
890
1038
  * The name of the static IP address.
@@ -893,7 +1041,7 @@ declare namespace Lightsail {
893
1041
  }
894
1042
  export interface AllocateStaticIpResult {
895
1043
  /**
896
- * An array of key-value pairs containing information about the static IP address you allocated.
1044
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
897
1045
  */
898
1046
  operations?: OperationList;
899
1047
  }
@@ -913,7 +1061,7 @@ declare namespace Lightsail {
913
1061
  }
914
1062
  export interface AttachDiskResult {
915
1063
  /**
916
- * An object describing the API operations.
1064
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
917
1065
  */
918
1066
  operations?: OperationList;
919
1067
  }
@@ -929,7 +1077,7 @@ declare namespace Lightsail {
929
1077
  }
930
1078
  export interface AttachInstancesToLoadBalancerResult {
931
1079
  /**
932
- * An object representing the API operations.
1080
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
933
1081
  */
934
1082
  operations?: OperationList;
935
1083
  }
@@ -945,7 +1093,7 @@ declare namespace Lightsail {
945
1093
  }
946
1094
  export interface AttachLoadBalancerTlsCertificateResult {
947
1095
  /**
948
- * An object representing the API operations. These SSL/TLS certificates are only usable by Lightsail load balancers. You can't get the certificate and use it for another purpose.
1096
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request. These SSL/TLS certificates are only usable by Lightsail load balancers. You can't get the certificate and use it for another purpose.
949
1097
  */
950
1098
  operations?: OperationList;
951
1099
  }
@@ -961,7 +1109,7 @@ declare namespace Lightsail {
961
1109
  }
962
1110
  export interface AttachStaticIpResult {
963
1111
  /**
964
- * An array of key-value pairs containing information about your API operations.
1112
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
965
1113
  */
966
1114
  operations?: OperationList;
967
1115
  }
@@ -1127,7 +1275,7 @@ declare namespace Lightsail {
1127
1275
  }
1128
1276
  export interface CloseInstancePublicPortsResult {
1129
1277
  /**
1130
- * An array of key-value pairs that contains information about the operation.
1278
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1131
1279
  */
1132
1280
  operation?: Operation;
1133
1281
  }
@@ -1182,6 +1330,47 @@ declare namespace Lightsail {
1182
1330
  }
1183
1331
  export type CloudFormationStackRecordSourceInfoList = CloudFormationStackRecordSourceInfo[];
1184
1332
  export type CloudFormationStackRecordSourceType = "ExportSnapshotRecord"|string;
1333
+ export type ComparisonOperator = "GreaterThanOrEqualToThreshold"|"GreaterThanThreshold"|"LessThanThreshold"|"LessThanOrEqualToThreshold"|string;
1334
+ export interface ContactMethod {
1335
+ /**
1336
+ * The destination of the contact method, such as an email address or a mobile phone number.
1337
+ */
1338
+ contactEndpoint?: NonEmptyString;
1339
+ /**
1340
+ * The current status of the contact method. A contact method has the following possible status: PendingVerification — The contact method has not yet been verified, and the verification has not yet expired. Valid — The contact method has been verified. InValid — An attempt was made to verify the contact method, but the verification has expired.
1341
+ */
1342
+ status?: ContactMethodStatus;
1343
+ /**
1344
+ * The protocol of the contact method, such as email or SMS (text messaging).
1345
+ */
1346
+ protocol?: ContactProtocol;
1347
+ /**
1348
+ * The name of the contact method.
1349
+ */
1350
+ name?: ResourceName;
1351
+ /**
1352
+ * The Amazon Resource Name (ARN) of the contact method.
1353
+ */
1354
+ arn?: NonEmptyString;
1355
+ /**
1356
+ * The timestamp when the contact method was created.
1357
+ */
1358
+ createdAt?: IsoDate;
1359
+ location?: ResourceLocation;
1360
+ /**
1361
+ * The Lightsail resource type (e.g., ContactMethod).
1362
+ */
1363
+ resourceType?: ResourceType;
1364
+ /**
1365
+ * The support code. Include this code in your email to support when you have questions about your Lightsail contact method. This code enables our support team to look up your Lightsail information more easily.
1366
+ */
1367
+ supportCode?: string;
1368
+ }
1369
+ export type ContactMethodStatus = "PendingVerification"|"Valid"|"Invalid"|string;
1370
+ export type ContactMethodVerificationProtocol = "Email"|string;
1371
+ export type ContactMethodsList = ContactMethod[];
1372
+ export type ContactProtocol = "Email"|"SMS"|string;
1373
+ export type ContactProtocolsList = ContactProtocol[];
1185
1374
  export interface CopySnapshotRequest {
1186
1375
  /**
1187
1376
  * The name of the source manual snapshot to copy. Constraint: Define this parameter only when copying a manual snapshot as another manual snapshot.
@@ -1210,7 +1399,7 @@ declare namespace Lightsail {
1210
1399
  }
1211
1400
  export interface CopySnapshotResult {
1212
1401
  /**
1213
- * A list of objects describing the API operation.
1402
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1214
1403
  */
1215
1404
  operations?: OperationList;
1216
1405
  }
@@ -1222,7 +1411,23 @@ declare namespace Lightsail {
1222
1411
  }
1223
1412
  export interface CreateCloudFormationStackResult {
1224
1413
  /**
1225
- * A list of objects describing the API operation.
1414
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1415
+ */
1416
+ operations?: OperationList;
1417
+ }
1418
+ export interface CreateContactMethodRequest {
1419
+ /**
1420
+ * The protocol of the contact method, such as Email or SMS (text messaging). The SMS protocol is supported only in the following AWS Regions. US East (N. Virginia) (us-east-1) US West (Oregon) (us-west-2) Europe (Ireland) (eu-west-1) Asia Pacific (Tokyo) (ap-northeast-1) Asia Pacific (Singapore) (ap-southeast-1) Asia Pacific (Sydney) (ap-southeast-2) For a list of countries/regions where SMS text messages can be sent, and the latest AWS Regions where SMS text messaging is supported, see Supported Regions and Countries in the Amazon SNS Developer Guide. For more information about notifications in Amazon Lightsail, see Notifications in Amazon Lightsail.
1421
+ */
1422
+ protocol: ContactProtocol;
1423
+ /**
1424
+ * The destination of the contact method, such as an email address or a mobile phone number. Use the E.164 format when specifying a mobile phone number. E.164 is a standard for the phone number structure used for international telecommunication. Phone numbers that follow this format can have a maximum of 15 digits, and they are prefixed with the plus character (+) and the country code. For example, a U.S. phone number in E.164 format would be specified as +1XXX5550100. For more information, see E.164 in Wikipedia.
1425
+ */
1426
+ contactEndpoint: StringMax256;
1427
+ }
1428
+ export interface CreateContactMethodResult {
1429
+ /**
1430
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1226
1431
  */
1227
1432
  operations?: OperationList;
1228
1433
  }
@@ -1266,7 +1471,7 @@ declare namespace Lightsail {
1266
1471
  }
1267
1472
  export interface CreateDiskFromSnapshotResult {
1268
1473
  /**
1269
- * An object describing the API operations.
1474
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1270
1475
  */
1271
1476
  operations?: OperationList;
1272
1477
  }
@@ -1294,7 +1499,7 @@ declare namespace Lightsail {
1294
1499
  }
1295
1500
  export interface CreateDiskResult {
1296
1501
  /**
1297
- * An object describing the API operations.
1502
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1298
1503
  */
1299
1504
  operations?: OperationList;
1300
1505
  }
@@ -1318,7 +1523,7 @@ declare namespace Lightsail {
1318
1523
  }
1319
1524
  export interface CreateDiskSnapshotResult {
1320
1525
  /**
1321
- * An object describing the API operations.
1526
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1322
1527
  */
1323
1528
  operations?: OperationList;
1324
1529
  }
@@ -1334,7 +1539,7 @@ declare namespace Lightsail {
1334
1539
  }
1335
1540
  export interface CreateDomainEntryResult {
1336
1541
  /**
1337
- * An array of key-value pairs containing information about the operation.
1542
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1338
1543
  */
1339
1544
  operation?: Operation;
1340
1545
  }
@@ -1350,7 +1555,7 @@ declare namespace Lightsail {
1350
1555
  }
1351
1556
  export interface CreateDomainResult {
1352
1557
  /**
1353
- * An array of key-value pairs containing information about the domain resource you created.
1558
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1354
1559
  */
1355
1560
  operation?: Operation;
1356
1561
  }
@@ -1370,7 +1575,7 @@ declare namespace Lightsail {
1370
1575
  }
1371
1576
  export interface CreateInstanceSnapshotResult {
1372
1577
  /**
1373
- * An array of key-value pairs containing information about the results of your create instances snapshot request.
1578
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1374
1579
  */
1375
1580
  operations?: OperationList;
1376
1581
  }
@@ -1426,7 +1631,7 @@ declare namespace Lightsail {
1426
1631
  }
1427
1632
  export interface CreateInstancesFromSnapshotResult {
1428
1633
  /**
1429
- * An array of key-value pairs containing information about the results of your create instances from snapshot request.
1634
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1430
1635
  */
1431
1636
  operations?: OperationList;
1432
1637
  }
@@ -1470,7 +1675,7 @@ declare namespace Lightsail {
1470
1675
  }
1471
1676
  export interface CreateInstancesResult {
1472
1677
  /**
1473
- * An array of key-value pairs containing information about the results of your create instances request.
1678
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1474
1679
  */
1475
1680
  operations?: OperationList;
1476
1681
  }
@@ -1498,7 +1703,7 @@ declare namespace Lightsail {
1498
1703
  */
1499
1704
  privateKeyBase64?: Base64;
1500
1705
  /**
1501
- * An array of key-value pairs containing information about the results of your create key pair request.
1706
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1502
1707
  */
1503
1708
  operation?: Operation;
1504
1709
  }
@@ -1534,7 +1739,7 @@ declare namespace Lightsail {
1534
1739
  }
1535
1740
  export interface CreateLoadBalancerResult {
1536
1741
  /**
1537
- * An object containing information about the API operations.
1742
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1538
1743
  */
1539
1744
  operations?: OperationList;
1540
1745
  }
@@ -1562,7 +1767,7 @@ declare namespace Lightsail {
1562
1767
  }
1563
1768
  export interface CreateLoadBalancerTlsCertificateResult {
1564
1769
  /**
1565
- * An object containing information about the API operations.
1770
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1566
1771
  */
1567
1772
  operations?: OperationList;
1568
1773
  }
@@ -1606,7 +1811,7 @@ declare namespace Lightsail {
1606
1811
  }
1607
1812
  export interface CreateRelationalDatabaseFromSnapshotResult {
1608
1813
  /**
1609
- * An object describing the result of your create relational database from snapshot request.
1814
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1610
1815
  */
1611
1816
  operations?: OperationList;
1612
1817
  }
@@ -1658,7 +1863,7 @@ declare namespace Lightsail {
1658
1863
  }
1659
1864
  export interface CreateRelationalDatabaseResult {
1660
1865
  /**
1661
- * An object describing the result of your create relational database request.
1866
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1662
1867
  */
1663
1868
  operations?: OperationList;
1664
1869
  }
@@ -1678,7 +1883,19 @@ declare namespace Lightsail {
1678
1883
  }
1679
1884
  export interface CreateRelationalDatabaseSnapshotResult {
1680
1885
  /**
1681
- * An object describing the result of your create relational database snapshot request.
1886
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1887
+ */
1888
+ operations?: OperationList;
1889
+ }
1890
+ export interface DeleteAlarmRequest {
1891
+ /**
1892
+ * The name of the alarm to delete.
1893
+ */
1894
+ alarmName: ResourceName;
1895
+ }
1896
+ export interface DeleteAlarmResult {
1897
+ /**
1898
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1682
1899
  */
1683
1900
  operations?: OperationList;
1684
1901
  }
@@ -1694,7 +1911,19 @@ declare namespace Lightsail {
1694
1911
  }
1695
1912
  export interface DeleteAutoSnapshotResult {
1696
1913
  /**
1697
- * An array of objects that describe the result of your request.
1914
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1915
+ */
1916
+ operations?: OperationList;
1917
+ }
1918
+ export interface DeleteContactMethodRequest {
1919
+ /**
1920
+ * The protocol that will be deleted, such as Email or SMS (text messaging). To delete an Email and an SMS contact method if you added both, you must run separate DeleteContactMethod actions to delete each protocol.
1921
+ */
1922
+ protocol: ContactProtocol;
1923
+ }
1924
+ export interface DeleteContactMethodResult {
1925
+ /**
1926
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1698
1927
  */
1699
1928
  operations?: OperationList;
1700
1929
  }
@@ -1710,7 +1939,7 @@ declare namespace Lightsail {
1710
1939
  }
1711
1940
  export interface DeleteDiskResult {
1712
1941
  /**
1713
- * An array of objects that describe the result of your request.
1942
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1714
1943
  */
1715
1944
  operations?: OperationList;
1716
1945
  }
@@ -1722,7 +1951,7 @@ declare namespace Lightsail {
1722
1951
  }
1723
1952
  export interface DeleteDiskSnapshotResult {
1724
1953
  /**
1725
- * An object describing the API operations.
1954
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1726
1955
  */
1727
1956
  operations?: OperationList;
1728
1957
  }
@@ -1738,7 +1967,7 @@ declare namespace Lightsail {
1738
1967
  }
1739
1968
  export interface DeleteDomainEntryResult {
1740
1969
  /**
1741
- * An array of key-value pairs containing information about the results of your delete domain entry request.
1970
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1742
1971
  */
1743
1972
  operation?: Operation;
1744
1973
  }
@@ -1750,7 +1979,7 @@ declare namespace Lightsail {
1750
1979
  }
1751
1980
  export interface DeleteDomainResult {
1752
1981
  /**
1753
- * An array of key-value pairs containing information about the results of your delete domain request.
1982
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1754
1983
  */
1755
1984
  operation?: Operation;
1756
1985
  }
@@ -1766,7 +1995,7 @@ declare namespace Lightsail {
1766
1995
  }
1767
1996
  export interface DeleteInstanceResult {
1768
1997
  /**
1769
- * An array of key-value pairs containing information about the results of your delete instance request.
1998
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1770
1999
  */
1771
2000
  operations?: OperationList;
1772
2001
  }
@@ -1778,7 +2007,7 @@ declare namespace Lightsail {
1778
2007
  }
1779
2008
  export interface DeleteInstanceSnapshotResult {
1780
2009
  /**
1781
- * An array of key-value pairs containing information about the results of your delete instance snapshot request.
2010
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1782
2011
  */
1783
2012
  operations?: OperationList;
1784
2013
  }
@@ -1790,7 +2019,7 @@ declare namespace Lightsail {
1790
2019
  }
1791
2020
  export interface DeleteKeyPairResult {
1792
2021
  /**
1793
- * An array of key-value pairs containing information about the results of your delete key pair request.
2022
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1794
2023
  */
1795
2024
  operation?: Operation;
1796
2025
  }
@@ -1802,7 +2031,7 @@ declare namespace Lightsail {
1802
2031
  }
1803
2032
  export interface DeleteKnownHostKeysResult {
1804
2033
  /**
1805
- * A list of objects describing the API operation.
2034
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1806
2035
  */
1807
2036
  operations?: OperationList;
1808
2037
  }
@@ -1814,7 +2043,7 @@ declare namespace Lightsail {
1814
2043
  }
1815
2044
  export interface DeleteLoadBalancerResult {
1816
2045
  /**
1817
- * An object describing the API operations.
2046
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1818
2047
  */
1819
2048
  operations?: OperationList;
1820
2049
  }
@@ -1834,7 +2063,7 @@ declare namespace Lightsail {
1834
2063
  }
1835
2064
  export interface DeleteLoadBalancerTlsCertificateResult {
1836
2065
  /**
1837
- * An object describing the API operations.
2066
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1838
2067
  */
1839
2068
  operations?: OperationList;
1840
2069
  }
@@ -1854,7 +2083,7 @@ declare namespace Lightsail {
1854
2083
  }
1855
2084
  export interface DeleteRelationalDatabaseResult {
1856
2085
  /**
1857
- * An object describing the result of your delete relational database request.
2086
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1858
2087
  */
1859
2088
  operations?: OperationList;
1860
2089
  }
@@ -1866,7 +2095,7 @@ declare namespace Lightsail {
1866
2095
  }
1867
2096
  export interface DeleteRelationalDatabaseSnapshotResult {
1868
2097
  /**
1869
- * An object describing the result of your delete relational database snapshot request.
2098
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1870
2099
  */
1871
2100
  operations?: OperationList;
1872
2101
  }
@@ -1888,7 +2117,7 @@ declare namespace Lightsail {
1888
2117
  }
1889
2118
  export interface DetachDiskResult {
1890
2119
  /**
1891
- * An object describing the API operations.
2120
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1892
2121
  */
1893
2122
  operations?: OperationList;
1894
2123
  }
@@ -1904,7 +2133,7 @@ declare namespace Lightsail {
1904
2133
  }
1905
2134
  export interface DetachInstancesFromLoadBalancerResult {
1906
2135
  /**
1907
- * An object describing the API operations.
2136
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1908
2137
  */
1909
2138
  operations?: OperationList;
1910
2139
  }
@@ -1916,7 +2145,7 @@ declare namespace Lightsail {
1916
2145
  }
1917
2146
  export interface DetachStaticIpResult {
1918
2147
  /**
1919
- * An array of key-value pairs containing information about the results of your detach static IP request.
2148
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1920
2149
  */
1921
2150
  operations?: OperationList;
1922
2151
  }
@@ -1932,7 +2161,7 @@ declare namespace Lightsail {
1932
2161
  }
1933
2162
  export interface DisableAddOnResult {
1934
2163
  /**
1935
- * An array of objects that describe the result of your request.
2164
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
1936
2165
  */
1937
2166
  operations?: OperationList;
1938
2167
  }
@@ -2199,7 +2428,7 @@ declare namespace Lightsail {
2199
2428
  }
2200
2429
  export interface EnableAddOnResult {
2201
2430
  /**
2202
- * An array of objects that describe the result of your request.
2431
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
2203
2432
  */
2204
2433
  operations?: OperationList;
2205
2434
  }
@@ -2281,13 +2510,13 @@ declare namespace Lightsail {
2281
2510
  }
2282
2511
  export interface ExportSnapshotResult {
2283
2512
  /**
2284
- * A list of objects describing the API operation.
2513
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
2285
2514
  */
2286
2515
  operations?: OperationList;
2287
2516
  }
2288
2517
  export interface GetActiveNamesRequest {
2289
2518
  /**
2290
- * A token used for paginating results from your get active names request.
2519
+ * The token to advance to the next page of results from your request. To get a page token, perform an initial GetActiveNames 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.
2291
2520
  */
2292
2521
  pageToken?: string;
2293
2522
  }
@@ -2297,7 +2526,31 @@ declare namespace Lightsail {
2297
2526
  */
2298
2527
  activeNames?: StringList;
2299
2528
  /**
2300
- * A token used for advancing to the next page of results from your get active names request.
2529
+ * The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetActiveNames request and specify the next page token using the pageToken parameter.
2530
+ */
2531
+ nextPageToken?: string;
2532
+ }
2533
+ export interface GetAlarmsRequest {
2534
+ /**
2535
+ * The name of the alarm. Specify an alarm name to return information about a specific alarm.
2536
+ */
2537
+ alarmName?: ResourceName;
2538
+ /**
2539
+ * The token to advance to the next page of results from your request. To get a page token, perform an initial GetAlarms 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.
2540
+ */
2541
+ pageToken?: string;
2542
+ /**
2543
+ * The name of the Lightsail resource being monitored by the alarm. Specify a monitored resource name to return information about all alarms for a specific resource.
2544
+ */
2545
+ monitoredResourceName?: ResourceName;
2546
+ }
2547
+ export interface GetAlarmsResult {
2548
+ /**
2549
+ * An array of objects that describe the alarms.
2550
+ */
2551
+ alarms?: AlarmsList;
2552
+ /**
2553
+ * The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetAlarms request and specify the next page token using the pageToken parameter.
2301
2554
  */
2302
2555
  nextPageToken?: string;
2303
2556
  }
@@ -2327,7 +2580,7 @@ declare namespace Lightsail {
2327
2580
  */
2328
2581
  includeInactive?: boolean;
2329
2582
  /**
2330
- * A token used for advancing to the next page of results from your get blueprints request.
2583
+ * The token to advance to the next page of results from your request. To get a page token, perform an initial GetBlueprints 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.
2331
2584
  */
2332
2585
  pageToken?: string;
2333
2586
  }
@@ -2337,7 +2590,7 @@ declare namespace Lightsail {
2337
2590
  */
2338
2591
  blueprints?: BlueprintList;
2339
2592
  /**
2340
- * A token used for advancing to the next page of results from your get blueprints request.
2593
+ * The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetBlueprints request and specify the next page token using the pageToken parameter.
2341
2594
  */
2342
2595
  nextPageToken?: string;
2343
2596
  }
@@ -2347,7 +2600,7 @@ declare namespace Lightsail {
2347
2600
  */
2348
2601
  includeInactive?: boolean;
2349
2602
  /**
2350
- * A token used for advancing to the next page of results from your get bundles request.
2603
+ * The token to advance to the next page of results from your request. To get a page token, perform an initial GetBundles 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.
2351
2604
  */
2352
2605
  pageToken?: string;
2353
2606
  }
@@ -2357,13 +2610,13 @@ declare namespace Lightsail {
2357
2610
  */
2358
2611
  bundles?: BundleList;
2359
2612
  /**
2360
- * A token used for advancing to the next page of results from your get active names request.
2613
+ * The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetBundles request and specify the next page token using the pageToken parameter.
2361
2614
  */
2362
2615
  nextPageToken?: string;
2363
2616
  }
2364
2617
  export interface GetCloudFormationStackRecordsRequest {
2365
2618
  /**
2366
- * A token used for advancing to a specific page of results for your get cloud formation stack records request.
2619
+ * The token to advance to the next page of results from your request. To get a page token, perform an initial GetClouFormationStackRecords 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.
2367
2620
  */
2368
2621
  pageToken?: string;
2369
2622
  }
@@ -2373,10 +2626,22 @@ declare namespace Lightsail {
2373
2626
  */
2374
2627
  cloudFormationStackRecords?: CloudFormationStackRecordList;
2375
2628
  /**
2376
- * A token used for advancing to the next page of results of your get relational database bundles request.
2629
+ * The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetCloudFormationStackRecords request and specify the next page token using the pageToken parameter.
2377
2630
  */
2378
2631
  nextPageToken?: string;
2379
2632
  }
2633
+ export interface GetContactMethodsRequest {
2634
+ /**
2635
+ * The protocols used to send notifications, such as Email, or SMS (text messaging). Specify a protocol in your request to return information about a specific contact method protocol.
2636
+ */
2637
+ protocols?: ContactProtocolsList;
2638
+ }
2639
+ export interface GetContactMethodsResult {
2640
+ /**
2641
+ * An array of objects that describe the contact methods.
2642
+ */
2643
+ contactMethods?: ContactMethodsList;
2644
+ }
2380
2645
  export interface GetDiskRequest {
2381
2646
  /**
2382
2647
  * The name of the disk (e.g., my-disk).
@@ -2403,7 +2668,7 @@ declare namespace Lightsail {
2403
2668
  }
2404
2669
  export interface GetDiskSnapshotsRequest {
2405
2670
  /**
2406
- * A token used for advancing to the next page of results from your GetDiskSnapshots request.
2671
+ * The token to advance to the next page of results from your request. To get a page token, perform an initial GetDiskSnapshots 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.
2407
2672
  */
2408
2673
  pageToken?: string;
2409
2674
  }
@@ -2413,13 +2678,13 @@ declare namespace Lightsail {
2413
2678
  */
2414
2679
  diskSnapshots?: DiskSnapshotList;
2415
2680
  /**
2416
- * A token used for advancing to the next page of results from your GetDiskSnapshots request.
2681
+ * The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetDiskSnapshots request and specify the next page token using the pageToken parameter.
2417
2682
  */
2418
2683
  nextPageToken?: string;
2419
2684
  }
2420
2685
  export interface GetDisksRequest {
2421
2686
  /**
2422
- * A token used for advancing to the next page of results from your GetDisks request.
2687
+ * The token to advance to the next page of results from your request. To get a page token, perform an initial GetDisks 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.
2423
2688
  */
2424
2689
  pageToken?: string;
2425
2690
  }
@@ -2429,7 +2694,7 @@ declare namespace Lightsail {
2429
2694
  */
2430
2695
  disks?: DiskList;
2431
2696
  /**
2432
- * A token used for advancing to the next page of results from your GetDisks request.
2697
+ * The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetDisks request and specify the next page token using the pageToken parameter.
2433
2698
  */
2434
2699
  nextPageToken?: string;
2435
2700
  }
@@ -2447,7 +2712,7 @@ declare namespace Lightsail {
2447
2712
  }
2448
2713
  export interface GetDomainsRequest {
2449
2714
  /**
2450
- * A token used for advancing to the next page of results from your get domains request.
2715
+ * The token to advance to the next page of results from your request. To get a page token, perform an initial GetDomains 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.
2451
2716
  */
2452
2717
  pageToken?: string;
2453
2718
  }
@@ -2457,13 +2722,13 @@ declare namespace Lightsail {
2457
2722
  */
2458
2723
  domains?: DomainList;
2459
2724
  /**
2460
- * A token used for advancing to the next page of results from your get active names request.
2725
+ * The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetDomains request and specify the next page token using the pageToken parameter.
2461
2726
  */
2462
2727
  nextPageToken?: string;
2463
2728
  }
2464
2729
  export interface GetExportSnapshotRecordsRequest {
2465
2730
  /**
2466
- * A token used for advancing to a specific page of results for your get export snapshot records request.
2731
+ * The token to advance to the next page of results from your request. To get a page token, perform an initial GetExportSnapshotRecords 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.
2467
2732
  */
2468
2733
  pageToken?: string;
2469
2734
  }
@@ -2473,7 +2738,7 @@ declare namespace Lightsail {
2473
2738
  */
2474
2739
  exportSnapshotRecords?: ExportSnapshotRecordList;
2475
2740
  /**
2476
- * A token used for advancing to the next page of results of your get relational database bundles request.
2741
+ * The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetExportSnapshotRecords request and specify the next page token using the pageToken parameter.
2477
2742
  */
2478
2743
  nextPageToken?: string;
2479
2744
  }
@@ -2499,11 +2764,11 @@ declare namespace Lightsail {
2499
2764
  */
2500
2765
  instanceName: ResourceName;
2501
2766
  /**
2502
- * The metric name to get data about.
2767
+ * The metric for which you want to return information. Valid instance metric names are listed below, along with the most useful statistics to include in your request, and the published unit value. CPUUtilization — The percentage of allocated compute units that are currently in use on the instance. This metric identifies the processing power to run the applications on the instance. Tools in your operating system can show a lower percentage than Lightsail when the instance is not allocated a full processor core. Statistics: The most useful statistics are Maximum and Average. Unit: The published unit is Percent. NetworkIn — The number of bytes received on all network interfaces by the instance. This metric identifies the volume of incoming network traffic to the instance. The number reported is the number of bytes received during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second. Statistics: The most useful statistic is Sum. Unit: The published unit is Bytes. NetworkOut — The number of bytes sent out on all network interfaces by the instance. This metric identifies the volume of outgoing network traffic from the instance. The number reported is the number of bytes sent during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second. Statistics: The most useful statistic is Sum. Unit: The published unit is Bytes. StatusCheckFailed — Reports whether the instance passed or failed both the instance status check and the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity. Statistics: The most useful statistic is Sum. Unit: The published unit is Count. StatusCheckFailed_Instance — Reports whether the instance passed or failed the instance status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity. Statistics: The most useful statistic is Sum. Unit: The published unit is Count. StatusCheckFailed_System — Reports whether the instance passed or failed the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity. Statistics: The most useful statistic is Sum. Unit: The published unit is Count.
2503
2768
  */
2504
2769
  metricName: InstanceMetricName;
2505
2770
  /**
2506
- * The granularity, in seconds, of the returned data points.
2771
+ * The granularity, in seconds, of the returned data points. The StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System instance metric data is available in 1-minute (60 seconds) granularity. All other instance metric data is available in 5-minute (300 seconds) granularity.
2507
2772
  */
2508
2773
  period: MetricPeriod;
2509
2774
  /**
@@ -2515,11 +2780,11 @@ declare namespace Lightsail {
2515
2780
  */
2516
2781
  endTime: timestamp;
2517
2782
  /**
2518
- * The unit. The list of valid values is below.
2783
+ * The unit for the metric data request. Valid units depend on the metric data being required. For the valid units with each available metric, see the metricName parameter.
2519
2784
  */
2520
2785
  unit: MetricUnit;
2521
2786
  /**
2522
- * The instance statistics.
2787
+ * The statistic for the metric. The following statistics are available: Minimum — The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application. Maximum — The highest value observed during the specified period. Use this value to determine high volumes of activity for your application. Sum — All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric. Average — The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources. SampleCount — The count, or number, of data points used for the statistical calculation.
2523
2788
  */
2524
2789
  statistics: MetricStatisticList;
2525
2790
  }
@@ -2571,7 +2836,7 @@ declare namespace Lightsail {
2571
2836
  }
2572
2837
  export interface GetInstanceSnapshotsRequest {
2573
2838
  /**
2574
- * A token used for advancing to the next page of results from your get instance snapshots request.
2839
+ * The token to advance to the next page of results from your request. To get a page token, perform an initial GetInstanceSnapshots 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.
2575
2840
  */
2576
2841
  pageToken?: string;
2577
2842
  }
@@ -2581,7 +2846,7 @@ declare namespace Lightsail {
2581
2846
  */
2582
2847
  instanceSnapshots?: InstanceSnapshotList;
2583
2848
  /**
2584
- * A token used for advancing to the next page of results from your get instance snapshots request.
2849
+ * The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetInstanceSnapshots request and specify the next page token using the pageToken parameter.
2585
2850
  */
2586
2851
  nextPageToken?: string;
2587
2852
  }
@@ -2599,7 +2864,7 @@ declare namespace Lightsail {
2599
2864
  }
2600
2865
  export interface GetInstancesRequest {
2601
2866
  /**
2602
- * A token used for advancing to the next page of results from your get instances request.
2867
+ * The token to advance to the next page of results from your request. To get a page token, perform an initial GetInstances 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.
2603
2868
  */
2604
2869
  pageToken?: string;
2605
2870
  }
@@ -2609,7 +2874,7 @@ declare namespace Lightsail {
2609
2874
  */
2610
2875
  instances?: InstanceList;
2611
2876
  /**
2612
- * A token used for advancing to the next page of results from your get instances request.
2877
+ * The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetInstances request and specify the next page token using the pageToken parameter.
2613
2878
  */
2614
2879
  nextPageToken?: string;
2615
2880
  }
@@ -2627,7 +2892,7 @@ declare namespace Lightsail {
2627
2892
  }
2628
2893
  export interface GetKeyPairsRequest {
2629
2894
  /**
2630
- * A token used for advancing to the next page of results from your get key pairs request.
2895
+ * The token to advance to the next page of results from your request. To get a page token, perform an initial GetKeyPairs 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.
2631
2896
  */
2632
2897
  pageToken?: string;
2633
2898
  }
@@ -2637,7 +2902,7 @@ declare namespace Lightsail {
2637
2902
  */
2638
2903
  keyPairs?: KeyPairList;
2639
2904
  /**
2640
- * A token used for advancing to the next page of results from your get key pairs request.
2905
+ * The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetKeyPairs request and specify the next page token using the pageToken parameter.
2641
2906
  */
2642
2907
  nextPageToken?: string;
2643
2908
  }
@@ -2647,7 +2912,7 @@ declare namespace Lightsail {
2647
2912
  */
2648
2913
  loadBalancerName: ResourceName;
2649
2914
  /**
2650
- * The metric about which you want to return information. Valid values are listed below, along with the most useful statistics to include in your request. ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols. Statistics: The most useful statistic is Sum. HealthyHostCount - The number of target instances that are considered healthy. Statistics: The most useful statistic are Average, Minimum, and Maximum. UnhealthyHostCount - The number of target instances that are considered unhealthy. Statistics: The most useful statistic are Average, Minimum, and Maximum. HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originate from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests have not been received by the target instance. This count does not include any response codes generated by the target instances. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originate from the load balancer. This count does not include any response codes generated by the target instances. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Note that Minimum, Maximum, and Average all return 1. HTTPCode_Instance_2XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. HTTPCode_Instance_3XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. HTTPCode_Instance_4XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. HTTPCode_Instance_5XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. InstanceResponseTime - The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received. Statistics: The most useful statistic is Average. RejectedConnectionCount - The number of connections that were rejected because the load balancer had reached its maximum number of connections. Statistics: The most useful statistic is Sum. RequestCount - The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.
2915
+ * The metric for which you want to return information. Valid load balancer metric names are listed below, along with the most useful statistics to include in your request, and the published unit value. ClientTLSNegotiationErrorCount The number of TLS connections initiated by the client that did not establish a session with the load balancer due to a TLS error generated by the load balancer. Possible causes include a mismatch of ciphers or protocols. Statistics: The most useful statistic is Sum. Unit: The published unit is Count. HealthyHostCount The number of target instances that are considered healthy. Statistics: The most useful statistic are Average, Minimum, and Maximum. Unit: The published unit is Count. HTTPCode_Instance_2XX_Count The number of HTTP 2XX response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The published unit is Count. HTTPCode_Instance_3XX_Count The number of HTTP 3XX response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The published unit is Count. HTTPCode_Instance_4XX_Count The number of HTTP 4XX response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The published unit is Count. HTTPCode_Instance_5XX_Count The number of HTTP 5XX response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The published unit is Count. HTTPCode_LB_4XX_Count The number of HTTP 4XX client error codes that originated from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests were not received by the target instance. This count does not include response codes generated by the target instances. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The published unit is Count. HTTPCode_LB_5XX_Count The number of HTTP 5XX server error codes that originated from the load balancer. This does not include any response codes generated by the target instance. This metric is reported if there are no healthy instances attached to the load balancer, or if the request rate exceeds the capacity of the instances (spillover) or the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The published unit is Count. InstanceResponseTime The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received. Statistics: The most useful statistic is Average. Unit: The published unit is Seconds. RejectedConnectionCount The number of connections that were rejected because the load balancer had reached its maximum number of connections. Statistics: The most useful statistic is Sum. Unit: The published unit is Count. RequestCount The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The published unit is Count. UnhealthyHostCount — The number of target instances that are considered unhealthy. Statistics: The most useful statistic are Average, Minimum, and Maximum. Unit: The published unit is Count.
2651
2916
  */
2652
2917
  metricName: LoadBalancerMetricName;
2653
2918
  /**
@@ -2663,11 +2928,11 @@ declare namespace Lightsail {
2663
2928
  */
2664
2929
  endTime: timestamp;
2665
2930
  /**
2666
- * The unit for the time period request. Valid values are listed below.
2931
+ * The unit for the metric data request. Valid units depend on the metric data being required. For the valid units with each available metric, see the metricName parameter.
2667
2932
  */
2668
2933
  unit: MetricUnit;
2669
2934
  /**
2670
- * An array of statistics that you want to request metrics for. Valid values are listed below. SampleCount - The count (number) of data points used for the statistical calculation. Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum. This comparison helps you to know when to increase or decrease your resources as needed. Sum - All values submitted for the matching metric added together. This statistic can be useful for determining the total volume of a metric. Minimum - The lowest value observed during the specified period. You can use this value to determine low volumes of activity for your application. Maximum - The highest value observed during the specified period. You can use this value to determine high volumes of activity for your application.
2935
+ * The statistic for the metric. The following statistics are available: Minimum The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application. Maximum The highest value observed during the specified period. Use this value to determine high volumes of activity for your application. Sum All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric. Average The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources. SampleCount — The count, or number, of data points used for the statistical calculation.
2671
2936
  */
2672
2937
  statistics: MetricStatisticList;
2673
2938
  }
@@ -2707,7 +2972,7 @@ declare namespace Lightsail {
2707
2972
  }
2708
2973
  export interface GetLoadBalancersRequest {
2709
2974
  /**
2710
- * A token used for paginating the results from your GetLoadBalancers request.
2975
+ * The token to advance to the next page of results from your request. To get a page token, perform an initial GetLoadBalancers 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.
2711
2976
  */
2712
2977
  pageToken?: string;
2713
2978
  }
@@ -2717,7 +2982,7 @@ declare namespace Lightsail {
2717
2982
  */
2718
2983
  loadBalancers?: LoadBalancerList;
2719
2984
  /**
2720
- * A token used for advancing to the next page of results from your GetLoadBalancers request.
2985
+ * The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetLoadBalancers request and specify the next page token using the pageToken parameter.
2721
2986
  */
2722
2987
  nextPageToken?: string;
2723
2988
  }
@@ -2729,7 +2994,7 @@ declare namespace Lightsail {
2729
2994
  }
2730
2995
  export interface GetOperationResult {
2731
2996
  /**
2732
- * An array of key-value pairs containing information about the results of your get operation request.
2997
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
2733
2998
  */
2734
2999
  operation?: Operation;
2735
3000
  }
@@ -2739,13 +3004,13 @@ declare namespace Lightsail {
2739
3004
  */
2740
3005
  resourceName: ResourceName;
2741
3006
  /**
2742
- * A token used for advancing to the next page of results from your get operations for resource request.
3007
+ * The token to advance to the next page of results from your request. To get a page token, perform an initial GetOperationsForResource 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.
2743
3008
  */
2744
3009
  pageToken?: string;
2745
3010
  }
2746
3011
  export interface GetOperationsForResourceResult {
2747
3012
  /**
2748
- * An array of key-value pairs containing information about the results of your get operations for resource request.
3013
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
2749
3014
  */
2750
3015
  operations?: OperationList;
2751
3016
  /**
@@ -2753,23 +3018,23 @@ declare namespace Lightsail {
2753
3018
  */
2754
3019
  nextPageCount?: string;
2755
3020
  /**
2756
- * An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
3021
+ * The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetOperationsForResource request and specify the next page token using the pageToken parameter.
2757
3022
  */
2758
3023
  nextPageToken?: string;
2759
3024
  }
2760
3025
  export interface GetOperationsRequest {
2761
3026
  /**
2762
- * A token used for advancing to the next page of results from your get operations request.
3027
+ * The token to advance to the next page of results from your request. To get a page token, perform an initial GetOperations 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.
2763
3028
  */
2764
3029
  pageToken?: string;
2765
3030
  }
2766
3031
  export interface GetOperationsResult {
2767
3032
  /**
2768
- * An array of key-value pairs containing information about the results of your get operations request.
3033
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
2769
3034
  */
2770
3035
  operations?: OperationList;
2771
3036
  /**
2772
- * A token used for advancing to the next page of results from your get operations request.
3037
+ * The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetOperations request and specify the next page token using the pageToken parameter.
2773
3038
  */
2774
3039
  nextPageToken?: string;
2775
3040
  }
@@ -2791,7 +3056,7 @@ declare namespace Lightsail {
2791
3056
  }
2792
3057
  export interface GetRelationalDatabaseBlueprintsRequest {
2793
3058
  /**
2794
- * A token used for advancing to a specific page of results for your get relational database blueprints request.
3059
+ * The token to advance to the next page of results from your request. To get a page token, perform an initial GetRelationalDatabaseBlueprints 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.
2795
3060
  */
2796
3061
  pageToken?: string;
2797
3062
  }
@@ -2801,13 +3066,13 @@ declare namespace Lightsail {
2801
3066
  */
2802
3067
  blueprints?: RelationalDatabaseBlueprintList;
2803
3068
  /**
2804
- * A token used for advancing to the next page of results of your get relational database blueprints request.
3069
+ * The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetRelationalDatabaseBlueprints request and specify the next page token using the pageToken parameter.
2805
3070
  */
2806
3071
  nextPageToken?: string;
2807
3072
  }
2808
3073
  export interface GetRelationalDatabaseBundlesRequest {
2809
3074
  /**
2810
- * A token used for advancing to a specific page of results for your get relational database bundles request.
3075
+ * The token to advance to the next page of results from your request. To get a page token, perform an initial GetRelationalDatabaseBundles 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.
2811
3076
  */
2812
3077
  pageToken?: string;
2813
3078
  }
@@ -2817,7 +3082,7 @@ declare namespace Lightsail {
2817
3082
  */
2818
3083
  bundles?: RelationalDatabaseBundleList;
2819
3084
  /**
2820
- * A token used for advancing to the next page of results of your get relational database bundles request.
3085
+ * The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetRelationalDatabaseBundles request and specify the next page token using the pageToken parameter.
2821
3086
  */
2822
3087
  nextPageToken?: string;
2823
3088
  }
@@ -2831,7 +3096,7 @@ declare namespace Lightsail {
2831
3096
  */
2832
3097
  durationInMinutes?: integer;
2833
3098
  /**
2834
- * A token used for advancing to a specific page of results from for get relational database events request.
3099
+ * The token to advance to the next page of results from your request. To get a page token, perform an initial GetRelationalDatabaseEvents 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.
2835
3100
  */
2836
3101
  pageToken?: string;
2837
3102
  }
@@ -2841,7 +3106,7 @@ declare namespace Lightsail {
2841
3106
  */
2842
3107
  relationalDatabaseEvents?: RelationalDatabaseEventList;
2843
3108
  /**
2844
- * A token used for advancing to the next page of results from your get relational database events request.
3109
+ * The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetRelationalDatabaseEvents request and specify the next page token using the pageToken parameter.
2845
3110
  */
2846
3111
  nextPageToken?: string;
2847
3112
  }
@@ -2867,7 +3132,7 @@ declare namespace Lightsail {
2867
3132
  */
2868
3133
  startFromHead?: boolean;
2869
3134
  /**
2870
- * A token used for advancing to a specific page of results for your get relational database log events request.
3135
+ * The token to advance to the next or previous page of results from your request. To get a page token, perform an initial GetRelationalDatabaseLogEvents request. If your results are paginated, the response will return a next forward token and/or next backward token that you can specify as the page token in a subsequent request.
2871
3136
  */
2872
3137
  pageToken?: string;
2873
3138
  }
@@ -2923,11 +3188,11 @@ declare namespace Lightsail {
2923
3188
  */
2924
3189
  relationalDatabaseName: ResourceName;
2925
3190
  /**
2926
- * The name of the metric data to return.
3191
+ * The metric for which you want to return information. Valid relational database metric names are listed below, along with the most useful statistics to include in your request, and the published unit value. All relational database metric data is available in 1-minute (60 seconds) granularity. CPUUtilization — The percentage of CPU utilization currently in use on the database. Statistics: The most useful statistics are Maximum and Average. Unit: The published unit is Percent. DatabaseConnections — The number of database connections in use. Statistics: The most useful statistics are Maximum and Sum. Unit: The published unit is Count. DiskQueueDepth — The number of outstanding IOs (read/write requests) that are waiting to access the disk. Statistics: The most useful statistic is Sum. Unit: The published unit is Count. FreeStorageSpace — The amount of available storage space. Statistics: The most useful statistic is Sum. Unit: The published unit is Bytes. NetworkReceiveThroughput — The incoming (Receive) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication. Statistics: The most useful statistic is Average. Unit: The published unit is Bytes/Second. NetworkTransmitThroughput — The outgoing (Transmit) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication. Statistics: The most useful statistic is Average. Unit: The published unit is Bytes/Second.
2927
3192
  */
2928
3193
  metricName: RelationalDatabaseMetricName;
2929
3194
  /**
2930
- * The granularity, in seconds, of the returned data points.
3195
+ * The granularity, in seconds, of the returned data points. All relational database metric data is available in 1-minute (60 seconds) granularity.
2931
3196
  */
2932
3197
  period: MetricPeriod;
2933
3198
  /**
@@ -2939,11 +3204,11 @@ declare namespace Lightsail {
2939
3204
  */
2940
3205
  endTime: IsoDate;
2941
3206
  /**
2942
- * The unit for the metric data request.
3207
+ * The unit for the metric data request. Valid units depend on the metric data being required. For the valid units with each available metric, see the metricName parameter.
2943
3208
  */
2944
3209
  unit: MetricUnit;
2945
3210
  /**
2946
- * The array of statistics for your metric data request.
3211
+ * The statistic for the metric. The following statistics are available: Minimum — The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application. Maximum — The highest value observed during the specified period. Use this value to determine high volumes of activity for your application. Sum — All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric. Average — The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources. SampleCount — The count, or number, of data points used for the statistical calculation.
2947
3212
  */
2948
3213
  statistics: MetricStatisticList;
2949
3214
  }
@@ -2963,7 +3228,7 @@ declare namespace Lightsail {
2963
3228
  */
2964
3229
  relationalDatabaseName: ResourceName;
2965
3230
  /**
2966
- * A token used for advancing to a specific page of results for your get relational database parameters request.
3231
+ * The token to advance to the next page of results from your request. To get a page token, perform an initial GetRelationalDatabaseParameters 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.
2967
3232
  */
2968
3233
  pageToken?: string;
2969
3234
  }
@@ -2973,7 +3238,7 @@ declare namespace Lightsail {
2973
3238
  */
2974
3239
  parameters?: RelationalDatabaseParameterList;
2975
3240
  /**
2976
- * A token used for advancing to the next page of results from your get static IPs request.
3241
+ * The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetRelationalDatabaseParameters request and specify the next page token using the pageToken parameter.
2977
3242
  */
2978
3243
  nextPageToken?: string;
2979
3244
  }
@@ -3003,7 +3268,7 @@ declare namespace Lightsail {
3003
3268
  }
3004
3269
  export interface GetRelationalDatabaseSnapshotsRequest {
3005
3270
  /**
3006
- * A token used for advancing to a specific page of results for your get relational database snapshots request.
3271
+ * The token to advance to the next page of results from your request. To get a page token, perform an initial GetRelationalDatabaseSnapshots 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.
3007
3272
  */
3008
3273
  pageToken?: string;
3009
3274
  }
@@ -3013,13 +3278,13 @@ declare namespace Lightsail {
3013
3278
  */
3014
3279
  relationalDatabaseSnapshots?: RelationalDatabaseSnapshotList;
3015
3280
  /**
3016
- * A token used for advancing to the next page of results from your get relational database snapshots request.
3281
+ * The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetRelationalDatabaseSnapshots request and specify the next page token using the pageToken parameter.
3017
3282
  */
3018
3283
  nextPageToken?: string;
3019
3284
  }
3020
3285
  export interface GetRelationalDatabasesRequest {
3021
3286
  /**
3022
- * A token used for advancing to a specific page of results for your get relational database request.
3287
+ * The token to advance to the next page of results from your request. To get a page token, perform an initial GetRelationalDatabases 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.
3023
3288
  */
3024
3289
  pageToken?: string;
3025
3290
  }
@@ -3029,7 +3294,7 @@ declare namespace Lightsail {
3029
3294
  */
3030
3295
  relationalDatabases?: RelationalDatabaseList;
3031
3296
  /**
3032
- * A token used for advancing to the next page of results from your get relational databases request.
3297
+ * The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetRelationalDatabases request and specify the next page token using the pageToken parameter.
3033
3298
  */
3034
3299
  nextPageToken?: string;
3035
3300
  }
@@ -3047,7 +3312,7 @@ declare namespace Lightsail {
3047
3312
  }
3048
3313
  export interface GetStaticIpsRequest {
3049
3314
  /**
3050
- * A token used for advancing to the next page of results from your get static IPs request.
3315
+ * The token to advance to the next page of results from your request. To get a page token, perform an initial GetStaticIps 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.
3051
3316
  */
3052
3317
  pageToken?: string;
3053
3318
  }
@@ -3057,7 +3322,7 @@ declare namespace Lightsail {
3057
3322
  */
3058
3323
  staticIps?: StaticIpList;
3059
3324
  /**
3060
- * A token used for advancing to the next page of results from your get static IPs request.
3325
+ * The token to advance to the next page of resutls from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetStaticIps request and specify the next page token using the pageToken parameter.
3061
3326
  */
3062
3327
  nextPageToken?: string;
3063
3328
  }
@@ -3104,7 +3369,7 @@ declare namespace Lightsail {
3104
3369
  }
3105
3370
  export interface ImportKeyPairResult {
3106
3371
  /**
3107
- * An array of key-value pairs containing information about the request operation.
3372
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
3108
3373
  */
3109
3374
  operation?: Operation;
3110
3375
  }
@@ -3766,10 +4031,25 @@ declare namespace Lightsail {
3766
4031
  unit?: MetricUnit;
3767
4032
  }
3768
4033
  export type MetricDatapointList = MetricDatapoint[];
4034
+ export type MetricName = "CPUUtilization"|"NetworkIn"|"NetworkOut"|"StatusCheckFailed"|"StatusCheckFailed_Instance"|"StatusCheckFailed_System"|"ClientTLSNegotiationErrorCount"|"HealthyHostCount"|"UnhealthyHostCount"|"HTTPCode_LB_4XX_Count"|"HTTPCode_LB_5XX_Count"|"HTTPCode_Instance_2XX_Count"|"HTTPCode_Instance_3XX_Count"|"HTTPCode_Instance_4XX_Count"|"HTTPCode_Instance_5XX_Count"|"InstanceResponseTime"|"RejectedConnectionCount"|"RequestCount"|"DatabaseConnections"|"DiskQueueDepth"|"FreeStorageSpace"|"NetworkReceiveThroughput"|"NetworkTransmitThroughput"|string;
3769
4035
  export type MetricPeriod = number;
3770
4036
  export type MetricStatistic = "Minimum"|"Maximum"|"Sum"|"Average"|"SampleCount"|string;
3771
4037
  export type MetricStatisticList = MetricStatistic[];
3772
4038
  export type MetricUnit = "Seconds"|"Microseconds"|"Milliseconds"|"Bytes"|"Kilobytes"|"Megabytes"|"Gigabytes"|"Terabytes"|"Bits"|"Kilobits"|"Megabits"|"Gigabits"|"Terabits"|"Percent"|"Count"|"Bytes/Second"|"Kilobytes/Second"|"Megabytes/Second"|"Gigabytes/Second"|"Terabytes/Second"|"Bits/Second"|"Kilobits/Second"|"Megabits/Second"|"Gigabits/Second"|"Terabits/Second"|"Count/Second"|"None"|string;
4039
+ export interface MonitoredResourceInfo {
4040
+ /**
4041
+ * The Amazon Resource Name (ARN) of the resource being monitored.
4042
+ */
4043
+ arn?: ResourceArn;
4044
+ /**
4045
+ * The name of the Lightsail resource being monitored.
4046
+ */
4047
+ name?: ResourceName;
4048
+ /**
4049
+ * The Lightsail resource type of the resource being monitored. Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms.
4050
+ */
4051
+ resourceType?: ResourceType;
4052
+ }
3773
4053
  export interface MonthlyTransfer {
3774
4054
  /**
3775
4055
  * The amount allocated per month (in GB).
@@ -3778,6 +4058,7 @@ declare namespace Lightsail {
3778
4058
  }
3779
4059
  export type NetworkProtocol = "tcp"|"all"|"udp"|string;
3780
4060
  export type NonEmptyString = string;
4061
+ export type NotificationTriggerList = AlarmState[];
3781
4062
  export interface OpenInstancePublicPortsRequest {
3782
4063
  /**
3783
4064
  * An array of key-value pairs containing information about the port mappings.
@@ -3790,7 +4071,7 @@ declare namespace Lightsail {
3790
4071
  }
3791
4072
  export interface OpenInstancePublicPortsResult {
3792
4073
  /**
3793
- * An array of key-value pairs containing information about the request operation.
4074
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
3794
4075
  */
3795
4076
  operation?: Operation;
3796
4077
  }
@@ -3846,7 +4127,7 @@ declare namespace Lightsail {
3846
4127
  }
3847
4128
  export type OperationList = Operation[];
3848
4129
  export type OperationStatus = "NotStarted"|"Started"|"Failed"|"Completed"|"Succeeded"|string;
3849
- export type OperationType = "DeleteKnownHostKeys"|"DeleteInstance"|"CreateInstance"|"StopInstance"|"StartInstance"|"RebootInstance"|"OpenInstancePublicPorts"|"PutInstancePublicPorts"|"CloseInstancePublicPorts"|"AllocateStaticIp"|"ReleaseStaticIp"|"AttachStaticIp"|"DetachStaticIp"|"UpdateDomainEntry"|"DeleteDomainEntry"|"CreateDomain"|"DeleteDomain"|"CreateInstanceSnapshot"|"DeleteInstanceSnapshot"|"CreateInstancesFromSnapshot"|"CreateLoadBalancer"|"DeleteLoadBalancer"|"AttachInstancesToLoadBalancer"|"DetachInstancesFromLoadBalancer"|"UpdateLoadBalancerAttribute"|"CreateLoadBalancerTlsCertificate"|"DeleteLoadBalancerTlsCertificate"|"AttachLoadBalancerTlsCertificate"|"CreateDisk"|"DeleteDisk"|"AttachDisk"|"DetachDisk"|"CreateDiskSnapshot"|"DeleteDiskSnapshot"|"CreateDiskFromSnapshot"|"CreateRelationalDatabase"|"UpdateRelationalDatabase"|"DeleteRelationalDatabase"|"CreateRelationalDatabaseFromSnapshot"|"CreateRelationalDatabaseSnapshot"|"DeleteRelationalDatabaseSnapshot"|"UpdateRelationalDatabaseParameters"|"StartRelationalDatabase"|"RebootRelationalDatabase"|"StopRelationalDatabase"|"EnableAddOn"|"DisableAddOn"|string;
4130
+ export type OperationType = "DeleteKnownHostKeys"|"DeleteInstance"|"CreateInstance"|"StopInstance"|"StartInstance"|"RebootInstance"|"OpenInstancePublicPorts"|"PutInstancePublicPorts"|"CloseInstancePublicPorts"|"AllocateStaticIp"|"ReleaseStaticIp"|"AttachStaticIp"|"DetachStaticIp"|"UpdateDomainEntry"|"DeleteDomainEntry"|"CreateDomain"|"DeleteDomain"|"CreateInstanceSnapshot"|"DeleteInstanceSnapshot"|"CreateInstancesFromSnapshot"|"CreateLoadBalancer"|"DeleteLoadBalancer"|"AttachInstancesToLoadBalancer"|"DetachInstancesFromLoadBalancer"|"UpdateLoadBalancerAttribute"|"CreateLoadBalancerTlsCertificate"|"DeleteLoadBalancerTlsCertificate"|"AttachLoadBalancerTlsCertificate"|"CreateDisk"|"DeleteDisk"|"AttachDisk"|"DetachDisk"|"CreateDiskSnapshot"|"DeleteDiskSnapshot"|"CreateDiskFromSnapshot"|"CreateRelationalDatabase"|"UpdateRelationalDatabase"|"DeleteRelationalDatabase"|"CreateRelationalDatabaseFromSnapshot"|"CreateRelationalDatabaseSnapshot"|"DeleteRelationalDatabaseSnapshot"|"UpdateRelationalDatabaseParameters"|"StartRelationalDatabase"|"RebootRelationalDatabase"|"StopRelationalDatabase"|"EnableAddOn"|"DisableAddOn"|"PutAlarm"|"GetAlarms"|"DeleteAlarm"|"TestAlarm"|"CreateContactMethod"|"GetContactMethods"|"SendContactMethodVerification"|"DeleteContactMethod"|string;
3850
4131
  export interface PasswordData {
3851
4132
  /**
3852
4133
  * The encrypted password. Ciphertext will be an empty string if access to your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the instance to be ready. If you use the default key pair (LightsailDefaultKeyPair), the decrypted password will be available in the password field. If you are using a custom key pair, you need to use your own means of decryption. If you change the Administrator password on the instance, Lightsail will continue to return the original ciphertext value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default.
@@ -3861,7 +4142,7 @@ declare namespace Lightsail {
3861
4142
  }
3862
4143
  export interface PeerVpcResult {
3863
4144
  /**
3864
- * An array of key-value pairs containing information about the request operation.
4145
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
3865
4146
  */
3866
4147
  operation?: Operation;
3867
4148
  }
@@ -3914,6 +4195,58 @@ declare namespace Lightsail {
3914
4195
  export type PortInfoSourceType = "DEFAULT"|"INSTANCE"|"NONE"|"CLOSED"|string;
3915
4196
  export type PortList = Port[];
3916
4197
  export type PortState = "open"|"closed"|string;
4198
+ export interface PutAlarmRequest {
4199
+ /**
4200
+ * The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.
4201
+ */
4202
+ alarmName: ResourceName;
4203
+ /**
4204
+ * The name of the metric to associate with the alarm. You can configure up to two alarms per metric. The following metrics are available for each resource type: Instances: CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System. Load balancers: ClientTLSNegotiationErrorCount, HealthyHostCount, UnhealthyHostCount, HTTPCode_LB_4XX_Count, HTTPCode_LB_5XX_Count, HTTPCode_Instance_2XX_Count, HTTPCode_Instance_3XX_Count, HTTPCode_Instance_4XX_Count, HTTPCode_Instance_5XX_Count, InstanceResponseTime, RejectedConnectionCount, and RequestCount. Relational databases: CPUUtilization, DatabaseConnections, DiskQueueDepth, FreeStorageSpace, NetworkReceiveThroughput, and NetworkTransmitThroughput.
4205
+ */
4206
+ metricName: MetricName;
4207
+ /**
4208
+ * The name of the Lightsail resource that will be monitored. Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms.
4209
+ */
4210
+ monitoredResourceName: ResourceName;
4211
+ /**
4212
+ * The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.
4213
+ */
4214
+ comparisonOperator: ComparisonOperator;
4215
+ /**
4216
+ * The value against which the specified statistic is compared.
4217
+ */
4218
+ threshold: double;
4219
+ /**
4220
+ * The number of most recent periods over which data is compared to the specified threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods) is the N. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies the rolling period of time in which data points are evaluated. Each evaluation period is five minutes long. For example, specify an evaluation period of 24 to evaluate a metric over a rolling period of two hours. You can specify a minimum valuation period of 1 (5 minutes), and a maximum evaluation period of 288 (24 hours).
4221
+ */
4222
+ evaluationPeriods: integer;
4223
+ /**
4224
+ * The number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value (datapointsToAlarm) is the M.
4225
+ */
4226
+ datapointsToAlarm?: integer;
4227
+ /**
4228
+ * Sets how this alarm will handle missing data points. An alarm can treat missing data in the following ways: breaching — Assume the missing data is not within the threshold. Missing data counts towards the number of times the metric is not within the threshold. notBreaching — Assume the missing data is within the threshold. Missing data does not count towards the number of times the metric is not within the threshold. ignore — Ignore the missing data. Maintains the current alarm state. missing — Missing data is treated as missing. If treatMissingData is not specified, the default behavior of missing is used.
4229
+ */
4230
+ treatMissingData?: TreatMissingData;
4231
+ /**
4232
+ * The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both. A notification is sent via the specified contact protocol if notifications are enabled for the alarm, and when the alarm is triggered. A notification is not sent if a contact protocol is not specified, if the specified contact protocol is not configured in the AWS Region, or if notifications are not enabled for the alarm using the notificationEnabled paramater. Use the CreateContactMethod action to configure a contact protocol in an AWS Region.
4233
+ */
4234
+ contactProtocols?: ContactProtocolsList;
4235
+ /**
4236
+ * The alarm states that trigger a notification. An alarm has the following possible states: ALARM — The metric is outside of the defined threshold. INSUFFICIENT_DATA — The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state. OK — The metric is within the defined threshold. When you specify a notification trigger, the ALARM state must be specified. The INSUFFICIENT_DATA and OK states can be specified in addition to the ALARM state. If you specify OK as an alarm trigger, a notification is sent when the alarm switches from an ALARM or INSUFFICIENT_DATA alarm state to an OK state. This can be thought of as an all clear alarm notification. If you specify INSUFFICIENT_DATA as the alarm trigger, a notification is sent when the alarm switches from an OK or ALARM alarm state to an INSUFFICIENT_DATA state. The notification trigger defaults to ALARM if you don't specify this parameter.
4237
+ */
4238
+ notificationTriggers?: NotificationTriggerList;
4239
+ /**
4240
+ * Indicates whether the alarm is enabled. Notifications are enabled by default if you don't specify this parameter.
4241
+ */
4242
+ notificationEnabled?: boolean;
4243
+ }
4244
+ export interface PutAlarmResult {
4245
+ /**
4246
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
4247
+ */
4248
+ operations?: OperationList;
4249
+ }
3917
4250
  export interface PutInstancePublicPortsRequest {
3918
4251
  /**
3919
4252
  * Specifies information about the public port(s).
@@ -3926,7 +4259,7 @@ declare namespace Lightsail {
3926
4259
  }
3927
4260
  export interface PutInstancePublicPortsResult {
3928
4261
  /**
3929
- * Describes metadata about the operation you just executed.
4262
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
3930
4263
  */
3931
4264
  operation?: Operation;
3932
4265
  }
@@ -3938,7 +4271,7 @@ declare namespace Lightsail {
3938
4271
  }
3939
4272
  export interface RebootInstanceResult {
3940
4273
  /**
3941
- * An array of key-value pairs containing information about the request operations.
4274
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
3942
4275
  */
3943
4276
  operations?: OperationList;
3944
4277
  }
@@ -3950,7 +4283,7 @@ declare namespace Lightsail {
3950
4283
  }
3951
4284
  export interface RebootRelationalDatabaseResult {
3952
4285
  /**
3953
- * An object describing the result of your reboot relational database request.
4286
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
3954
4287
  */
3955
4288
  operations?: OperationList;
3956
4289
  }
@@ -4308,7 +4641,7 @@ declare namespace Lightsail {
4308
4641
  }
4309
4642
  export interface ReleaseStaticIpResult {
4310
4643
  /**
4311
- * An array of key-value pairs containing information about the request operation.
4644
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
4312
4645
  */
4313
4646
  operations?: OperationList;
4314
4647
  }
@@ -4325,7 +4658,19 @@ declare namespace Lightsail {
4325
4658
  }
4326
4659
  export type ResourceName = string;
4327
4660
  export type ResourceNameList = ResourceName[];
4328
- export type ResourceType = "Instance"|"StaticIp"|"KeyPair"|"InstanceSnapshot"|"Domain"|"PeeredVpc"|"LoadBalancer"|"LoadBalancerTlsCertificate"|"Disk"|"DiskSnapshot"|"RelationalDatabase"|"RelationalDatabaseSnapshot"|"ExportSnapshotRecord"|"CloudFormationStackRecord"|string;
4661
+ export type ResourceType = "Instance"|"StaticIp"|"KeyPair"|"InstanceSnapshot"|"Domain"|"PeeredVpc"|"LoadBalancer"|"LoadBalancerTlsCertificate"|"Disk"|"DiskSnapshot"|"RelationalDatabase"|"RelationalDatabaseSnapshot"|"ExportSnapshotRecord"|"CloudFormationStackRecord"|"Alarm"|"ContactMethod"|string;
4662
+ export interface SendContactMethodVerificationRequest {
4663
+ /**
4664
+ * The protocol to verify, such as Email or SMS (text messaging).
4665
+ */
4666
+ protocol: ContactMethodVerificationProtocol;
4667
+ }
4668
+ export interface SendContactMethodVerificationResult {
4669
+ /**
4670
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
4671
+ */
4672
+ operations?: OperationList;
4673
+ }
4329
4674
  export type SensitiveString = string;
4330
4675
  export interface StartInstanceRequest {
4331
4676
  /**
@@ -4335,7 +4680,7 @@ declare namespace Lightsail {
4335
4680
  }
4336
4681
  export interface StartInstanceResult {
4337
4682
  /**
4338
- * An array of key-value pairs containing information about the request operation.
4683
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
4339
4684
  */
4340
4685
  operations?: OperationList;
4341
4686
  }
@@ -4347,7 +4692,7 @@ declare namespace Lightsail {
4347
4692
  }
4348
4693
  export interface StartRelationalDatabaseResult {
4349
4694
  /**
4350
- * An object describing the result of your start relational database request.
4695
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
4351
4696
  */
4352
4697
  operations?: OperationList;
4353
4698
  }
@@ -4402,7 +4747,7 @@ declare namespace Lightsail {
4402
4747
  }
4403
4748
  export interface StopInstanceResult {
4404
4749
  /**
4405
- * An array of key-value pairs containing information about the request operation.
4750
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
4406
4751
  */
4407
4752
  operations?: OperationList;
4408
4753
  }
@@ -4418,7 +4763,7 @@ declare namespace Lightsail {
4418
4763
  }
4419
4764
  export interface StopRelationalDatabaseResult {
4420
4765
  /**
4421
- * An object describing the result of your stop relational database request.
4766
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
4422
4767
  */
4423
4768
  operations?: OperationList;
4424
4769
  }
@@ -4453,17 +4798,34 @@ declare namespace Lightsail {
4453
4798
  }
4454
4799
  export interface TagResourceResult {
4455
4800
  /**
4456
- * A list of objects describing the API operation.
4801
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
4457
4802
  */
4458
4803
  operations?: OperationList;
4459
4804
  }
4460
4805
  export type TagValue = string;
4806
+ export interface TestAlarmRequest {
4807
+ /**
4808
+ * The name of the alarm to test.
4809
+ */
4810
+ alarmName: ResourceName;
4811
+ /**
4812
+ * The alarm state to test. An alarm has the following possible states that can be tested: ALARM — The metric is outside of the defined threshold. INSUFFICIENT_DATA — The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state. OK — The metric is within the defined threshold.
4813
+ */
4814
+ state: AlarmState;
4815
+ }
4816
+ export interface TestAlarmResult {
4817
+ /**
4818
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
4819
+ */
4820
+ operations?: OperationList;
4821
+ }
4461
4822
  export type TimeOfDay = string;
4823
+ export type TreatMissingData = "breaching"|"notBreaching"|"ignore"|"missing"|string;
4462
4824
  export interface UnpeerVpcRequest {
4463
4825
  }
4464
4826
  export interface UnpeerVpcResult {
4465
4827
  /**
4466
- * An array of key-value pairs containing information about the request operation.
4828
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
4467
4829
  */
4468
4830
  operation?: Operation;
4469
4831
  }
@@ -4483,7 +4845,7 @@ declare namespace Lightsail {
4483
4845
  }
4484
4846
  export interface UntagResourceResult {
4485
4847
  /**
4486
- * A list of objects describing the API operation.
4848
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
4487
4849
  */
4488
4850
  operations?: OperationList;
4489
4851
  }
@@ -4499,7 +4861,7 @@ declare namespace Lightsail {
4499
4861
  }
4500
4862
  export interface UpdateDomainEntryResult {
4501
4863
  /**
4502
- * An array of key-value pairs containing information about the request operation.
4864
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
4503
4865
  */
4504
4866
  operations?: OperationList;
4505
4867
  }
@@ -4519,7 +4881,7 @@ declare namespace Lightsail {
4519
4881
  }
4520
4882
  export interface UpdateLoadBalancerAttributeResult {
4521
4883
  /**
4522
- * An object describing the API operations.
4884
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
4523
4885
  */
4524
4886
  operations?: OperationList;
4525
4887
  }
@@ -4535,7 +4897,7 @@ declare namespace Lightsail {
4535
4897
  }
4536
4898
  export interface UpdateRelationalDatabaseParametersResult {
4537
4899
  /**
4538
- * An object describing the result of your update relational database parameters request.
4900
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
4539
4901
  */
4540
4902
  operations?: OperationList;
4541
4903
  }
@@ -4583,7 +4945,7 @@ declare namespace Lightsail {
4583
4945
  }
4584
4946
  export interface UpdateRelationalDatabaseResult {
4585
4947
  /**
4586
- * An object describing the result of your update relational database request.
4948
+ * An array of objects that describe the result of the action, such as the status of the request, the time stamp of the request, and the resources affected by the request.
4587
4949
  */
4588
4950
  operations?: OperationList;
4589
4951
  }