amazonaws.com – lightsail

OpenAPI apis-guru cloud

Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes everything you need to launch your project quickly - instances (virtual private servers), container services, storage buckets, managed databases, SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN) distributions, DNS management of registered domains, and resource snapshots (backups) - for a low, predictable monthly price.

You can manage your Lightsail resources using the Lightsail console, Lightsail API, Command Line Interface (CLI), or SDKs. For more information about Lightsail concepts and tasks, see the .

This API Reference provides detailed information about the actions, data types, parameters, and errors of the Lightsail service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see in the Amazon Web Services General Reference.

Homepage: https://api.apis.guru/v2/specs/amazonaws.com:lightsail/2016-11-28.json
Provider: amazonaws.com:lightsail / lightsail
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/amazonaws.com/lightsail/2016-11-28/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/amazonaws.com/lightsail/2016-11-28/openapi.yaml

Tools (161)

Extracted live via the executor SDK.

xAmzTargetLightsail20161128AllocateStaticIp.allocateStaticIp

Allocates a static IP address.
xAmzTargetLightsail20161128AttachCertificateToDistribution.attachCertificateToDistribution

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.

Only certificates created in the us-east-1 Amazon Web Services Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.
xAmzTargetLightsail20161128AttachDisk.attachDisk

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 .
xAmzTargetLightsail20161128AttachInstancesToLoadBalancer.attachInstancesToLoadBalancer

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 .
xAmzTargetLightsail20161128AttachLoadBalancerTlsCertificate.attachLoadBalancerTlsCertificate

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 .
xAmzTargetLightsail20161128AttachStaticIp.attachStaticIp

Attaches a static IP address to a specific Amazon Lightsail instance.
xAmzTargetLightsail20161128CloseInstancePublicPorts.closeInstancePublicPorts

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 .
xAmzTargetLightsail20161128CopySnapshot.copySnapshot

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.
xAmzTargetLightsail20161128CreateBucket.createBucket

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 in the Amazon Lightsail Developer Guide.
xAmzTargetLightsail20161128CreateBucketAccessKey.createBucketAccessKey

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 action to get a list of current access keys for a specific bucket. For more information about access keys, see in the Amazon Lightsail Developer Guide.

The secretAccessKey value is returned only in response to the CreateBucketAccessKey action. You can get a secret access key only when you first create an access key; you cannot get the secret access key later. If you lose the secret access key, you must create a new access key.
xAmzTargetLightsail20161128CreateCertificate.createCertificate

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.

Only certificates created in the us-east-1 Amazon Web Services Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.
xAmzTargetLightsail20161128CreateCloudFormationStack.createCloudFormationStack

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.
xAmzTargetLightsail20161128CreateContactMethod.createContactMethod

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 .
xAmzTargetLightsail20161128CreateContainerService.createContainerService

Creates an Amazon Lightsail container service.

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

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 in the Amazon Lightsail Developer Guide.
xAmzTargetLightsail20161128CreateContainerServiceRegistryLogin.createContainerServiceRegistryLogin

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 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 in the Amazon Lightsail Developer Guide.
xAmzTargetLightsail20161128CreateDisk.createDisk

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 .
xAmzTargetLightsail20161128CreateDiskFromSnapshot.createDiskFromSnapshot

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 (e.g., 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 .
xAmzTargetLightsail20161128CreateDiskSnapshot.createDiskSnapshot

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 .
xAmzTargetLightsail20161128CreateDistribution.createDistribution

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 .
xAmzTargetLightsail20161128CreateDomain.createDomain

Creates a domain resource for the specified domain (e.g., example.com).

The create domain operation supports tag-based access control via request tags. For more information, see the .
xAmzTargetLightsail20161128CreateDomainEntry.createDomainEntry

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 .
xAmzTargetLightsail20161128CreateGuiSessionAccessDetails.createGuiSessionAccessDetails

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.
xAmzTargetLightsail20161128CreateInstances.createInstances

Creates one or more Amazon Lightsail instances.

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

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 .
xAmzTargetLightsail20161128CreateInstanceSnapshot.createInstanceSnapshot

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 .
xAmzTargetLightsail20161128CreateKeyPair.createKeyPair

Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.

Use the 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 .
xAmzTargetLightsail20161128CreateLoadBalancer.createLoadBalancer

Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see . 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 .
xAmzTargetLightsail20161128CreateLoadBalancerTlsCertificate.createLoadBalancerTlsCertificate

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 .
xAmzTargetLightsail20161128CreateRelationalDatabase.createRelationalDatabase

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 .
xAmzTargetLightsail20161128CreateRelationalDatabaseFromSnapshot.createRelationalDatabaseFromSnapshot

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 .
xAmzTargetLightsail20161128CreateRelationalDatabaseSnapshot.createRelationalDatabaseSnapshot

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 .
xAmzTargetLightsail20161128DeleteAlarm.deleteAlarm

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 .
xAmzTargetLightsail20161128DeleteAutoSnapshot.deleteAutoSnapshot

Deletes an automatic snapshot of an instance or disk. For more information, see the .
xAmzTargetLightsail20161128DeleteBucket.deleteBucket

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.
xAmzTargetLightsail20161128DeleteBucketAccessKey.deleteBucketAccessKey

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 in the Amazon Lightsail Developer Guide.
xAmzTargetLightsail20161128DeleteCertificate.deleteCertificate

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.
xAmzTargetLightsail20161128DeleteContactMethod.deleteContactMethod

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 .
xAmzTargetLightsail20161128DeleteContainerImage.deleteContainerImage

Deletes a container image that is registered to your Amazon Lightsail container service.
xAmzTargetLightsail20161128DeleteContainerService.deleteContainerService

Deletes your Amazon Lightsail container service.
xAmzTargetLightsail20161128DeleteDisk.deleteDisk

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 .
xAmzTargetLightsail20161128DeleteDiskSnapshot.deleteDiskSnapshot

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 .
xAmzTargetLightsail20161128DeleteDistribution.deleteDistribution

Deletes your Amazon Lightsail content delivery network (CDN) distribution.
xAmzTargetLightsail20161128DeleteDomain.deleteDomain

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 .
xAmzTargetLightsail20161128DeleteDomainEntry.deleteDomainEntry

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 .
xAmzTargetLightsail20161128DeleteInstance.deleteInstance

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 .
xAmzTargetLightsail20161128DeleteInstanceSnapshot.deleteInstanceSnapshot

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 .
xAmzTargetLightsail20161128DeleteKeyPair.deleteKeyPair

Deletes the specified key pair by removing the public key from Amazon Lightsail.

You can delete key pairs that were created using the and 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 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 .
xAmzTargetLightsail20161128DeleteKnownHostKeys.deleteKnownHostKeys

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 .
xAmzTargetLightsail20161128DeleteLoadBalancer.deleteLoadBalancer

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 .
xAmzTargetLightsail20161128DeleteLoadBalancerTlsCertificate.deleteLoadBalancerTlsCertificate

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 .
xAmzTargetLightsail20161128DeleteRelationalDatabase.deleteRelationalDatabase

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 .
xAmzTargetLightsail20161128DeleteRelationalDatabaseSnapshot.deleteRelationalDatabaseSnapshot

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 .
xAmzTargetLightsail20161128DetachCertificateFromDistribution.detachCertificateFromDistribution

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.
xAmzTargetLightsail20161128DetachDisk.detachDisk

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 .
xAmzTargetLightsail20161128DetachInstancesFromLoadBalancer.detachInstancesFromLoadBalancer

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 .
xAmzTargetLightsail20161128DetachStaticIp.detachStaticIp

Detaches a static IP from the Amazon Lightsail instance to which it is attached.
xAmzTargetLightsail20161128DisableAddOn.disableAddOn

Disables an add-on for an Amazon Lightsail resource. For more information, see the .
xAmzTargetLightsail20161128DownloadDefaultKeyPair.downloadDefaultKeyPair

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.
xAmzTargetLightsail20161128EnableAddOn.enableAddOn

Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the .
xAmzTargetLightsail20161128ExportSnapshot.exportSnapshot

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 .

Use the get instance snapshots or get disk snapshots operations to get a list of snapshots that you can export to Amazon EC2.
xAmzTargetLightsail20161128GetActiveNames.getActiveNames

Returns the names of all active (not deleted) resources.
xAmzTargetLightsail20161128GetAlarms.getAlarms

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 .
xAmzTargetLightsail20161128GetAutoSnapshots.getAutoSnapshots

Returns the available automatic snapshots for an instance or disk. For more information, see the .
xAmzTargetLightsail20161128GetBlueprints.getBlueprints

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.
xAmzTargetLightsail20161128GetBucketAccessKeys.getBucketAccessKeys

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 action. If you lose the secret access key, you must create a new access key.
xAmzTargetLightsail20161128GetBucketBundles.getBucketBundles

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 action to update the bundle for a bucket.
xAmzTargetLightsail20161128GetBucketMetricData.getBucketMetricData

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.
xAmzTargetLightsail20161128GetBuckets.getBuckets

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 in the Amazon Lightsail Developer Guide.
xAmzTargetLightsail20161128GetBundles.getBundles

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.

Bundles are referred to as instance plans in the Lightsail console.
xAmzTargetLightsail20161128GetCertificates.getCertificates

Returns information about one or more Amazon Lightsail SSL/TLS certificates.

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

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.
xAmzTargetLightsail20161128GetContactMethods.getContactMethods

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 .
xAmzTargetLightsail20161128GetContainerApiMetadata.getContainerApiMetadata

Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin.
xAmzTargetLightsail20161128GetContainerImages.getContainerImages

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.
xAmzTargetLightsail20161128GetContainerLog.getContainerLog

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.

Container logs are retained for a certain amount of time. For more information, see in the Amazon Web Services General Reference.
xAmzTargetLightsail20161128GetContainerServiceDeployments.getContainerServiceDeployments

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.

A set number of deployments are kept before the oldest one is replaced with the newest one. For more information, see in the Amazon Web Services General Reference.
xAmzTargetLightsail20161128GetContainerServiceMetricData.getContainerServiceMetricData

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.
xAmzTargetLightsail20161128GetContainerServicePowers.getContainerServicePowers

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.
xAmzTargetLightsail20161128GetContainerServices.getContainerServices

Returns information about one or more of your Amazon Lightsail container services.
xAmzTargetLightsail20161128GetCostEstimate.getCostEstimate

Retrieves information about the cost estimate for a specified resource. A cost estimate will not generate for a resource that has been deleted.
xAmzTargetLightsail20161128GetDisk.getDisk

Returns information about a specific block storage disk.
xAmzTargetLightsail20161128GetDisks.getDisks

Returns information about all block storage disks in your AWS account and region.
xAmzTargetLightsail20161128GetDiskSnapshot.getDiskSnapshot

Returns information about a specific block storage disk snapshot.
xAmzTargetLightsail20161128GetDiskSnapshots.getDiskSnapshots

Returns information about all block storage disk snapshots in your AWS account and region.
xAmzTargetLightsail20161128GetDistributionBundles.getDistributionBundles

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.
xAmzTargetLightsail20161128GetDistributionLatestCacheReset.getDistributionLatestCacheReset

Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution.
xAmzTargetLightsail20161128GetDistributionMetricData.getDistributionMetricData

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.
xAmzTargetLightsail20161128GetDistributions.getDistributions

Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.
xAmzTargetLightsail20161128GetDomain.getDomain

Returns information about a specific domain recordset.
xAmzTargetLightsail20161128GetDomains.getDomains

Returns a list of all domains in the user's account.
xAmzTargetLightsail20161128GetExportSnapshotRecords.getExportSnapshotRecords

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 action.
xAmzTargetLightsail20161128GetInstance.getInstance

Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
xAmzTargetLightsail20161128GetInstanceAccessDetails.getInstanceAccessDetails

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 .
xAmzTargetLightsail20161128GetInstanceMetricData.getInstanceMetricData

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.
xAmzTargetLightsail20161128GetInstancePortStates.getInstancePortStates

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.
xAmzTargetLightsail20161128GetInstances.getInstances

Returns information about all Amazon Lightsail virtual private servers, or instances.
xAmzTargetLightsail20161128GetInstanceSnapshot.getInstanceSnapshot

Returns information about a specific instance snapshot.
xAmzTargetLightsail20161128GetInstanceSnapshots.getInstanceSnapshots

Returns all instance snapshots for the user's account.
xAmzTargetLightsail20161128GetInstanceState.getInstanceState

Returns the state of a specific instance. Works on one instance at a time.
xAmzTargetLightsail20161128GetKeyPair.getKeyPair

Returns information about a specific key pair.
xAmzTargetLightsail20161128GetKeyPairs.getKeyPairs

Returns information about all key pairs in the user's account.
xAmzTargetLightsail20161128GetLoadBalancer.getLoadBalancer

Returns information about the specified Lightsail load balancer.
xAmzTargetLightsail20161128GetLoadBalancerMetricData.getLoadBalancerMetricData

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.
xAmzTargetLightsail20161128GetLoadBalancers.getLoadBalancers

Returns information about all load balancers in an account.
xAmzTargetLightsail20161128GetLoadBalancerTlsCertificates.getLoadBalancerTlsCertificates

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.
xAmzTargetLightsail20161128GetLoadBalancerTlsPolicies.getLoadBalancerTlsPolicies

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 in the Amazon Lightsail Developer Guide.
xAmzTargetLightsail20161128GetOperation.getOperation

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.
xAmzTargetLightsail20161128GetOperations.getOperations

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.
xAmzTargetLightsail20161128GetOperationsForResource.getOperationsForResource

Gets operations for a specific resource (e.g., an instance or a static IP).
xAmzTargetLightsail20161128GetRegions.getRegions

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.
xAmzTargetLightsail20161128GetRelationalDatabase.getRelationalDatabase

Returns information about a specific database in Amazon Lightsail.
xAmzTargetLightsail20161128GetRelationalDatabaseBlueprints.getRelationalDatabaseBlueprints

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.
xAmzTargetLightsail20161128GetRelationalDatabaseBundles.getRelationalDatabaseBundles

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.
xAmzTargetLightsail20161128GetRelationalDatabaseEvents.getRelationalDatabaseEvents

Returns a list of events for a specific database in Amazon Lightsail.
xAmzTargetLightsail20161128GetRelationalDatabaseLogEvents.getRelationalDatabaseLogEvents

Returns a list of log events for a database in Amazon Lightsail.
xAmzTargetLightsail20161128GetRelationalDatabaseLogStreams.getRelationalDatabaseLogStreams

Returns a list of available log streams for a specific database in Amazon Lightsail.
xAmzTargetLightsail20161128GetRelationalDatabaseMasterUserPassword.getRelationalDatabaseMasterUserPassword

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.
xAmzTargetLightsail20161128GetRelationalDatabaseMetricData.getRelationalDatabaseMetricData

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.
xAmzTargetLightsail20161128GetRelationalDatabaseParameters.getRelationalDatabaseParameters

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.
xAmzTargetLightsail20161128GetRelationalDatabases.getRelationalDatabases

Returns information about all of your databases in Amazon Lightsail.
xAmzTargetLightsail20161128GetRelationalDatabaseSnapshot.getRelationalDatabaseSnapshot

Returns information about a specific database snapshot in Amazon Lightsail.
xAmzTargetLightsail20161128GetRelationalDatabaseSnapshots.getRelationalDatabaseSnapshots

Returns information about all of your database snapshots in Amazon Lightsail.
xAmzTargetLightsail20161128GetStaticIp.getStaticIp

Returns information about an Amazon Lightsail static IP.
xAmzTargetLightsail20161128GetStaticIps.getStaticIps

Returns information about all static IPs in the user's account.
xAmzTargetLightsail20161128ImportKeyPair.importKeyPair

Imports a public SSH key from a specific key pair.
xAmzTargetLightsail20161128IsVpcPeered.isVpcPeered

Returns a Boolean value indicating whether your Lightsail VPC is peered.
xAmzTargetLightsail20161128OpenInstancePublicPorts.openInstancePublicPorts

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 .
xAmzTargetLightsail20161128PeerVpc.peerVpc

Peers the Lightsail VPC with the user's default VPC.
xAmzTargetLightsail20161128PutAlarm.putAlarm

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 .

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.
xAmzTargetLightsail20161128PutInstancePublicPorts.putInstancePublicPorts

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 .
xAmzTargetLightsail20161128RebootInstance.rebootInstance

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 .
xAmzTargetLightsail20161128RebootRelationalDatabase.rebootRelationalDatabase

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 .
xAmzTargetLightsail20161128RegisterContainerImage.registerContainerImage

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 in the Amazon Lightsail Developer Guide.
xAmzTargetLightsail20161128ReleaseStaticIp.releaseStaticIp

Deletes a specific static IP from your account.
xAmzTargetLightsail20161128ResetDistributionCache.resetDistributionCache

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.
xAmzTargetLightsail20161128SendContactMethodVerification.sendContactMethodVerification

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 .

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.
xAmzTargetLightsail20161128SetIpAddressType.setIpAddressType

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.
xAmzTargetLightsail20161128SetResourceAccessForBucket.setResourceAccessForBucket

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.
xAmzTargetLightsail20161128StartGuiSession.startGuiSession

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.
xAmzTargetLightsail20161128StartInstance.startInstance

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 .

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 .
xAmzTargetLightsail20161128StartRelationalDatabase.startRelationalDatabase

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 .
xAmzTargetLightsail20161128StopGuiSession.stopGuiSession

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.
xAmzTargetLightsail20161128StopInstance.stopInstance

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 .

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 .
xAmzTargetLightsail20161128StopRelationalDatabase.stopRelationalDatabase

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 .
xAmzTargetLightsail20161128TagResource.tagResource

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 .

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 .
xAmzTargetLightsail20161128TestAlarm.testAlarm

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 .
xAmzTargetLightsail20161128UnpeerVpc.unpeerVpc

Unpeers the Lightsail VPC from the user's default VPC.
xAmzTargetLightsail20161128UntagResource.untagResource

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 .
xAmzTargetLightsail20161128UpdateBucket.updateBucket

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.
xAmzTargetLightsail20161128UpdateBucketBundle.updateBucketBundle

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 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.
xAmzTargetLightsail20161128UpdateContainerService.updateContainerService

Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain names.
xAmzTargetLightsail20161128UpdateDistribution.updateDistribution

Updates an existing Amazon Lightsail content delivery network (CDN) distribution.

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

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.
xAmzTargetLightsail20161128UpdateDomainEntry.updateDomainEntry

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 .
xAmzTargetLightsail20161128UpdateInstanceMetadataOptions.updateInstanceMetadataOptions

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 in the Amazon Lightsail Developer Guide.
xAmzTargetLightsail20161128UpdateLoadBalancerAttribute.updateLoadBalancerAttribute

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 .
xAmzTargetLightsail20161128UpdateRelationalDatabase.updateRelationalDatabase

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 .
xAmzTargetLightsail20161128UpdateRelationalDatabaseParameters.updateRelationalDatabaseParameters

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 .
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools