Amazon.Lightsail.Model

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

Describes an access key for an Amazon Lightsail bucket.

Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the CreateBucketAccessKey action to create an access key for a specific bucket. For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.

Describes the last time an access key was used.

This object does not include data in the response of a CreateBucketAccessKey action.

Describes the anonymous access permissions for an Amazon Lightsail bucket and its objects.

For more information about bucket access permissions, see Understanding bucket permissions in Amazon Lightsail in the

Amazon Lightsail Developer Guide.

Describes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account-level block public access (BPA) feature for your Lightsail buckets.

The account-level BPA feature of Amazon S3 provides centralized controls to limit public access to all Amazon S3 buckets in an account. BPA can make all Amazon S3 buckets in an Amazon Web Services account private regardless of the individual bucket and object permissions that are configured. Lightsail buckets take into account the Amazon S3 account-level BPA configuration when allowing or denying public access. To do this, Lightsail periodically fetches the account-level BPA configuration from Amazon S3. When the account-level BPA status is InSync, the Amazon S3 account-level BPA configuration is synchronized and it applies to your Lightsail buckets. For more information about Amazon Simple Storage Service account-level BPA and how it affects Lightsail buckets, see Block public access for buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.

Lightsail throws this exception when an account is still in the setup in progress state.

Describes an add-on that is enabled for an Amazon Lightsail resource.

Describes a request to enable, modify, or disable an add-on for an Amazon Lightsail resource.

An additional cost may be associated with enabling add-ons. For more information, see the Lightsail pricing page.

Describes an alarm.

An alarm is a way to monitor your Lightsail resource metrics. For more information, see Alarms in Amazon Lightsail.

Container for the parameters to the AllocateStaticIp operation. Allocates a static IP address.

This is the response object from the AllocateStaticIp operation.

Container for the parameters to the AttachCertificateToDistribution operation. Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.

After the certificate is attached, your distribution accepts HTTPS traffic for all of the domains that are associated with the certificate.

Use the CreateCertificate action to create a certificate that you can attach to your distribution.

This is the response object from the AttachCertificateToDistribution operation.

Container for the parameters to the AttachDisk operation. Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.

The attach disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the AttachDisk operation.

Describes a block storage disk that is attached to an instance, and is included in an automatic snapshot.

Container for the parameters to the AttachInstancesToLoadBalancer operation. Attaches one or more Lightsail instances to a load balancer.

After some time, the instances are attached to the load balancer and the health check status is available.

The attach instances to load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Developer Guide.

This is the response object from the AttachInstancesToLoadBalancer operation.

Container for the parameters to the AttachLoadBalancerTlsCertificate operation. 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 Amazon Lightsail Developer Guide.

This is the response object from the AttachLoadBalancerTlsCertificate operation.

Container for the parameters to the AttachStaticIp operation. Attaches a static IP address to a specific Amazon Lightsail instance.

This is the response object from the AttachStaticIp operation.

Describes a request to enable or modify the automatic snapshot add-on for an Amazon Lightsail instance or disk.

When you modify the automatic snapshot time for a resource, it is typically effective immediately except under the following conditions:

• If an automatic snapshot has been created for the current day, and you change the snapshot time to a later time of day, then the new snapshot time will be effective the following day. This ensures that two snapshots are not created for the current day.

• If an automatic snapshot has not yet been created for the current day, and you change the snapshot time to an earlier time of day, then the new snapshot time will be effective the following day and a snapshot is automatically created at the previously set time for the current day. This ensures that a snapshot is created for the current day.

• If an automatic snapshot has not yet been created for the current day, and you change the snapshot time to a time that is within 30 minutes from your current time, then the new snapshot time will be effective the following day and a snapshot is automatically created at the previously set time for the current day. This ensures that a snapshot is created for the current day, because 30 minutes is required between your current time and the new snapshot time that you specify.

• If an automatic snapshot is scheduled to be created within 30 minutes from your current time and you change the snapshot time, then the new snapshot time will be effective the following day and a snapshot is automatically created at the previously set time for the current day. This ensures that a snapshot is created for the current day, because 30 minutes is required between your current time and the new snapshot time that you specify.

Describes an automatic snapshot.

Describes an Availability Zone. This is returned only as part of a GetRegions request.

Describes a blueprint (a virtual private server image).

Describes an Amazon Lightsail bucket.

Describes the access log configuration for a bucket in the Amazon Lightsail object storage service.

For more information about bucket access logs, see Logging bucket requests using access logging in Amazon Lightsail in the Amazon Lightsail Developer Guide.

Describes the specifications of a bundle that can be applied to an Amazon Lightsail bucket.

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.

Describes the state of an Amazon Lightsail bucket.

Describes a bundle, which is a set of specs describing your virtual private server (or instance).

Describes the default cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.

Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.

A per-path cache behavior is used to override, or add an exception to, the default cache behavior of a distribution. For example, if the cacheBehavior is set to cache, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will cache. Alternately, if the distribution's cacheBehavior is dont-cache, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will not cache.

Describes the cache settings of an Amazon Lightsail content delivery network (CDN) distribution.

These settings apply only to your distribution's cacheBehaviors (including the defaultCacheBehavior) that have a behavior of cache.

Describes the full details of an Amazon Lightsail SSL/TLS certificate.

To get a summary of a certificate, use the GetCertificates action and omit includeCertificateDetails from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.

Describes an Amazon Lightsail SSL/TLS certificate.

Container for the parameters to the CloseInstancePublicPorts operation. Closes ports for a specific Amazon Lightsail instance.

The CloseInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the CloseInstancePublicPorts operation.

Describes a CloudFormation stack record created as a result of the create cloud formation stack action.

A CloudFormation stack record provides information about the AWS CloudFormation stack used to create a new Amazon Elastic Compute Cloud instance from an exported Lightsail instance snapshot.

Describes the source of a CloudFormation stack record (i.e., the export snapshot record).

Describes a contact method.

A contact method is a way to send you notifications. For more information, see Notifications in Amazon Lightsail.

Describes the settings of a container that will be launched, or that is launched, to an Amazon Lightsail container service.

Describes a container image that is registered to an Amazon Lightsail container service.

Describes an Amazon Lightsail container service.

Describes a container deployment configuration of an Amazon Lightsail container service.

A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.

Describes a container deployment configuration of an Amazon Lightsail container service.

A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.

Describes the activation status of the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.

When activated, Lightsail creates an Identity and Access Management (IAM) role for the specified Lightsail container service. You can use the ARN of the role to create a trust relationship between your Lightsail container service and an Amazon ECR private repository in your Amazon Web Services account. This allows your container service to pull images from Amazon ECR private repositories. For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

Describes a request to activate or deactivate the role that you can use to grant an Amazon Lightsail container service access to Amazon Elastic Container Registry (Amazon ECR) private repositories.

When activated, Lightsail creates an Identity and Access Management (IAM) role for the specified Lightsail container service. You can use the ARN of the role to create a trust relationship between your Lightsail container service and an Amazon ECR private repository in your Amazon Web Services account. This allows your container service to pull images from Amazon ECR private repositories. For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

Describes the public endpoint configuration of a deployment of an Amazon Lightsail container service.

Describes the health check configuration of an Amazon Lightsail container service.

Describes the log events of a container of an Amazon Lightsail container service.

Describes the powers that can be specified for an Amazon Lightsail container service.

The power specifies the amount of RAM, the number of vCPUs, and the base price of the container service.

Describes the sign-in credentials for the container image registry of an Amazon Lightsail account.

Describes the current state of a container service.

Describes whether an Amazon Lightsail content delivery network (CDN) distribution forwards cookies to the origin and, if so, which ones.

For the cookies that you specify, your distribution caches separate versions of the specified content based on the cookie values in viewer requests.

Container for the parameters to the CopySnapshot operation. Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an instance or disk as a manual snapshot. This operation can also be used to copy a manual or automatic snapshot of an instance or a disk from one Amazon Web Services Region to another in Amazon Lightsail.

When copying a manual snapshot, be sure to define the source region, source snapshot name, and target snapshot name parameters.

When copying an automatic snapshot, be sure to define the source region, source resource name, target snapshot name, and either the restore date or the use latest restorable auto snapshot parameters.

This is the response object from the CopySnapshot operation.

Describes the estimated cost for resources in your Lightsail for Research account.

Container for the parameters to the CreateBucketAccessKey operation. Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of an access key ID and corresponding secret access key.

Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the GetBucketAccessKeys action to get a list of current access keys for a specific bucket. For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.

This is the response object from the CreateBucketAccessKey operation.

Container for the parameters to the CreateBucket operation. Creates an Amazon Lightsail bucket.

A bucket is a cloud storage resource available in the Lightsail object storage service. Use buckets to store objects such as data and its descriptive metadata. For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.

This is the response object from the CreateBucket operation.

Container for the parameters to the CreateCertificate operation. Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service.

After the certificate is valid, use the AttachCertificateToDistribution action to use the certificate and its domains with your distribution. Or use the UpdateContainerService action to use the certificate and its domains with your container service.

This is the response object from the CreateCertificate operation.

Container for the parameters to the CreateCloudFormationStack operation. 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.

This is the response object from the CreateCloudFormationStack operation.

Container for the parameters to the CreateContactMethod operation. 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 Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

This is the response object from the CreateContactMethod operation.

Container for the parameters to the CreateContainerServiceDeployment operation. Creates a deployment for your Amazon Lightsail container service.

A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.

You can deploy containers to your container service using container images from a public registry such as Amazon ECR Public, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.

This is the response object from the CreateContainerServiceDeployment operation.

Container for the parameters to the CreateContainerServiceRegistryLogin operation. Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine. After you're logged in, you can use the native Docker commands to push your local container images to the container image registry of your Amazon Lightsail account so that you can use them with your Lightsail container service. The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials.

You can only push container images to the container service registry of your Lightsail account. You cannot pull container images or perform any other container image management actions on the container service registry.

After you push your container images to the container image registry of your Lightsail account, use the RegisterContainerImage action to register the pushed images to a specific Lightsail container service.

This is the response object from the CreateContainerServiceRegistryLogin operation.

Container for the parameters to the CreateContainerService operation. Creates an Amazon Lightsail container service.

A Lightsail container service is a compute resource to which you can deploy containers. For more information, see Container services in Amazon Lightsail in the Lightsail Dev Guide.

This is the response object from the CreateContainerService operation.

Container for the parameters to the CreateDiskFromSnapshot operation. Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to an Amazon Lightsail instance in the same Availability Zone (us-east-2a).

The create disk from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by disk snapshot name. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the CreateDiskFromSnapshot operation.

Container for the parameters to the CreateDisk operation. Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (us-east-2a).

The create disk operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the CreateDisk operation.

Container for the parameters to the CreateDiskSnapshot operation. Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.

You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending.

You can also use this operation to create a snapshot of an instance's system volume. You might want to do this, for example, to recover data from the system volume of a botched instance or to create a backup of the system volume like you would for a block storage disk. To create a snapshot of a system volume, just define the instance name parameter when issuing the snapshot command, and a snapshot of the defined instance's system volume will be created. After the snapshot is available, you can create a block storage disk from the snapshot and attach it to a running instance to access the data on the disk.

The create disk snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the CreateDiskSnapshot operation.

Container for the parameters to the CreateDistribution operation. Creates an Amazon Lightsail content delivery network (CDN) distribution.

A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance. For more information, see Content delivery networks in Amazon Lightsail.

This is the response object from the CreateDistribution operation.

Container for the parameters to the CreateDomainEntry operation. Creates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).

The create domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the CreateDomainEntry operation.

Container for the parameters to the CreateDomain operation. Creates a domain resource for the specified domain (example.com).

The create domain operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the CreateDomain operation.

Container for the parameters to the CreateGUISessionAccessDetails operation. Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session. The primary URL initiates a web-based NICE DCV session to the virtual computer's application. The secondary URL initiates a web-based NICE DCV session to the virtual computer's operating session.

Use StartGUISession to open the session.

This is the response object from the CreateGUISessionAccessDetails operation.

Container for the parameters to the CreateInstancesFromSnapshot operation. Creates one or more new instances from a manual or automatic snapshot of an instance.

The create instances from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by instance snapshot name. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the CreateInstancesFromSnapshot operation.

Container for the parameters to the CreateInstanceSnapshot operation. Creates a snapshot of a specific virtual private server, or instance. You can use a snapshot to create a new instance that is based on that snapshot.

The create instance snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the CreateInstanceSnapshot operation.

Container for the parameters to the CreateInstances operation. Creates one or more Amazon Lightsail instances.

The create instances operation supports tag-based access control via request tags. For more information, see the Lightsail Developer Guide.

This is the response object from the CreateInstances operation.

Container for the parameters to the CreateKeyPair operation. Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.

Use the DownloadDefaultKeyPair action to create a Lightsail default key pair in an Amazon Web Services Region where a default key pair does not currently exist.

The create key pair operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the CreateKeyPair operation.

Container for the parameters to the CreateLoadBalancer operation. Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing. You can create up to 5 load balancers per AWS Region in your account.

When you create a load balancer, you can specify a unique name and port settings. To change additional load balancer settings, use the UpdateLoadBalancerAttribute operation.

The create load balancer operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the CreateLoadBalancer operation.

Container for the parameters to the CreateLoadBalancerTlsCertificate operation. Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.

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 Amazon Lightsail Developer Guide.

This is the response object from the CreateLoadBalancerTlsCertificate operation.

Container for the parameters to the CreateRelationalDatabaseFromSnapshot operation. Creates a new database from an existing database snapshot in Amazon Lightsail.

You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a different plan, such as a high availability or standard plan.

The create relational database from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by relationalDatabaseSnapshotName. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the CreateRelationalDatabaseFromSnapshot operation.

Container for the parameters to the CreateRelationalDatabase operation. Creates a new database in Amazon Lightsail.

The create relational database operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the CreateRelationalDatabase operation.

Container for the parameters to the CreateRelationalDatabaseSnapshot operation. 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 Amazon Lightsail Developer Guide.

This is the response object from the CreateRelationalDatabaseSnapshot operation.

Container for the parameters to the DeleteAlarm operation. 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.

This is the response object from the DeleteAlarm operation.

Container for the parameters to the DeleteAutoSnapshot operation. Deletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the DeleteAutoSnapshot operation.

Container for the parameters to the DeleteBucketAccessKey operation. Deletes an access key for the specified Amazon Lightsail bucket.

We recommend that you delete an access key if the secret access key is compromised.

For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.

This is the response object from the DeleteBucketAccessKey operation.

Container for the parameters to the DeleteBucket operation. Deletes a Amazon Lightsail bucket.

When you delete your bucket, the bucket name is released and can be reused for a new bucket in your account or another Amazon Web Services account.

This is the response object from the DeleteBucket operation.

Container for the parameters to the DeleteCertificate operation. Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.

Certificates that are currently attached to a distribution cannot be deleted. Use the DetachCertificateFromDistribution action to detach a certificate from a distribution.

This is the response object from the DeleteCertificate operation.

Container for the parameters to the DeleteContactMethod operation. 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 Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

This is the response object from the DeleteContactMethod operation.

Container for the parameters to the DeleteContainerImage operation. Deletes a container image that is registered to your Amazon Lightsail container service.

This is the response object from the DeleteContainerImage operation.

Container for the parameters to the DeleteContainerService operation. Deletes your Amazon Lightsail container service.

This is the response object from the DeleteContainerService operation.

Container for the parameters to the DeleteDisk operation. 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 Amazon Lightsail Developer Guide.

This is the response object from the DeleteDisk operation.

Container for the parameters to the DeleteDiskSnapshot operation. Deletes the specified disk snapshot.

When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk.

The delete disk snapshot operation supports tag-based access control via resource tags applied to the resource identified by disk snapshot name. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the DeleteDiskSnapshot operation.

Container for the parameters to the DeleteDistribution operation. Deletes your Amazon Lightsail content delivery network (CDN) distribution.

This is the response object from the DeleteDistribution operation.

Container for the parameters to the DeleteDomainEntry operation. Deletes a specific domain entry.

The delete domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the DeleteDomainEntry operation.

Container for the parameters to the DeleteDomain operation. Deletes the specified domain recordset and all of its domain records.

The delete domain operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the DeleteDomain operation.

Container for the parameters to the DeleteInstance operation. Deletes an Amazon Lightsail instance.

The delete instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the DeleteInstance operation.

Container for the parameters to the DeleteInstanceSnapshot operation. Deletes a specific snapshot of a virtual private server (or instance).

The delete instance snapshot operation supports tag-based access control via resource tags applied to the resource identified by instance snapshot name. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the DeleteInstanceSnapshot operation.

Container for the parameters to the DeleteKeyPair operation. Deletes the specified key pair by removing the public key from Amazon Lightsail.

You can delete key pairs that were created using the ImportKeyPair and CreateKeyPair actions, as well as the Lightsail default key pair. A new default key pair will not be created unless you launch an instance without specifying a custom key pair, or you call the DownloadDefaultKeyPair API.

The delete key pair operation supports tag-based access control via resource tags applied to the resource identified by key pair name. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the DeleteKeyPair operation.

Container for the parameters to the DeleteKnownHostKeys operation. Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance. This operation enables the Lightsail browser-based SSH or RDP clients to connect to the instance after a host key mismatch.

Perform this operation only if you were expecting the host key or certificate mismatch or if you are familiar with the new host key or certificate on the instance. For more information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP client.

This is the response object from the DeleteKnownHostKeys operation.

Container for the parameters to the DeleteLoadBalancer operation. Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again.

The delete load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the DeleteLoadBalancer operation.

Container for the parameters to the DeleteLoadBalancerTlsCertificate operation. 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 Amazon Lightsail Developer Guide.

This is the response object from the DeleteLoadBalancerTlsCertificate operation.

Container for the parameters to the DeleteRelationalDatabase operation. Deletes a database in Amazon Lightsail.

The delete relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the DeleteRelationalDatabase operation.

Container for the parameters to the DeleteRelationalDatabaseSnapshot operation. Deletes a database snapshot in Amazon Lightsail.

The delete relational database snapshot operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the DeleteRelationalDatabaseSnapshot operation.

Describes the destination of a record.

Container for the parameters to the DetachCertificateFromDistribution operation. Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.

After the certificate is detached, your distribution stops accepting traffic for all of the domains that are associated with the certificate.

This is the response object from the DetachCertificateFromDistribution operation.

Container for the parameters to the DetachDisk operation. Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk.

The detach disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the DetachDisk operation.

Container for the parameters to the DetachInstancesFromLoadBalancer operation. Detaches the specified instances from a Lightsail load balancer.

This operation waits until the instances are no longer needed before they are detached from the load balancer.

The detach instances from load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the DetachInstancesFromLoadBalancer operation.

Container for the parameters to the DetachStaticIp operation. Detaches a static IP from the Amazon Lightsail instance to which it is attached.

This is the response object from the DetachStaticIp operation.

Container for the parameters to the DisableAddOn operation. Disables an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the DisableAddOn operation.

Describes a block storage disk.

Describes a disk.

Describes a block storage disk mapping.

Describes a block storage disk snapshot.

Describes a disk snapshot.

Describes the specifications of a distribution bundle.

Describes the creation state of the canonical name (CNAME) records that are automatically added by Amazon Lightsail to the DNS of a domain to validate domain ownership for an SSL/TLS certificate.

When you create an SSL/TLS certificate for a Lightsail resource, you must add a set of CNAME records to the DNS of the domains for the certificate to validate that you own the domains. Lightsail can automatically add the CNAME records to the DNS of the domain if the DNS zone for the domain exists within your Lightsail account. If automatic record addition fails, or if you manage the DNS of your domain using a third-party service, then you must manually add the CNAME records to the DNS of your domain. For more information, see Verify an SSL/TLS certificate in Amazon Lightsail in the Amazon Lightsail Developer Guide.

Describes a domain where you are storing recordsets.

Describes a domain recordset entry.

Describes the domain name system (DNS) records that you must add to the DNS of your registered domain to validate ownership for an Amazon Lightsail SSL/TLS certificate.

Container for the parameters to the DownloadDefaultKeyPair operation. Downloads the regional Amazon Lightsail default key pair.

This action also creates a Lightsail default key pair if a default key pair does not currently exist in the Amazon Web Services Region.

This is the response object from the DownloadDefaultKeyPair operation.

Container for the parameters to the EnableAddOn operation. Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the EnableAddOn operation.

Describes the settings of a public endpoint for an Amazon Lightsail container service.

An estimate that's associated with a time period.

Describes an export snapshot record.

Describes the source of an export snapshot record.

Container for the parameters to the ExportSnapshot operation. Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot record that can be used with the create cloud formation stack operation to create new Amazon EC2 instances.

Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot.

The export snapshot operation supports tag-based access control via resource tags applied to the resource identified by source snapshot name. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the ExportSnapshot operation.

Container for the parameters to the GetActiveNames operation. Returns the names of all active (not deleted) resources.

This is the response object from the GetActiveNames operation.

Container for the parameters to the GetAlarms operation. 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.

This is the response object from the GetAlarms operation.

Container for the parameters to the GetAutoSnapshots operation. Returns the available automatic snapshots for an instance or disk. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the GetAutoSnapshots operation.

Container for the parameters to the GetBlueprints operation. Returns the list of available instance images, or blueprints. You can use a blueprint to create a new instance already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.

Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.

This is the response object from the GetBlueprints operation.

Container for the parameters to the GetBucketAccessKeys operation. Returns the existing access key IDs for the specified Amazon Lightsail bucket.

This action does not return the secret access key value of an access key. You can get a secret access key only when you create it from the response of the CreateBucketAccessKey action. If you lose the secret access key, you must create a new access key.

This is the response object from the GetBucketAccessKeys operation.

Container for the parameters to the GetBucketBundles operation. Returns the bundles that you can apply to a Amazon Lightsail bucket.

The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a bucket.

Use the UpdateBucketBundle action to update the bundle for a bucket.

This is the response object from the GetBucketBundles operation.

Container for the parameters to the GetBucketMetricData operation. Returns the data points of a specific metric for an Amazon Lightsail bucket.

Metrics report the utilization of a bucket. View and collect metric data regularly to monitor the number of objects stored in a bucket (including object versions) and the storage space used by those objects.

This is the response object from the GetBucketMetricData operation.

Container for the parameters to the GetBuckets operation. Returns information about one or more Amazon Lightsail buckets. The information returned includes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account-level block public access feature for your Lightsail buckets.

For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.

This is the response object from the GetBuckets operation.

Container for the parameters to the GetBundles operation. Returns the bundles that you can apply to an Amazon Lightsail instance when you create it.

A bundle describes the specifications of an instance, such as the monthly cost, amount of memory, the number of vCPUs, amount of storage space, and monthly network data transfer quota.

This is the response object from the GetBundles operation.

Container for the parameters to the GetCertificates operation. Returns information about one or more Amazon Lightsail SSL/TLS certificates.

To get a summary of a certificate, omit includeCertificateDetails from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.

This is the response object from the GetCertificates operation.

Container for the parameters to the GetCloudFormationStackRecords operation. 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.

This is the response object from the GetCloudFormationStackRecords operation.

Container for the parameters to the GetContactMethods operation. 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 Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

This is the response object from the GetContactMethods operation.

Container for the parameters to the GetContainerAPIMetadata operation. Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin.

This is the response object from the GetContainerAPIMetadata operation.

Container for the parameters to the GetContainerImages operation. Returns the container images that are registered to your Amazon Lightsail container service.

If you created a deployment on your Lightsail container service that uses container images from a public registry like Docker Hub, those images are not returned as part of this action. Those images are not registered to your Lightsail container service.

This is the response object from the GetContainerImages operation.

Container for the parameters to the GetContainerLog operation. Returns the log events of a container of your Amazon Lightsail container service.

If your container service has more than one node (i.e., a scale greater than 1), then the log events that are returned for the specified container are merged from all nodes on your container service.

This is the response object from the GetContainerLog operation.

Container for the parameters to the GetContainerServiceDeployments operation. Returns the deployments for your Amazon Lightsail container service

A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.

The deployments are ordered by version in ascending order. The newest version is listed at the top of the response.

This is the response object from the GetContainerServiceDeployments operation.

Container for the parameters to the GetContainerServiceMetricData operation. Returns the data points of a specific metric of your Amazon Lightsail container service.

Metrics report the utilization of your resources. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

This is the response object from the GetContainerServiceMetricData operation.

Container for the parameters to the GetContainerServicePowers operation. Returns the list of powers that can be specified for your Amazon Lightsail container services.

The power specifies the amount of memory, the number of vCPUs, and the base price of the container service.

This is the response object from the GetContainerServicePowers operation.

Container for the parameters to the GetContainerServices operation. Returns information about one or more of your Amazon Lightsail container services.

This is the response object from the GetContainerServices operation.

Container for the parameters to the GetCostEstimate operation. Retrieves information about the cost estimate for a specified resource. A cost estimate will not generate for a resource that has been deleted.

This is the response object from the GetCostEstimate operation.

Container for the parameters to the GetDisk operation. Returns information about a specific block storage disk.

This is the response object from the GetDisk operation.

Container for the parameters to the GetDiskSnapshot operation. Returns information about a specific block storage disk snapshot.

This is the response object from the GetDiskSnapshot operation.

Container for the parameters to the GetDiskSnapshots operation. Returns information about all block storage disk snapshots in your AWS account and region.

This is the response object from the GetDiskSnapshots operation.

Container for the parameters to the GetDisks operation. Returns information about all block storage disks in your AWS account and region.

This is the response object from the GetDisks operation.

Container for the parameters to the GetDistributionBundles operation. Returns the bundles that can be applied to your Amazon Lightsail content delivery network (CDN) distributions.

A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution.

This is the response object from the GetDistributionBundles operation.

Container for the parameters to the GetDistributionLatestCacheReset operation. Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution.

This is the response object from the GetDistributionLatestCacheReset operation.

Container for the parameters to the GetDistributionMetricData operation. Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.

Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

This is the response object from the GetDistributionMetricData operation.

Container for the parameters to the GetDistributions operation. Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.

This is the response object from the GetDistributions operation.

Container for the parameters to the GetDomain operation. Returns information about a specific domain recordset.

This is the response object from the GetDomain operation.

Container for the parameters to the GetDomains operation. Returns a list of all domains in the user's account.

This is the response object from the GetDomains operation.

Container for the parameters to the GetExportSnapshotRecords operation. Returns all export snapshot records created as a result of the export snapshot operation.

An export snapshot record can be used to create a new Amazon EC2 instance and its related resources with the CreateCloudFormationStack action.

This is the response object from the GetExportSnapshotRecords operation.

Container for the parameters to the GetInstanceAccessDetails operation. Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.

The get instance access details operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the GetInstanceAccessDetails operation.

Container for the parameters to the GetInstanceMetricData operation. Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.

Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

This is the response object from the GetInstanceMetricData operation.

Container for the parameters to the GetInstancePortStates operation. Returns the firewall port states for a specific Amazon Lightsail instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.

This is the response object from the GetInstancePortStates operation.

Container for the parameters to the GetInstance operation. Returns information about a specific Amazon Lightsail instance, which is a virtual private server.

This is the response object from the GetInstance operation.

Container for the parameters to the GetInstanceSnapshot operation. Returns information about a specific instance snapshot.

This is the response object from the GetInstanceSnapshot operation.

Container for the parameters to the GetInstanceSnapshots operation. Returns all instance snapshots for the user's account.

This is the response object from the GetInstanceSnapshots operation.

Container for the parameters to the GetInstances operation. Returns information about all Amazon Lightsail virtual private servers, or instances.

This is the response object from the GetInstances operation.

Container for the parameters to the GetInstanceState operation. Returns the state of a specific instance. Works on one instance at a time.

This is the response object from the GetInstanceState operation.

Container for the parameters to the GetKeyPair operation. Returns information about a specific key pair.

This is the response object from the GetKeyPair operation.

Container for the parameters to the GetKeyPairs operation. Returns information about all key pairs in the user's account.

This is the response object from the GetKeyPairs operation.

Container for the parameters to the GetLoadBalancerMetricData operation. Returns information about health metrics for your Lightsail load balancer.

Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

This is the response object from the GetLoadBalancerMetricData operation.

Container for the parameters to the GetLoadBalancer operation. Returns information about the specified Lightsail load balancer.

This is the response object from the GetLoadBalancer operation.

Container for the parameters to the GetLoadBalancers operation. Returns information about all load balancers in an account.

This is the response object from the GetLoadBalancers operation.

Container for the parameters to the GetLoadBalancerTlsCertificates operation. Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

You can have a maximum of 2 certificates associated with a Lightsail load balancer. One is active and the other is inactive.

This is the response object from the GetLoadBalancerTlsCertificates operation.

Container for the parameters to the GetLoadBalancerTlsPolicies operation. Returns a list of TLS security policies that you can apply to Lightsail load balancers.

For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide.

This is the response object from the GetLoadBalancerTlsPolicies operation.

Container for the parameters to the GetOperation operation. Returns information about a specific operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on.

This is the response object from the GetOperation operation.

Container for the parameters to the GetOperationsForResource operation. Gets operations for a specific resource (an instance or a static IP).

This is the response object from the GetOperationsForResource operation.

Container for the parameters to the GetOperations operation. Returns information about all operations.

Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each subsequent call to GetOperations use the maximum (last) statusChangedAt value from the previous request.

This is the response object from the GetOperations operation.

Container for the parameters to the GetRegions operation. Returns a list of all valid regions for Amazon Lightsail. Use the include availability zones parameter to also return the Availability Zones in a region.

This is the response object from the GetRegions operation.

Container for the parameters to the GetRelationalDatabaseBlueprints operation. Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database.

You can use a blueprint ID to create a new database that runs a specific database engine.

This is the response object from the GetRelationalDatabaseBlueprints operation.

Container for the parameters to the GetRelationalDatabaseBundles operation. Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database.

You can use a bundle ID to create a new database with explicit performance specifications.

This is the response object from the GetRelationalDatabaseBundles operation.

Container for the parameters to the GetRelationalDatabaseEvents operation. Returns a list of events for a specific database in Amazon Lightsail.

This is the response object from the GetRelationalDatabaseEvents operation.

Container for the parameters to the GetRelationalDatabaseLogEvents operation. Returns a list of log events for a database in Amazon Lightsail.

This is the response object from the GetRelationalDatabaseLogEvents operation.

Container for the parameters to the GetRelationalDatabaseLogStreams operation. Returns a list of available log streams for a specific database in Amazon Lightsail.

This is the response object from the GetRelationalDatabaseLogStreams operation.

Container for the parameters to the GetRelationalDatabaseMasterUserPassword operation. Returns the current, previous, or pending versions of the master user password for a Lightsail database.

The GetRelationalDatabaseMasterUserPassword operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName.

This is the response object from the GetRelationalDatabaseMasterUserPassword operation.

Container for the parameters to the GetRelationalDatabaseMetricData operation. Returns the data points of the specified metric for a database in Amazon Lightsail.

Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

This is the response object from the GetRelationalDatabaseMetricData operation.

Container for the parameters to the GetRelationalDatabaseParameters operation. Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail.

In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a reboot, whether the parameter is modifiable, the allowed values, and the data types.

This is the response object from the GetRelationalDatabaseParameters operation.

Container for the parameters to the GetRelationalDatabase operation. Returns information about a specific database in Amazon Lightsail.

This is the response object from the GetRelationalDatabase operation.

Container for the parameters to the GetRelationalDatabaseSnapshot operation. Returns information about a specific database snapshot in Amazon Lightsail.

This is the response object from the GetRelationalDatabaseSnapshot operation.

Container for the parameters to the GetRelationalDatabaseSnapshots operation. Returns information about all of your database snapshots in Amazon Lightsail.

This is the response object from the GetRelationalDatabaseSnapshots operation.

Container for the parameters to the GetRelationalDatabases operation. Returns information about all of your databases in Amazon Lightsail.

This is the response object from the GetRelationalDatabases operation.

Container for the parameters to the GetSetupHistory operation. Returns detailed information for five of the most recent SetupInstanceHttps requests that were ran on the target instance.

This is the response object from the GetSetupHistory operation.

Container for the parameters to the GetStaticIp operation. Returns information about an Amazon Lightsail static IP.

This is the response object from the GetStaticIp operation.

Container for the parameters to the GetStaticIps operation. Returns information about all static IPs in the user's account.

This is the response object from the GetStaticIps operation.

Describes the request headers that a Lightsail distribution bases caching on.

For the headers that you specify, your distribution caches separate versions of the specified content based on the header values in viewer requests. For example, suppose viewer requests for logo.jpg contain a custom product header that has a value of either acme or apex, and you configure your distribution to cache your content based on values in the product header. Your distribution forwards the product header to the origin and caches the response from the origin once for each header value.

Describes the public SSH host keys or the RDP certificate.

Container for the parameters to the ImportKeyPair operation. Imports a public SSH key from a specific key pair.

This is the response object from the ImportKeyPair operation.

Describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution.

An origin can be a Lightsail instance, bucket, container service, or load balancer. A distribution pulls content from an origin, caches it, and serves it to viewers via a worldwide network of edge servers.

Describes an instance (a virtual private server).

The parameters for gaining temporary access to one of your Amazon Lightsail instances.

Describes the Amazon Elastic Compute Cloud instance and related resources to be created using the create cloud formation stack operation.

Describes the hardware for the instance.

Describes information about the health of the instance.

The metadata options for the instance.

Describes monthly data transfer rates and port information for an instance.

Describes information about ports for an Amazon Lightsail instance.

Describes open ports on an instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.

Describes an instance snapshot.

Describes an instance snapshot.

Describes the virtual private server (or instance) status.

Lightsail throws this exception when user input does not conform to the validation rules of an input field.

Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

Container for the parameters to the IsVpcPeered operation. Returns a Boolean value indicating whether your Lightsail VPC is peered.

This is the response object from the IsVpcPeered operation.

Describes an SSH key pair.

Describes an Amazon Lightsail content delivery network (CDN) distribution.

Describes a load balancer.

Describes a load balancer SSL/TLS certificate.

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

An object that describes the state of the canonical name (CNAME) records that are automatically added by Lightsail to the DNS of the domain to validate domain ownership.

Contains information about the domain names on an SSL/TLS certificate that you will use to validate domain ownership.

Describes the validation record of each domain name in the SSL/TLS certificate.

Contains information about the status of Lightsail's managed renewal for the certificate.

The renewal status of the certificate.

The following renewal status are possible:

• PendingAutoRenewal - Lightsail is attempting to automatically validate the domain names in the certificate. No further action is required.

• PendingValidation - Lightsail couldn't automatically validate one or more domain names in the certificate. You must take action to validate these domain names or the certificate won't be renewed. If you used DNS validation, check to make sure your certificate's domain validation records exist in your domain's DNS, and that your certificate remains in use.

• Success - All domain names in the certificate are validated, and Lightsail renewed the certificate. No further action is required.

• Failed - One or more domain names were not validated before the certificate expired, and Lightsail did not renew the certificate. You can request a new certificate using the CreateCertificate action.

Provides a summary of SSL/TLS certificate metadata.

Describes the TLS security policies that are available for Lightsail load balancers.

For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide.

Describes a database log event.

Describes the metric data point.

Describes resource being monitored by an alarm.

An alarm is a way to monitor your Amazon Lightsail resource metrics. For more information, see Alarms in Amazon Lightsail.

Describes the monthly data transfer in and out of your virtual private server (or instance).

Describes the state of the name server records update made by Amazon Lightsail to an Amazon Route 53 registered domain.

For more information, see DNS in Amazon Lightsail in the Amazon Lightsail Developer Guide.

Lightsail throws this exception when it cannot find a resource.

Container for the parameters to the OpenInstancePublicPorts operation. Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol.

The OpenInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the OpenInstancePublicPorts operation.

Describes the API operation.

Lightsail throws this exception when an operation fails to execute.

Describes the origin resource of an Amazon Lightsail content delivery network (CDN) distribution.

An origin can be a Lightsail instance, bucket, or load balancer. A distribution pulls content from an origin, caches it, and serves it to viewers via a worldwide network of edge servers.

The password data for the Windows Server-based instance, including the ciphertext and the key pair name.

Container for the parameters to the PeerVpc operation. Peers the Lightsail VPC with the user's default VPC.

This is the response object from the PeerVpc operation.

Describes a pending database maintenance action.

Describes a pending database value modification.

Describes ports to open on an instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.

Describes the configuration for an Amazon Lightsail container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

Describes a request to configure an Amazon Lightsail container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.

For more information, see Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service in the Amazon Lightsail Developer Guide.

Container for the parameters to the PutAlarm operation. 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.

This is the response object from the PutAlarm operation.

Container for the parameters to the PutInstancePublicPorts operation. Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol. This action also closes all currently open ports that are not included in the request. Include all of the ports and the protocols you want to open in your PutInstancePublicPortsrequest. Or use the OpenInstancePublicPorts action to open ports without closing currently open ports.

The PutInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identified by instanceName. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the PutInstancePublicPorts operation.

Describes the query string parameters that an Amazon Lightsail content delivery network (CDN) distribution to bases caching on.

For the query strings that you specify, your distribution caches separate versions of the specified content based on the query string values in viewer requests.

Describes the deletion state of an Amazon Route 53 hosted zone for a domain that is being automatically delegated to an Amazon Lightsail DNS zone.

Container for the parameters to the RebootInstance operation. Restarts a specific instance.

The reboot instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the RebootInstance operation.

Container for the parameters to the RebootRelationalDatabase operation. Restarts a specific database in Amazon Lightsail.

The reboot relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the RebootRelationalDatabase operation.

Describes the Amazon Web Services Region.

Container for the parameters to the RegisterContainerImage operation. Registers a container image to your Amazon Lightsail container service.

This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.

This is the response object from the RegisterContainerImage operation.

Describes the delegation state of an Amazon Route 53 registered domain to Amazon Lightsail.

When you delegate an Amazon Route 53 registered domain to Lightsail, you can manage the DNS of the domain using a Lightsail DNS zone. You no longer use the Route 53 hosted zone to manage the DNS of the domain. To delegate the domain, Lightsail automatically updates the domain's name servers in Route 53 to the name servers of the Lightsail DNS zone. Then, Lightsail automatically deletes the Route 53 hosted zone for the domain.

All of the following conditions must be true for automatic domain delegation to be successful:

• The registered domain must be in the same Amazon Web Services account as the Lightsail account making the request.

• The user or entity making the request must have permission to manage domains in Route 53.

• The Route 53 hosted zone for the domain must be empty. It cannot contain DNS records other than start of authority (SOA) and name server records.

If automatic domain delegation fails, or if you manage the DNS of your domain using a service other than Route 53, then you must manually add the Lightsail DNS zone name servers to your domain in order to delegate management of its DNS to Lightsail. For more information, see Creating a DNS zone to manage your domain’s records in Amazon Lightsail in the Amazon Lightsail Developer Guide.

Describes a database.

Describes a database image, or blueprint. A blueprint describes the major engine version of a database.

Describes a database bundle. A bundle describes the performance specifications of the database.

Describes an endpoint for a database.

Describes an event for a database.

Describes the hardware of a database.

Describes the parameters of a database.

Describes a database snapshot.

Container for the parameters to the ReleaseStaticIp operation. Deletes a specific static IP from your account.

This is the response object from the ReleaseStaticIp operation.

Describes the status of a SSL/TLS certificate renewal managed by Amazon Lightsail.

Container for the parameters to the ResetDistributionCache operation. Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution.

After resetting the cache, the next time a content request is made, your distribution pulls, serves, and caches it from the origin.

This is the response object from the ResetDistributionCache operation.

Describes the estimated cost or usage that a budget tracks.

Describes the resource location.

Describes an Amazon Lightsail instance that has access to a Lightsail bucket.

Describes the domain name system (DNS) records to add to your domain's DNS to validate it for an Amazon Lightsail certificate.

Container for the parameters to the SendContactMethodVerification operation. 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 Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services 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.

This is the response object from the SendContactMethodVerification operation.

A general service exception.

Describes a web-based, remote graphical user interface (GUI), NICE DCV session. The session is used to access a virtual computer’s operating system or application.

Container for the parameters to the SetIpAddressType operation. Sets the IP address type for an Amazon Lightsail resource.

Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the specified resource. Alternately, you can use this action to disable dual-stack, and enable IPv4 only.

This is the response object from the SetIpAddressType operation.

Container for the parameters to the SetResourceAccessForBucket operation. Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.

Lightsail buckets currently support setting access for Lightsail instances in the same Amazon Web Services Region.

This is the response object from the SetResourceAccessForBucket operation.

Returns details about the commands that were run.

Returns a list of the commands that were ran on the target resource.

The status of each command is also returned.

The Lightsail resource that SetupHistory was ran on.

Container for the parameters to the SetupInstanceHttps operation. Creates an SSL/TLS certificate that secures traffic for your website. After the certificate is created, it is installed on the specified Lightsail instance.

If you provide more than one domain name in the request, at least one name must be less than or equal to 63 characters in length.

This is the response object from the SetupInstanceHttps operation.

Returns information that was submitted during the SetupInstanceHttps request. Email information is redacted for privacy.

Container for the parameters to the StartGUISession operation. Initiates a graphical user interface (GUI) session that’s used to access a virtual computer’s operating system and application. The session will be active for 1 hour. Use this action to resume the session after it expires.

This is the response object from the StartGUISession operation.

Container for the parameters to the StartInstance operation. 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 Amazon Lightsail Developer 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 Amazon Lightsail Developer Guide.

This is the response object from the StartInstance operation.

Container for the parameters to the StartRelationalDatabase operation. Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the reboot relational database operation.

The start relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the StartRelationalDatabase operation.

Describes a static IP.

Container for the parameters to the StopGUISession operation. Terminates a web-based NICE DCV session that’s used to access a virtual computer’s operating system or application. The session will close and any unsaved data will be lost.

This is the response object from the StopGUISession operation.

Describes a request to create or edit the StopInstanceOnIdle add-on.

This add-on only applies to Lightsail for Research resources.

Container for the parameters to the StopInstance operation. Stops a specific Amazon Lightsail instance that is currently running.

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 Amazon Lightsail Developer Guide.

The stop instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the StopInstance operation.

Container for the parameters to the StopRelationalDatabase operation. Stops a specific database that is currently running in Amazon Lightsail.

The stop relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the StopRelationalDatabase operation.

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

For more information about tags in Lightsail, see the Amazon Lightsail Developer Guide.

Container for the parameters to the TagResource operation. 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 Amazon Lightsail Developer 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 Amazon Lightsail Developer Guide.

This is the response object from the TagResource operation.

Container for the parameters to the TestAlarm operation. 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.

This is the response object from the TestAlarm operation.

Sets the start date and end date for retrieving a cost estimate. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

Lightsail throws this exception when the user has not been authenticated.

Container for the parameters to the UnpeerVpc operation. Unpeers the Lightsail VPC from the user's default VPC.

This is the response object from the UnpeerVpc operation.

Container for the parameters to the UntagResource operation. Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.

The untag 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 Amazon Lightsail Developer Guide.

This is the response object from the UntagResource operation.

Container for the parameters to the UpdateBucketBundle operation. Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.

A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. You can update a bucket's bundle only one time within a monthly Amazon Web Services billing cycle. To determine if you can update a bucket's bundle, use the GetBuckets action. The ableToUpdateBundle parameter in the response will indicate whether you can currently update a bucket's bundle.

Update a bucket's bundle if it's consistently going over its storage space or data transfer quota, or if a bucket's usage is consistently in the lower range of its storage space or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might experience, we strongly recommend that you update a bucket's bundle only as a long-term strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle that will provide the bucket with ample storage space and data transfer for a long time to come.

This is the response object from the UpdateBucketBundle operation.

Container for the parameters to the UpdateBucket operation. Updates an existing Amazon Lightsail bucket.

Use this action to update the configuration of an existing bucket, such as versioning, public accessibility, and the Amazon Web Services accounts that can access the bucket.

This is the response object from the UpdateBucket operation.

Container for the parameters to the UpdateContainerService operation. Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain names.

This is the response object from the UpdateContainerService operation.

Container for the parameters to the UpdateDistributionBundle operation. Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.

A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution.

Update your distribution's bundle if your distribution is going over its monthly network transfer quota and is incurring an overage fee.

You can update your distribution's bundle only one time within your monthly Amazon Web Services billing cycle. To determine if you can update your distribution's bundle, use the GetDistributions action. The ableToUpdateBundle parameter in the result will indicate whether you can currently update your distribution's bundle.

This is the response object from the UpdateDistributionBundle operation.

Container for the parameters to the UpdateDistribution operation. Updates an existing Amazon Lightsail content delivery network (CDN) distribution.

Use this action to update the configuration of your existing distribution.

This is the response object from the UpdateDistribution operation.

Container for the parameters to the UpdateDomainEntry operation. Updates a domain recordset after it is created.

The update domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the UpdateDomainEntry operation.

Container for the parameters to the UpdateInstanceMetadataOptions operation. Modifies the Amazon Lightsail instance metadata parameters on a running or stopped instance. When you modify the parameters on a running instance, the GetInstance or GetInstances API operation initially responds with a state of pending. After the parameter modifications are successfully applied, the state changes to applied in subsequent GetInstance or GetInstances API calls. For more information, see Use IMDSv2 with an Amazon Lightsail instance in the Amazon Lightsail Developer Guide.

This is the response object from the UpdateInstanceMetadataOptions operation.

Container for the parameters to the UpdateLoadBalancerAttribute operation. Updates the specified attribute for a load balancer. You can only update one attribute at a time.

The update load balancer attribute operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the UpdateLoadBalancerAttribute operation.

Container for the parameters to the UpdateRelationalDatabaseParameters operation. Allows the update of one or more parameters of a database in Amazon Lightsail.

Parameter updates don't cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which parameter updates are applied: dynamic or pending-reboot. Parameters marked with a dynamic apply type are applied immediately. Parameters marked with a pending-reboot apply type are applied only after the database is rebooted using the reboot relational database operation.

The update relational database parameters operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the UpdateRelationalDatabaseParameters operation.

Container for the parameters to the UpdateRelationalDatabase operation. Allows the update of one or more attributes of a database in Amazon Lightsail.

Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database's predefined maintenance window.

The update relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

This is the response object from the UpdateRelationalDatabase operation.