LightsailClient
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.
Functions
Allocates a static IP address.
Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.
Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.
Attaches one or more Lightsail instances to a load balancer.
Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL).
Attaches a static IP address to a specific Amazon Lightsail instance.
Closes ports for a specific Amazon Lightsail instance.
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.
Creates an Amazon Lightsail bucket.
Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of an access key ID and corresponding secret access key.
Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service.
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.
Creates an email or SMS text message contact method.
Creates an Amazon Lightsail container service.
Creates a deployment for your Amazon Lightsail container service.
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.
Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (us-east-2a
).
Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to an Amazon Lightsail instance in the same Availability Zone (us-east-2a
).
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.
Creates an Amazon Lightsail content delivery network (CDN) distribution.
Creates a domain resource for the specified domain (example.com).
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).
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.
Creates one or more Amazon Lightsail instances.
Creates one or more new instances from a manual or automatic snapshot of an instance.
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.
Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.
Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing. You can create up to 5 load balancers per AWS Region in your account.
Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.
Creates a new database in Amazon Lightsail.
Creates a new database from an existing database snapshot in Amazon Lightsail.
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.
Deletes an alarm.
Deletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide.
Deletes a Amazon Lightsail bucket.
Deletes an access key for the specified Amazon Lightsail bucket.
Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.
Deletes a contact method.
Deletes a container image that is registered to your Amazon Lightsail container service.
Deletes your Amazon Lightsail container service.
Deletes the specified block storage disk. The disk must be in the available
state (not attached to a Lightsail instance).
Deletes the specified disk snapshot.
Deletes your Amazon Lightsail content delivery network (CDN) distribution.
Deletes the specified domain recordset and all of its domain records.
Deletes a specific domain entry.
Deletes an Amazon Lightsail instance.
Deletes a specific snapshot of a virtual private server (or instance).
Deletes the specified key pair by removing the public key from Amazon Lightsail.
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.
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.
Deletes an SSL/TLS certificate associated with a Lightsail load balancer.
Deletes a database in Amazon Lightsail.
Deletes a database snapshot in Amazon Lightsail.
Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.
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.
Detaches the specified instances from a Lightsail load balancer.
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
Disables an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.
Downloads the regional Amazon Lightsail default key pair.
Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.
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.
Returns the names of all active (not deleted) resources.
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.
Returns the available automatic snapshots for an instance or disk. For more information, see the Amazon Lightsail Developer Guide.
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.
Returns the existing access key IDs for the specified Amazon Lightsail bucket.
Returns the bundles that you can apply to a Amazon Lightsail bucket.
Returns the data points of a specific metric for an Amazon Lightsail bucket.
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.
Returns the bundles that you can apply to an Amazon Lightsail instance when you create it.
Returns information about one or more Amazon Lightsail SSL/TLS certificates.
Returns the CloudFormation stack record created as a result of the create cloud formation stack
operation.
Returns information about the configured contact methods. Specify a protocol in your request to return information about a specific contact method.
Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin.
Returns the container images that are registered to your Amazon Lightsail container service.
Returns the log events of a container of your Amazon Lightsail container service.
Returns the deployments for your Amazon Lightsail container service
Returns the data points of a specific metric of your Amazon Lightsail container service.
Returns the list of powers that can be specified for your Amazon Lightsail container services.
Returns information about one or more of your Amazon Lightsail container services.
Retrieves information about the cost estimate for a specified resource. A cost estimate will not generate for a resource that has been deleted.
Returns information about a specific block storage disk.
Returns information about all block storage disks in your AWS account and region.
Returns information about a specific block storage disk snapshot.
Returns information about all block storage disk snapshots in your AWS account and region.
Returns the bundles that can be applied to your Amazon Lightsail content delivery network (CDN) distributions.
Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution.
Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.
Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.
Returns information about a specific domain recordset.
Returns a list of all domains in the user's account.
Returns all export snapshot records created as a result of the export snapshot
operation.
Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
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.
Returns information about all Amazon Lightsail virtual private servers, or instances.
Returns information about a specific instance snapshot.
Returns all instance snapshots for the user's account.
Returns the state of a specific instance. Works on one instance at a time.
Returns information about a specific key pair.
Returns information about all key pairs in the user's account.
Returns information about the specified Lightsail load balancer.
Returns information about health metrics for your Lightsail load balancer.
Returns information about all load balancers in an account.
Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.
Returns a list of TLS security policies that you can apply to Lightsail load balancers.
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.
Returns information about all operations.
Gets operations for a specific resource (an instance or a static IP).
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.
Returns information about a specific database in Amazon Lightsail.
Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database.
Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database.
Returns a list of events for a specific database in Amazon Lightsail.
Returns a list of log events for a database in Amazon Lightsail.
Returns a list of available log streams for a specific database in Amazon Lightsail.
Returns the current, previous, or pending versions of the master user password for a Lightsail database.
Returns the data points of the specified metric for a database in Amazon Lightsail.
Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail.
Returns information about all of your databases in Amazon Lightsail.
Returns information about a specific database snapshot in Amazon Lightsail.
Returns information about all of your database snapshots in Amazon Lightsail.
Returns detailed information for five of the most recent SetupInstanceHttps
requests that were ran on the target instance.
Returns information about an Amazon Lightsail static IP.
Returns information about all static IPs in the user's account.
Imports a public SSH key from a specific key pair.
Returns a Boolean value indicating whether your Lightsail VPC is peered.
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.
Peers the Lightsail VPC with the user's default VPC.
Creates or updates an alarm, and associates it with the specified metric.
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 PutInstancePublicPorts
request. Or use the OpenInstancePublicPorts
action to open ports without closing currently open ports.
Restarts a specific instance.
Restarts a specific database in Amazon Lightsail.
Registers a container image to your Amazon Lightsail container service.
Deletes a specific static IP from your account.
Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution.
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.
Sets the IP address type for an Amazon Lightsail resource.
Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.
Creates an SSL/TLS certificate that secures traffic for your website. After the certificate is created, it is installed on the specified Lightsail instance.
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.
Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance
operation.
Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the reboot relational database
operation.
Terminates a web-based NICE DCV session that’s used to access a virtual computer’s operating system or application. The session will close and any unsaved data will be lost.
Stops a specific Amazon Lightsail instance that is currently running.
Stops a specific database that is currently running in Amazon Lightsail.
Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the Amazon Lightsail Developer Guide.
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.
Unpeers the Lightsail VPC from the user's default VPC.
Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.
Updates an existing Amazon Lightsail bucket.
Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.
Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain names.
Updates an existing Amazon Lightsail content delivery network (CDN) distribution.
Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.
Updates a domain recordset after it is created.
Modifies the Amazon Lightsail instance metadata parameters on a running or stopped instance. When you modify the parameters on a running instance, the GetInstance
or GetInstances
API operation initially responds with a state of pending
. After the parameter modifications are successfully applied, the state changes to applied
in subsequent GetInstance
or GetInstances
API calls. For more information, see Use IMDSv2 with an Amazon Lightsail instance in the Amazon Lightsail Developer Guide.
Updates the specified attribute for a load balancer. You can only update one attribute at a time.
Allows the update of one or more attributes of a database in Amazon Lightsail.
Allows the update of one or more parameters of a database in Amazon Lightsail.
Inherited functions
Allocates a static IP address.
Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.
Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.
Attaches one or more Lightsail instances to a load balancer.
Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL).
Attaches a static IP address to a specific Amazon Lightsail instance.
Closes ports for a specific Amazon Lightsail instance.
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.
Creates an Amazon Lightsail bucket.
Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of an access key ID and corresponding secret access key.
Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service.
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.
Creates an email or SMS text message contact method.
Creates an Amazon Lightsail container service.
Creates a deployment for your Amazon Lightsail container service.
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.
Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (us-east-2a
).
Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to an Amazon Lightsail instance in the same Availability Zone (us-east-2a
).
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.
Creates an Amazon Lightsail content delivery network (CDN) distribution.
Creates a domain resource for the specified domain (example.com).
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).
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.
Creates one or more Amazon Lightsail instances.
Creates one or more new instances from a manual or automatic snapshot of an instance.
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.
Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.
Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing. You can create up to 5 load balancers per AWS Region in your account.
Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.
Creates a new database in Amazon Lightsail.
Creates a new database from an existing database snapshot in Amazon Lightsail.
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.
Deletes an alarm.
Deletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide.
Deletes a Amazon Lightsail bucket.
Deletes an access key for the specified Amazon Lightsail bucket.
Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.
Deletes a contact method.
Deletes a container image that is registered to your Amazon Lightsail container service.
Deletes your Amazon Lightsail container service.
Deletes the specified block storage disk. The disk must be in the available
state (not attached to a Lightsail instance).
Deletes the specified disk snapshot.
Deletes your Amazon Lightsail content delivery network (CDN) distribution.
Deletes the specified domain recordset and all of its domain records.
Deletes a specific domain entry.
Deletes an Amazon Lightsail instance.
Deletes a specific snapshot of a virtual private server (or instance).
Deletes the specified key pair by removing the public key from Amazon Lightsail.
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.
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.
Deletes an SSL/TLS certificate associated with a Lightsail load balancer.
Deletes a database in Amazon Lightsail.
Deletes a database snapshot in Amazon Lightsail.
Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.
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.
Detaches the specified instances from a Lightsail load balancer.
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
Disables an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.
Downloads the regional Amazon Lightsail default key pair.
Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.
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.
Returns the names of all active (not deleted) resources.
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.
Returns the available automatic snapshots for an instance or disk. For more information, see the Amazon Lightsail Developer Guide.
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.
Returns the existing access key IDs for the specified Amazon Lightsail bucket.
Returns the bundles that you can apply to a Amazon Lightsail bucket.
Returns the data points of a specific metric for an Amazon Lightsail bucket.
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.
Returns the bundles that you can apply to an Amazon Lightsail instance when you create it.
Returns information about one or more Amazon Lightsail SSL/TLS certificates.
Returns the CloudFormation stack record created as a result of the create cloud formation stack
operation.
Returns information about the configured contact methods. Specify a protocol in your request to return information about a specific contact method.
Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin.
Returns the container images that are registered to your Amazon Lightsail container service.
Returns the log events of a container of your Amazon Lightsail container service.
Returns the deployments for your Amazon Lightsail container service
Returns the data points of a specific metric of your Amazon Lightsail container service.
Returns the list of powers that can be specified for your Amazon Lightsail container services.
Returns information about one or more of your Amazon Lightsail container services.
Retrieves information about the cost estimate for a specified resource. A cost estimate will not generate for a resource that has been deleted.
Returns information about a specific block storage disk.
Returns information about all block storage disks in your AWS account and region.
Returns information about a specific block storage disk snapshot.
Returns information about all block storage disk snapshots in your AWS account and region.
Returns the bundles that can be applied to your Amazon Lightsail content delivery network (CDN) distributions.
Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution.
Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.
Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.
Returns information about a specific domain recordset.
Returns a list of all domains in the user's account.
Returns all export snapshot records created as a result of the export snapshot
operation.
Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
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.
Returns information about all Amazon Lightsail virtual private servers, or instances.
Returns information about a specific instance snapshot.
Returns all instance snapshots for the user's account.
Returns the state of a specific instance. Works on one instance at a time.
Returns information about a specific key pair.
Returns information about all key pairs in the user's account.
Returns information about the specified Lightsail load balancer.
Returns information about health metrics for your Lightsail load balancer.
Returns information about all load balancers in an account.
Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.
Returns a list of TLS security policies that you can apply to Lightsail load balancers.
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.
Returns information about all operations.
Gets operations for a specific resource (an instance or a static IP).
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.
Returns information about a specific database in Amazon Lightsail.
Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database.
Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database.
Returns a list of events for a specific database in Amazon Lightsail.
Returns a list of log events for a database in Amazon Lightsail.
Returns a list of available log streams for a specific database in Amazon Lightsail.
Returns the current, previous, or pending versions of the master user password for a Lightsail database.
Returns the data points of the specified metric for a database in Amazon Lightsail.
Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail.
Returns information about all of your databases in Amazon Lightsail.
Returns information about a specific database snapshot in Amazon Lightsail.
Returns information about all of your database snapshots in Amazon Lightsail.
Returns detailed information for five of the most recent SetupInstanceHttps
requests that were ran on the target instance.
Returns information about an Amazon Lightsail static IP.
Returns information about all static IPs in the user's account.
Imports a public SSH key from a specific key pair.
Returns a Boolean value indicating whether your Lightsail VPC is peered.
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.
Peers the Lightsail VPC with the user's default VPC.
Creates or updates an alarm, and associates it with the specified metric.
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 PutInstancePublicPorts
request. Or use the OpenInstancePublicPorts
action to open ports without closing currently open ports.
Restarts a specific instance.
Restarts a specific database in Amazon Lightsail.
Registers a container image to your Amazon Lightsail container service.
Deletes a specific static IP from your account.
Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution.
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.
Sets the IP address type for an Amazon Lightsail resource.
Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.
Creates an SSL/TLS certificate that secures traffic for your website. After the certificate is created, it is installed on the specified Lightsail instance.
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.
Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance
operation.
Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the reboot relational database
operation.
Terminates a web-based NICE DCV session that’s used to access a virtual computer’s operating system or application. The session will close and any unsaved data will be lost.
Stops a specific Amazon Lightsail instance that is currently running.
Stops a specific database that is currently running in Amazon Lightsail.
Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the Amazon Lightsail Developer Guide.
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.
Unpeers the Lightsail VPC from the user's default VPC.
Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.
Updates an existing Amazon Lightsail bucket.
Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.
Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain names.
Updates an existing Amazon Lightsail content delivery network (CDN) distribution.
Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.
Updates a domain recordset after it is created.
Modifies the Amazon Lightsail instance metadata parameters on a running or stopped instance. When you modify the parameters on a running instance, the GetInstance
or GetInstances
API operation initially responds with a state of pending
. After the parameter modifications are successfully applied, the state changes to applied
in subsequent GetInstance
or GetInstances
API calls. For more information, see Use IMDSv2 with an Amazon Lightsail instance in the Amazon Lightsail Developer Guide.
Updates the specified attribute for a load balancer. You can only update one attribute at a time.
Allows the update of one or more attributes of a database in Amazon Lightsail.
Allows the update of one or more parameters of a database in Amazon Lightsail.
Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.