Amazon Lightsail
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…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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 Amazon Lightsail Developer Guide .
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
Amazon Lightsail Endpoints
and Quotas in the Amazon Web Services General Reference .
Endpoints 167
- POSTAllocate static ip
/#X-Amz-Target=Lightsail_20161128.AllocateStaticIpAllocates a static IP address. - POSTAttach certificate to distribution
/#X-Amz-Target=Lightsail_20161128.AttachCertificateToDistributionAttaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution. After the certificate is attached, your distribution… - POSTAttach disk
/#X-Amz-Target=Lightsail_20161128.AttachDiskAttaches 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… - POSTAttach instances to load balancer
/#X-Amz-Target=Lightsail_20161128.AttachInstancesToLoadBalancerAttaches 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… - POSTAttach load balancer tls certificate
/#X-Amz-Target=Lightsail_20161128.AttachLoadBalancerTlsCertificateAttaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). Once… - POSTAttach static ip
/#X-Amz-Target=Lightsail_20161128.AttachStaticIpAttaches a static IP address to a specific Amazon Lightsail instance. - POSTCheck subdomain availability
/#X-Amz-Target=Lightsail_20161128.CheckSubdomainAvailabilityChecks whether a Lightsail subdomain is available to create. Optionally, reserves the subdomain for your account for 15 minutes. If you don't reserve the… - POSTClose instance public ports
/#X-Amz-Target=Lightsail_20161128.CloseInstancePublicPortsCloses ports for a specific Amazon Lightsail instance. The CloseInstancePublicPorts action supports tag-based access control via resource tags applied to the… - POSTCopy snapshot
/#X-Amz-Target=Lightsail_20161128.CopySnapshotCopies 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… - POSTCreate bucket
/#X-Amz-Target=Lightsail_20161128.CreateBucketCreates an Amazon Lightsail bucket. A bucket is a cloud storage resource available in the Lightsail object storage service. Use buckets to store objects such… - POSTCreate bucket access key
/#X-Amz-Target=Lightsail_20161128.CreateBucketAccessKeyCreates 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… - POSTCreate certificate
/#X-Amz-Target=Lightsail_20161128.CreateCertificateCreates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service. After the certificate is valid,… - POSTCreate cloud formation stack
/#X-Amz-Target=Lightsail_20161128.CreateCloudFormationStackCreates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot. This operation results in a… - POSTCreate contact method
/#X-Amz-Target=Lightsail_20161128.CreateContactMethodCreates 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… - POSTCreate container service
/#X-Amz-Target=Lightsail_20161128.CreateContainerServiceCreates an Amazon Lightsail container service. A Lightsail container service is a compute resource to which you can deploy containers. For more information,… - POSTCreate container service deployment
/#X-Amz-Target=Lightsail_20161128.CreateContainerServiceDeploymentCreates a deployment for your Amazon Lightsail container service. A deployment specifies the containers that will be launched on the container service and… - POSTCreate container service registry login
/#X-Amz-Target=Lightsail_20161128.CreateContainerServiceRegistryLoginCreates 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… - POSTCreate disk
/#X-Amz-Target=Lightsail_20161128.CreateDiskCreates 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… - POSTCreate disk from snapshot
/#X-Amz-Target=Lightsail_20161128.CreateDiskFromSnapshotCreates 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… - POSTCreate disk snapshot
/#X-Amz-Target=Lightsail_20161128.CreateDiskSnapshotCreates 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… - POSTCreate distribution
/#X-Amz-Target=Lightsail_20161128.CreateDistributionCreates an Amazon Lightsail content delivery network (CDN) distribution. A distribution is a globally distributed network of caching servers that improve the… - POSTCreate domain
/#X-Amz-Target=Lightsail_20161128.CreateDomainCreates a domain resource for the specified domain (example.com). The create domain operation supports tag-based access control via request tags. For more… - POSTCreate domain entry
/#X-Amz-Target=Lightsail_20161128.CreateDomainEntryCreates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name (CNAME), mail exchanger (MX), name server… - POSTCreate gUI session access details
/#X-Amz-Target=Lightsail_20161128.CreateGUISessionAccessDetailsCreates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session. The primary URL initiates a web-based Amazon DCV session… - POSTCreate instance snapshot
/#X-Amz-Target=Lightsail_20161128.CreateInstanceSnapshotCreates 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… - POSTCreate instances
/#X-Amz-Target=Lightsail_20161128.CreateInstancesCreates one or more Amazon Lightsail instances. The create instances operation supports tag-based access control via request tags. For more information, see… - POSTCreate instances from snapshot
/#X-Amz-Target=Lightsail_20161128.CreateInstancesFromSnapshotCreates one or more new instances from a manual or automatic snapshot of an instance. The create instances from snapshot operation supports tag-based access… - POSTCreate key pair
/#X-Amz-Target=Lightsail_20161128.CreateKeyPairCreates 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… - POSTCreate load balancer
/#X-Amz-Target=Lightsail_20161128.CreateLoadBalancerCreates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load… - POSTCreate load balancer tls certificate
/#X-Amz-Target=Lightsail_20161128.CreateLoadBalancerTlsCertificateCreates an SSL/TLS certificate for an Amazon Lightsail load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). The… - POSTCreate relational database
/#X-Amz-Target=Lightsail_20161128.CreateRelationalDatabaseCreates a new database in Amazon Lightsail. The create relational database operation supports tag-based access control via request tags. For more information,… - POSTCreate relational database from snapshot
/#X-Amz-Target=Lightsail_20161128.CreateRelationalDatabaseFromSnapshotCreates 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… - POSTCreate relational database snapshot
/#X-Amz-Target=Lightsail_20161128.CreateRelationalDatabaseSnapshotCreates 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… - POSTCreate subdomain
/#X-Amz-Target=Lightsail_20161128.CreateSubdomainCreates a Lightsail subdomain, such as mysite , with the web address mysite.amazonlightsail.com . After the subdomain is created, use the… - POSTDelete alarm
/#X-Amz-Target=Lightsail_20161128.DeleteAlarmDeletes 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,… - POSTDelete auto snapshot
/#X-Amz-Target=Lightsail_20161128.DeleteAutoSnapshotDeletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide . - POSTDelete bucket
/#X-Amz-Target=Lightsail_20161128.DeleteBucketDeletes 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… - POSTDelete bucket access key
/#X-Amz-Target=Lightsail_20161128.DeleteBucketAccessKeyDeletes 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… - POSTDelete certificate
/#X-Amz-Target=Lightsail_20161128.DeleteCertificateDeletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution. Certificates that are currently attached to a… - POSTDelete contact method
/#X-Amz-Target=Lightsail_20161128.DeleteContactMethodDeletes 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… - POSTDelete container image
/#X-Amz-Target=Lightsail_20161128.DeleteContainerImageDeletes a container image that is registered to your Amazon Lightsail container service. - POSTDelete container service
/#X-Amz-Target=Lightsail_20161128.DeleteContainerServiceDeletes your Amazon Lightsail container service. - POSTDelete disk
/#X-Amz-Target=Lightsail_20161128.DeleteDiskDeletes 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… - POSTDelete disk snapshot
/#X-Amz-Target=Lightsail_20161128.DeleteDiskSnapshotDeletes 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… - POSTDelete distribution
/#X-Amz-Target=Lightsail_20161128.DeleteDistributionDeletes your Amazon Lightsail content delivery network (CDN) distribution. - POSTDelete domain
/#X-Amz-Target=Lightsail_20161128.DeleteDomainDeletes the specified domain recordset and all of its domain records. The delete domain operation supports tag-based access control via resource tags applied… - POSTDelete domain entry
/#X-Amz-Target=Lightsail_20161128.DeleteDomainEntryDeletes a specific domain entry. The delete domain entry operation supports tag-based access control via resource tags applied to the resource identified by… - POSTDelete instance
/#X-Amz-Target=Lightsail_20161128.DeleteInstanceDeletes an Amazon Lightsail instance. The delete instance operation supports tag-based access control via resource tags applied to the resource identified by… - POSTDelete instance snapshot
/#X-Amz-Target=Lightsail_20161128.DeleteInstanceSnapshotDeletes a specific snapshot of a virtual private server (or instance ). The delete instance snapshot operation supports tag-based access control via resource… - POSTDelete key pair
/#X-Amz-Target=Lightsail_20161128.DeleteKeyPairDeletes the specified key pair by removing the public key from Amazon Lightsail. You can delete key pairs that were created using the ImportKeyPair and… - POSTDelete known host keys
/#X-Amz-Target=Lightsail_20161128.DeleteKnownHostKeysDeletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance. This operation enables… - POSTDelete load balancer
/#X-Amz-Target=Lightsail_20161128.DeleteLoadBalancerDeletes 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,… - POSTDelete load balancer tls certificate
/#X-Amz-Target=Lightsail_20161128.DeleteLoadBalancerTlsCertificateDeletes an SSL/TLS certificate associated with a Lightsail load balancer. The DeleteLoadBalancerTlsCertificate operation supports tag-based access control via… - POSTDelete relational database
/#X-Amz-Target=Lightsail_20161128.DeleteRelationalDatabaseDeletes a database in Amazon Lightsail. The delete relational database operation supports tag-based access control via resource tags applied to the resource… - POSTDelete relational database snapshot
/#X-Amz-Target=Lightsail_20161128.DeleteRelationalDatabaseSnapshotDeletes a database snapshot in Amazon Lightsail. The delete relational database snapshot operation supports tag-based access control via resource tags applied… - POSTDelete subdomain
/#X-Amz-Target=Lightsail_20161128.DeleteSubdomainDeletes a Lightsail subdomain. The subdomain must be in the UNATTACHED or CREATE_FAILED state. To delete a subdomain that's associated with a resource, first… - POSTDetach certificate from distribution
/#X-Amz-Target=Lightsail_20161128.DetachCertificateFromDistributionDetaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution. After the certificate is detached, your distribution… - POSTDetach disk
/#X-Amz-Target=Lightsail_20161128.DetachDiskDetaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before… - POSTDetach instances from load balancer
/#X-Amz-Target=Lightsail_20161128.DetachInstancesFromLoadBalancerDetaches the specified instances from a Lightsail load balancer. This operation waits until the instances are no longer needed before they are detached from… - POSTDetach static ip
/#X-Amz-Target=Lightsail_20161128.DetachStaticIpDetaches a static IP from the Amazon Lightsail instance to which it is attached. - POSTDisable add on
/#X-Amz-Target=Lightsail_20161128.DisableAddOnDisables an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide . - POSTDownload default key pair
/#X-Amz-Target=Lightsail_20161128.DownloadDefaultKeyPairDownloads 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… - POSTEnable add on
/#X-Amz-Target=Lightsail_20161128.EnableAddOnEnables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide . - POSTExport snapshot
/#X-Amz-Target=Lightsail_20161128.ExportSnapshotExports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot… - POSTGet active names
/#X-Amz-Target=Lightsail_20161128.GetActiveNamesReturns the names of all active (not deleted) resources. - POSTGet alarms
/#X-Amz-Target=Lightsail_20161128.GetAlarmsReturns information about the configured alarms. Specify an alarm name in your request to return information about a specific alarm, or specify a monitored… - POSTGet auto snapshots
/#X-Amz-Target=Lightsail_20161128.GetAutoSnapshotsReturns the available automatic snapshots for an instance or disk. For more information, see the Amazon Lightsail Developer Guide . - POSTGet blueprints
/#X-Amz-Target=Lightsail_20161128.GetBlueprintsReturns the list of available instance images, or blueprints . You can use a blueprint to create a new instance already running a specific operating system,… - POSTGet bucket access keys
/#X-Amz-Target=Lightsail_20161128.GetBucketAccessKeysReturns 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… - POSTGet bucket bundles
/#X-Amz-Target=Lightsail_20161128.GetBucketBundlesReturns 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… - POSTGet bucket metric data
/#X-Amz-Target=Lightsail_20161128.GetBucketMetricDataReturns the data points of a specific metric for an Amazon Lightsail bucket. Metrics report the utilization of a bucket. View and collect metric data… - POSTGet buckets
/#X-Amz-Target=Lightsail_20161128.GetBucketsReturns information about one or more Amazon Lightsail buckets. The information returned includes the synchronization status of the Amazon Simple Storage… - POSTGet bundles
/#X-Amz-Target=Lightsail_20161128.GetBundlesReturns 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… - POSTGet certificates
/#X-Amz-Target=Lightsail_20161128.GetCertificatesReturns information about one or more Amazon Lightsail SSL/TLS certificates. To get a summary of a certificate, omit includeCertificateDetails from your… - POSTGet cloud formation stack records
/#X-Amz-Target=Lightsail_20161128.GetCloudFormationStackRecordsReturns 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… - POSTGet contact methods
/#X-Amz-Target=Lightsail_20161128.GetContactMethodsReturns information about the configured contact methods. Specify a protocol in your request to return information about a specific contact method. A contact… - POSTGet container aPI metadata
/#X-Amz-Target=Lightsail_20161128.GetContainerAPIMetadataReturns information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin. - POSTGet container images
/#X-Amz-Target=Lightsail_20161128.GetContainerImagesReturns the container images that are registered to your Amazon Lightsail container service. If you created a deployment on your Lightsail container service… - POSTGet container log
/#X-Amz-Target=Lightsail_20161128.GetContainerLogReturns 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… - POSTGet container service deployments
/#X-Amz-Target=Lightsail_20161128.GetContainerServiceDeploymentsReturns the deployments for your Amazon Lightsail container service A deployment specifies the settings, such as the ports and launch command, of containers… - POSTGet container service metric data
/#X-Amz-Target=Lightsail_20161128.GetContainerServiceMetricDataReturns the data points of a specific metric of your Amazon Lightsail container service. Metrics report the utilization of your resources. Monitor and collect… - POSTGet container service powers
/#X-Amz-Target=Lightsail_20161128.GetContainerServicePowersReturns 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,… - POSTGet container services
/#X-Amz-Target=Lightsail_20161128.GetContainerServicesReturns information about one or more of your Amazon Lightsail container services. - POSTGet cost estimate
/#X-Amz-Target=Lightsail_20161128.GetCostEstimateRetrieves information about the cost estimate for a specified resource. A cost estimate will not generate for a resource that has been deleted. - POSTGet disk
/#X-Amz-Target=Lightsail_20161128.GetDiskReturns information about a specific block storage disk. - POSTGet disk snapshot
/#X-Amz-Target=Lightsail_20161128.GetDiskSnapshotReturns information about a specific block storage disk snapshot. - POSTGet disk snapshots
/#X-Amz-Target=Lightsail_20161128.GetDiskSnapshotsReturns information about all block storage disk snapshots in your AWS account and region. - POSTGet disks
/#X-Amz-Target=Lightsail_20161128.GetDisksReturns information about all block storage disks in your AWS account and region. - POSTGet distribution bundles
/#X-Amz-Target=Lightsail_20161128.GetDistributionBundlesReturns the bundles that can be applied to your Amazon Lightsail content delivery network (CDN) distributions. A distribution bundle specifies the monthly… - POSTGet distribution latest cache reset
/#X-Amz-Target=Lightsail_20161128.GetDistributionLatestCacheResetReturns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution. - POSTGet distribution metric data
/#X-Amz-Target=Lightsail_20161128.GetDistributionMetricDataReturns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution. Metrics report the utilization of your… - POSTGet distributions
/#X-Amz-Target=Lightsail_20161128.GetDistributionsReturns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions. The defaultRootObject and customErrorResponses… - POSTGet domain
/#X-Amz-Target=Lightsail_20161128.GetDomainReturns information about a specific domain recordset. - POSTGet domains
/#X-Amz-Target=Lightsail_20161128.GetDomainsReturns a list of all domains in the user's account. - POSTGet export snapshot records
/#X-Amz-Target=Lightsail_20161128.GetExportSnapshotRecordsReturns 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… - POSTGet instance
/#X-Amz-Target=Lightsail_20161128.GetInstanceReturns information about a specific Amazon Lightsail instance, which is a virtual private server. - POSTGet instance access details
/#X-Amz-Target=Lightsail_20161128.GetInstanceAccessDetailsReturns temporary SSH keys you can use to connect to a specific virtual private server, or instance . The get instance access details operation supports… - POSTGet instance metric data
/#X-Amz-Target=Lightsail_20161128.GetInstanceMetricDataReturns the data points for the specified Amazon Lightsail instance metric, given an instance name. Metrics report the utilization of your resources, and the… - POSTGet instance port states
/#X-Amz-Target=Lightsail_20161128.GetInstancePortStatesReturns the firewall port states for a specific Amazon Lightsail instance, the IP addresses allowed to connect to the instance through the ports, and the… - POSTGet instance snapshot
/#X-Amz-Target=Lightsail_20161128.GetInstanceSnapshotReturns information about a specific instance snapshot. - POSTGet instance snapshots
/#X-Amz-Target=Lightsail_20161128.GetInstanceSnapshotsReturns all instance snapshots for the user's account. - POSTGet instance state
/#X-Amz-Target=Lightsail_20161128.GetInstanceStateReturns the state of a specific instance. Works on one instance at a time. - POSTGet instances
/#X-Amz-Target=Lightsail_20161128.GetInstancesReturns information about all Amazon Lightsail virtual private servers, or instances . - POSTGet key pair
/#X-Amz-Target=Lightsail_20161128.GetKeyPairReturns information about a specific key pair. - POSTGet key pairs
/#X-Amz-Target=Lightsail_20161128.GetKeyPairsReturns information about all key pairs in the user's account. - POSTGet load balancer
/#X-Amz-Target=Lightsail_20161128.GetLoadBalancerReturns information about the specified Lightsail load balancer. - POSTGet load balancer metric data
/#X-Amz-Target=Lightsail_20161128.GetLoadBalancerMetricDataReturns information about health metrics for your Lightsail load balancer. Metrics report the utilization of your resources, and the error counts generated by… - POSTGet load balancer tls certificates
/#X-Amz-Target=Lightsail_20161128.GetLoadBalancerTlsCertificatesReturns information about the TLS certificates that are associated with the specified Lightsail load balancer. TLS is just an updated, more secure version of… - POSTGet load balancer tls policies
/#X-Amz-Target=Lightsail_20161128.GetLoadBalancerTlsPoliciesReturns a list of TLS security policies that you can apply to Lightsail load balancers. For more information about load balancer TLS security policies, see… - POSTGet load balancers
/#X-Amz-Target=Lightsail_20161128.GetLoadBalancersReturns information about all load balancers in an account. - POSTGet operation
/#X-Amz-Target=Lightsail_20161128.GetOperationReturns information about a specific operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and… - POSTGet operations
/#X-Amz-Target=Lightsail_20161128.GetOperationsReturns 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… - POSTGet operations for resource
/#X-Amz-Target=Lightsail_20161128.GetOperationsForResourceGets operations for a specific resource (an instance or a static IP). - POSTGet profile
/#X-Amz-Target=Lightsail_20161128.GetProfileReturns information about the profile of the Amazon Lightsail account that makes the request. The response includes the profile type and, for accounts… - POSTGet regions
/#X-Amz-Target=Lightsail_20161128.GetRegionsReturns a list of all valid regions for Amazon Lightsail. Use the include availability zones parameter to also return the Availability Zones in a region. - POSTGet relational database
/#X-Amz-Target=Lightsail_20161128.GetRelationalDatabaseReturns information about a specific database in Amazon Lightsail. - POSTGet relational database blueprints
/#X-Amz-Target=Lightsail_20161128.GetRelationalDatabaseBlueprintsReturns 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… - POSTGet relational database bundles
/#X-Amz-Target=Lightsail_20161128.GetRelationalDatabaseBundlesReturns 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… - POSTGet relational database events
/#X-Amz-Target=Lightsail_20161128.GetRelationalDatabaseEventsReturns a list of events for a specific database in Amazon Lightsail. - POSTGet relational database log events
/#X-Amz-Target=Lightsail_20161128.GetRelationalDatabaseLogEventsReturns a list of log events for a database in Amazon Lightsail. - POSTGet relational database log streams
/#X-Amz-Target=Lightsail_20161128.GetRelationalDatabaseLogStreamsReturns a list of available log streams for a specific database in Amazon Lightsail. - POSTGet relational database master user password
/#X-Amz-Target=Lightsail_20161128.GetRelationalDatabaseMasterUserPasswordReturns the current, previous, or pending versions of the master user password for a Lightsail database. The GetRelationalDatabaseMasterUserPassword operation… - POSTGet relational database metric data
/#X-Amz-Target=Lightsail_20161128.GetRelationalDatabaseMetricDataReturns the data points of the specified metric for a database in Amazon Lightsail. Metrics report the utilization of your resources, and the error counts… - POSTGet relational database parameters
/#X-Amz-Target=Lightsail_20161128.GetRelationalDatabaseParametersReturns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail. In addition to the… - POSTGet relational database snapshot
/#X-Amz-Target=Lightsail_20161128.GetRelationalDatabaseSnapshotReturns information about a specific database snapshot in Amazon Lightsail. - POSTGet relational database snapshots
/#X-Amz-Target=Lightsail_20161128.GetRelationalDatabaseSnapshotsReturns information about all of your database snapshots in Amazon Lightsail. - POSTGet relational databases
/#X-Amz-Target=Lightsail_20161128.GetRelationalDatabasesReturns information about all of your databases in Amazon Lightsail. - POSTGet setup history
/#X-Amz-Target=Lightsail_20161128.GetSetupHistoryReturns detailed information for five of the most recent SetupInstanceHttps requests that were ran on the target instance. - POSTGet static ip
/#X-Amz-Target=Lightsail_20161128.GetStaticIpReturns information about an Amazon Lightsail static IP. - POSTGet static ips
/#X-Amz-Target=Lightsail_20161128.GetStaticIpsReturns information about all static IPs in the user's account. - POSTGet subdomains
/#X-Amz-Target=Lightsail_20161128.GetSubdomainsReturns information about one or more of your Lightsail subdomains. When you don't specify a subdomain, the response lists your top-level subdomains, and each… - POSTImport key pair
/#X-Amz-Target=Lightsail_20161128.ImportKeyPairImports a public SSH key from a specific key pair. - POSTIs vpc peered
/#X-Amz-Target=Lightsail_20161128.IsVpcPeeredReturns a Boolean value indicating whether your Lightsail VPC is peered. - POSTOpen instance public ports
/#X-Amz-Target=Lightsail_20161128.OpenInstancePublicPortsOpens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol.… - POSTPeer vpc
/#X-Amz-Target=Lightsail_20161128.PeerVpcPeers the Lightsail VPC with the user's default VPC. - POSTPut alarm
/#X-Amz-Target=Lightsail_20161128.PutAlarmCreates 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… - POSTPut instance public ports
/#X-Amz-Target=Lightsail_20161128.PutInstancePublicPortsOpens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol.… - POSTReboot instance
/#X-Amz-Target=Lightsail_20161128.RebootInstanceRestarts a specific instance. The reboot instance operation supports tag-based access control via resource tags applied to the resource identified by instance… - POSTReboot relational database
/#X-Amz-Target=Lightsail_20161128.RebootRelationalDatabaseRestarts a specific database in Amazon Lightsail. The reboot relational database operation supports tag-based access control via resource tags applied to the… - POSTRegister container image
/#X-Amz-Target=Lightsail_20161128.RegisterContainerImageRegisters a container image to your Amazon Lightsail container service. This action is not required if you install and use the Lightsail Control… - POSTRelease static ip
/#X-Amz-Target=Lightsail_20161128.ReleaseStaticIpDeletes a specific static IP from your account. - POSTReset distribution cache
/#X-Amz-Target=Lightsail_20161128.ResetDistributionCacheDeletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution. After resetting the cache, the next time a content… - POSTSend contact method verification
/#X-Amz-Target=Lightsail_20161128.SendContactMethodVerificationSends 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… - POSTSet ip address type
/#X-Amz-Target=Lightsail_20161128.SetIpAddressTypeSets 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… - POSTSet resource access for bucket
/#X-Amz-Target=Lightsail_20161128.SetResourceAccessForBucketSets the Amazon Lightsail resources that can access the specified Lightsail bucket. Lightsail buckets currently support setting access for Lightsail instances… - POSTSetup instance https
/#X-Amz-Target=Lightsail_20161128.SetupInstanceHttpsCreates an SSL/TLS certificate that secures traffic for your website. After the certificate is created, it is installed on the specified Lightsail instance.… - POSTStart gUI session
/#X-Amz-Target=Lightsail_20161128.StartGUISessionInitiates 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… - POSTStart instance
/#X-Amz-Target=Lightsail_20161128.StartInstanceStarts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation. When you start a stopped… - POSTStart relational database
/#X-Amz-Target=Lightsail_20161128.StartRelationalDatabaseStarts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the reboot relational database operation. The start relational… - POSTStop gUI session
/#X-Amz-Target=Lightsail_20161128.StopGUISessionTerminates a web-based Amazon DCV session that’s used to access a virtual computer’s operating system or application. The session will close and any unsaved… - POSTStop instance
/#X-Amz-Target=Lightsail_20161128.StopInstanceStops a specific Amazon Lightsail instance that is currently running. When you start a stopped instance, Lightsail assigns a new public IP address to the… - POSTStop relational database
/#X-Amz-Target=Lightsail_20161128.StopRelationalDatabaseStops a specific database that is currently running in Amazon Lightsail. If you don't manually start your database instance after it has been stopped for… - POSTTag resource
/#X-Amz-Target=Lightsail_20161128.TagResourceAdds 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… - POSTTest alarm
/#X-Amz-Target=Lightsail_20161128.TestAlarmTests 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… - POSTUnpeer vpc
/#X-Amz-Target=Lightsail_20161128.UnpeerVpcUnpeers the Lightsail VPC from the user's default VPC. - POSTUntag resource
/#X-Amz-Target=Lightsail_20161128.UntagResourceDeletes the specified set of tag keys and their values from the specified Amazon Lightsail resource. The untag resource operation supports tag-based access… - POSTUpdate bucket
/#X-Amz-Target=Lightsail_20161128.UpdateBucketUpdates an existing Amazon Lightsail bucket. Use this action to update the configuration of an existing bucket, such as versioning, public accessibility, and… - POSTUpdate bucket bundle
/#X-Amz-Target=Lightsail_20161128.UpdateBucketBundleUpdates the bundle, or storage plan, of an existing Amazon Lightsail bucket. A bucket bundle specifies the monthly cost, storage space, and data transfer… - POSTUpdate container service
/#X-Amz-Target=Lightsail_20161128.UpdateContainerServiceUpdates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain names. - POSTUpdate distribution
/#X-Amz-Target=Lightsail_20161128.UpdateDistributionUpdates an existing Amazon Lightsail content delivery network (CDN) distribution. Use this action to update the configuration of your existing distribution. - POSTUpdate distribution bundle
/#X-Amz-Target=Lightsail_20161128.UpdateDistributionBundleUpdates the bundle of your Amazon Lightsail content delivery network (CDN) distribution. A distribution bundle specifies the monthly network transfer quota… - POSTUpdate domain entry
/#X-Amz-Target=Lightsail_20161128.UpdateDomainEntryUpdates a domain recordset after it is created. The update domain entry operation supports tag-based access control via resource tags applied to the resource… - POSTUpdate instance metadata options
/#X-Amz-Target=Lightsail_20161128.UpdateInstanceMetadataOptionsModifies the Amazon Lightsail instance metadata parameters on a running or stopped instance. When you modify the parameters on a running instance, the… - POSTUpdate load balancer attribute
/#X-Amz-Target=Lightsail_20161128.UpdateLoadBalancerAttributeUpdates the specified attribute for a load balancer. You can only update one attribute at a time. The update load balancer attribute operation supports… - POSTUpdate relational database
/#X-Amz-Target=Lightsail_20161128.UpdateRelationalDatabaseAllows 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… - POSTUpdate relational database parameters
/#X-Amz-Target=Lightsail_20161128.UpdateRelationalDatabaseParametersAllows the update of one or more parameters of a database in Amazon Lightsail. Parameter updates don't cause outages; therefore, their application is not… - POSTUpdate subdomain association
/#X-Amz-Target=Lightsail_20161128.UpdateSubdomainAssociationAssociates a Lightsail subdomain with a resource, disassociates it from a resource, or moves it from one resource to another resource. Currently, you can…
API details
- Base URL
https://lightsail.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 167 operations on 167 pathsPOST 167
- Description format
- AWS Smithy model, API version
2016-11-28 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon Lightsail in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Lightsail collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Allocate static ip” (POST /#X-Amz-Target=Lightsail_20161128.AllocateStaticIp), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon Lightsail?
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… It is listed under Developer tools and has 167 endpoints.
Who publishes the Amazon Lightsail?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon Lightsail?
Requests go to https://lightsail.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon Lightsail?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon Lightsail have?
167 operations on 167 paths (167 POST).
Is forking the Amazon Lightsail free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.