AWS.Lightsail (aws-elixir v0.8.0) View Source

Amazon Lightsail is the easiest way to get started with Amazon Web Services (AWS) 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, AWS Command Line Interface (AWS 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 AWS Regions, endpoints, and service quotas of the Lightsail service, see Amazon Lightsail Endpoints and Quotas in the AWS General Reference.

Link to this section Summary

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.

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.

Creates an Amazon Lightsail bucket.

Creates a new access key for the specified Amazon Lightsail bucket.

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.

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.

Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a).

Creates a block storage disk from a manual or automatic snapshot of a disk.

Creates a snapshot of a block storage disk.

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

Creates a domain resource for the specified domain (e.g., 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 a snapshot of a specific virtual private server, or instance.

Creates one or more Amazon Lightsail instances.

Creates one or more new instances from a manual or automatic snapshot of an instance.

Creates a Lightsail load balancer.

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.

Deletes an automatic snapshot of an instance or disk.

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 container image that is registered to your Amazon Lightsail container service.

Deletes your Amazon Lightsail container service.

Deletes the specified block storage disk.

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 a specific SSH key pair.

Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance.

Deletes a Lightsail load balancer and all its associated SSL/TLS certificates.

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.

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.

Downloads the default SSH key pair from the user's account.

Enables or modifies an add-on for an Amazon Lightsail resource.

Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2).

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

Returns information about the configured alarms.

Returns the available automatic snapshots for an instance or disk.

Returns the list of available instance images, or blueprints.

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.

Returns the list of bundles that are available for purchase.

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.

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.

Returns information about a specific block storage disk.

Returns information about a specific block storage disk snapshot.

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

Returns information about all block storage disks 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 a specific instance snapshot.

Returns all instance snapshots for the user's account.

Returns the state of a specific instance.

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

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 the TLS certificates that are associated with the specified Lightsail load balancer.

Returns information about all load balancers in an account.

Returns information about a specific operation.

Returns information about all operations.

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

Returns a list of all valid regions for Amazon Lightsail.

Returns information about a specific database in Amazon Lightsail.

Returns a list of available database blueprints in Amazon Lightsail.

Returns the list of bundles that are available in Amazon Lightsail.

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 a specific database snapshot in Amazon Lightsail.

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

Returns information about all of your databases in Amazon Lightsail.

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.

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.

Sets the IP address type for an Amazon Lightsail resource.

Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.

Starts a specific Amazon Lightsail instance from a stopped state.

Starts a specific database from a stopped state in Amazon Lightsail.

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.

Tests an alarm by displaying a banner on the Amazon Lightsail console.

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.

Updates the specified attribute for a load balancer.

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.

Link to this section Functions

Link to this function

allocate_static_ip(client, input, options \\ [])

View Source

Allocates a static IP address.

Link to this function

attach_certificate_to_distribution(client, input, options \\ [])

View Source

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 AWS Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.

Link to this function

attach_disk(client, input, options \\ [])

View Source

Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.

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

Link to this function

attach_instances_to_load_balancer(client, input, options \\ [])

View Source

Attaches one or more Lightsail instances to a load balancer.

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

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

Link to this function

attach_load_balancer_tls_certificate(client, input, options \\ [])

View Source

Attaches a Transport Layer Security (TLS) certificate to your load balancer.

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

Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the AttachLoadBalancerTlsCertificate action with the non-attached certificate, and it will replace the existing one and become the attached certificate.

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

Link to this function

attach_static_ip(client, input, options \\ [])

View Source

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

Link to this function

close_instance_public_ports(client, input, options \\ [])

View Source

Closes ports for a specific Amazon Lightsail instance.

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

Link to this function

copy_snapshot(client, input, options \\ [])

View Source

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 AWS 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.

Link to this function

create_bucket(client, input, options \\ [])

View Source

Creates an Amazon Lightsail bucket.

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

Link to this function

create_bucket_access_key(client, input, options \\ [])

View Source

Creates a new access key for the specified Amazon Lightsail bucket.

Access keys consist of an access key ID and corresponding secret access key.

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

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.

Link to this function

create_certificate(client, input, options \\ [])

View Source

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 AWS Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.

Link to this function

create_cloud_formation_stack(client, input, options \\ [])

View Source

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.

Link to this function

create_contact_method(client, input, options \\ [])

View Source

Creates an email or SMS text message contact method.

A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

Link to this function

create_container_service(client, input, options \\ [])

View Source

Creates an Amazon Lightsail container service.

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

Link to this function

create_container_service_deployment(client, input, options \\ [])

View Source

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 like Docker Hub, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.

Link to this function

create_container_service_registry_login(client, input, options \\ [])

View Source

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 Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.

Link to this function

create_disk(client, input, options \\ [])

View Source

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

Link to this function

create_disk_from_snapshot(client, input, options \\ [])

View Source

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

Link to this function

create_disk_snapshot(client, input, options \\ [])

View Source

Creates a snapshot of a block storage disk.

You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.

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

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

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

Link to this function

create_distribution(client, input, options \\ [])

View Source

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

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

Link to this function

create_domain(client, input, options \\ [])

View Source

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

Link to this function

create_domain_entry(client, input, options \\ [])

View Source

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

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

Link to this function

create_instance_snapshot(client, input, options \\ [])

View Source

Creates a snapshot of a specific virtual private server, or instance.

You can use a snapshot to create a new instance that is based on that snapshot.

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

Link to this function

create_instances(client, input, options \\ [])

View Source

Creates one or more Amazon Lightsail instances.

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

Link to this function

create_instances_from_snapshot(client, input, options \\ [])

View Source

Creates one or more new instances from a manual or automatic snapshot of an instance.

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

Link to this function

create_key_pair(client, input, options \\ [])

View Source

Creates an SSH key pair.

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

Link to this function

create_load_balancer(client, input, options \\ [])

View Source

Creates a Lightsail load balancer.

To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing. You can create up to 5 load balancers per AWS Region in your account.

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

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

Link to this function

create_load_balancer_tls_certificate(client, input, options \\ [])

View Source

Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.

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

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

Link to this function

create_relational_database(client, input, options \\ [])

View Source

Creates a new database in Amazon Lightsail.

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

Link to this function

create_relational_database_from_snapshot(client, input, options \\ [])

View Source

Creates a new database from an existing database snapshot in Amazon Lightsail.

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

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

Link to this function

create_relational_database_snapshot(client, input, options \\ [])

View Source

Creates a snapshot of your database in Amazon Lightsail.

You can use snapshots for backups, to make copies of a database, and to save data before deleting a database.

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

Link to this function

delete_alarm(client, input, options \\ [])

View Source

Deletes an alarm.

An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.

Link to this function

delete_auto_snapshot(client, input, options \\ [])

View Source

Deletes an automatic snapshot of an instance or disk.

For more information, see the Amazon Lightsail Developer Guide.

Link to this function

delete_bucket(client, input, options \\ [])

View Source

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 AWS account.

Link to this function

delete_bucket_access_key(client, input, options \\ [])

View Source

Deletes an access key for the specified Amazon Lightsail bucket.

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

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

Link to this function

delete_certificate(client, input, options \\ [])

View Source

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.

Link to this function

delete_contact_method(client, input, options \\ [])

View Source

Deletes a contact method.

A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

Link to this function

delete_container_image(client, input, options \\ [])

View Source

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

Link to this function

delete_container_service(client, input, options \\ [])

View Source

Deletes your Amazon Lightsail container service.

Link to this function

delete_disk(client, input, options \\ [])

View Source

Deletes the specified block storage disk.

The disk must be in the available state (not attached to a Lightsail instance).

The disk may remain in the deleting state for several minutes.

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

Link to this function

delete_disk_snapshot(client, input, options \\ [])

View Source

Deletes the specified disk snapshot.

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

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

Link to this function

delete_distribution(client, input, options \\ [])

View Source

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

Link to this function

delete_domain(client, input, options \\ [])

View Source

Deletes the specified domain recordset and all of its domain records.

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

Link to this function

delete_domain_entry(client, input, options \\ [])

View Source

Deletes a specific domain entry.

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

Link to this function

delete_instance(client, input, options \\ [])

View Source

Deletes an Amazon Lightsail instance.

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

Link to this function

delete_instance_snapshot(client, input, options \\ [])

View Source

Deletes a specific snapshot of a virtual private server (or instance).

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

Link to this function

delete_key_pair(client, input, options \\ [])

View Source

Deletes a specific SSH key pair.

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

Link to this function

delete_known_host_keys(client, input, options \\ [])

View Source

Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance.

This operation enables the Lightsail browser-based SSH or RDP clients to connect to the instance after a host key mismatch.

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

Link to this function

delete_load_balancer(client, input, options \\ [])

View Source

Deletes a Lightsail load balancer and all its associated SSL/TLS certificates.

Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again.

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

Link to this function

delete_load_balancer_tls_certificate(client, input, options \\ [])

View Source

Deletes an SSL/TLS certificate associated with a Lightsail load balancer.

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

Link to this function

delete_relational_database(client, input, options \\ [])

View Source

Deletes a database in Amazon Lightsail.

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

Link to this function

delete_relational_database_snapshot(client, input, options \\ [])

View Source

Deletes a database snapshot in Amazon Lightsail.

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

Link to this function

detach_certificate_from_distribution(client, input, options \\ [])

View Source

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.

Link to this function

detach_disk(client, input, options \\ [])

View Source

Detaches a stopped block storage disk from a Lightsail instance.

Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk.

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

Link to this function

detach_instances_from_load_balancer(client, input, options \\ [])

View Source

Detaches the specified instances from a Lightsail load balancer.

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

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

Link to this function

detach_static_ip(client, input, options \\ [])

View Source

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

Link to this function

disable_add_on(client, input, options \\ [])

View Source

Disables an add-on for an Amazon Lightsail resource.

For more information, see the Amazon Lightsail Developer Guide.

Link to this function

download_default_key_pair(client, input, options \\ [])

View Source

Downloads the default SSH key pair from the user's account.

Link to this function

enable_add_on(client, input, options \\ [])

View Source

Enables or modifies an add-on for an Amazon Lightsail resource.

For more information, see the Amazon Lightsail Developer Guide.

Link to this function

export_snapshot(client, input, options \\ [])

View Source

Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2).

This operation results in an export snapshot record that can be used with the create cloud formation stack operation to create new Amazon EC2 instances.

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

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

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

Link to this function

get_active_names(client, input, options \\ [])

View Source

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

Link to this function

get_alarms(client, input, options \\ [])

View Source

Returns information about the configured alarms.

Specify an alarm name in your request to return information about a specific alarm, or specify a monitored resource name to return information about all alarms for a specific resource.

An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.

Link to this function

get_auto_snapshots(client, input, options \\ [])

View Source

Returns the available automatic snapshots for an instance or disk.

For more information, see the Amazon Lightsail Developer Guide.

Link to this function

get_blueprints(client, input, options \\ [])

View Source

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.

Link to this function

get_bucket_access_keys(client, input, options \\ [])

View Source

Returns the existing access key IDs for the specified Amazon Lightsail bucket.

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

Link to this function

get_bucket_bundles(client, input, options \\ [])

View Source

Returns the bundles that you can apply to a Amazon Lightsail bucket.

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

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

Link to this function

get_bucket_metric_data(client, input, options \\ [])

View Source

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.

Link to this function

get_buckets(client, input, options \\ [])

View Source

Returns information about one or more Amazon Lightsail buckets.

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

Link to this function

get_bundles(client, input, options \\ [])

View Source

Returns the list of bundles that are available for purchase.

A bundle describes the specs for your virtual private server (or instance).

Link to this function

get_certificates(client, input, options \\ [])

View Source

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.

Link to this function

get_cloud_formation_stack_records(client, input, options \\ [])

View Source

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.

Link to this function

get_contact_methods(client, input, options \\ [])

View Source

Returns information about the configured contact methods.

Specify a protocol in your request to return information about a specific contact method.

A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

Link to this function

get_container_api_metadata(client, input, options \\ [])

View Source

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

Link to this function

get_container_images(client, input, options \\ [])

View Source

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.

Link to this function

get_container_log(client, input, options \\ [])

View Source

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 Amazon Lightsail endpoints and quotas in the AWS General Reference.

Link to this function

get_container_service_deployments(client, input, options \\ [])

View Source

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 Amazon Lightsail endpoints and quotas in the AWS General Reference.

Link to this function

get_container_service_metric_data(client, input, options \\ [])

View Source

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.

Link to this function

get_container_service_powers(client, input, options \\ [])

View Source

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.

Link to this function

get_container_services(client, input, options \\ [])

View Source

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

Link to this function

get_disk(client, input, options \\ [])

View Source

Returns information about a specific block storage disk.

Link to this function

get_disk_snapshot(client, input, options \\ [])

View Source

Returns information about a specific block storage disk snapshot.

Link to this function

get_disk_snapshots(client, input, options \\ [])

View Source

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

Link to this function

get_disks(client, input, options \\ [])

View Source

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

Link to this function

get_distribution_bundles(client, input, options \\ [])

View Source

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 dsitribution.

Link to this function

get_distribution_latest_cache_reset(client, input, options \\ [])

View Source

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

Link to this function

get_distribution_metric_data(client, input, options \\ [])

View Source

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.

Link to this function

get_distributions(client, input, options \\ [])

View Source

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

Link to this function

get_domain(client, input, options \\ [])

View Source

Returns information about a specific domain recordset.

Link to this function

get_domains(client, input, options \\ [])

View Source

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

Link to this function

get_export_snapshot_records(client, input, options \\ [])

View Source

Returns all export snapshot records created as a result of the export snapshot operation.

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

Link to this function

get_instance(client, input, options \\ [])

View Source

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

Link to this function

get_instance_access_details(client, input, options \\ [])

View Source

Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.

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

Link to this function

get_instance_metric_data(client, input, options \\ [])

View Source

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.

Link to this function

get_instance_port_states(client, input, options \\ [])

View Source

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.

Link to this function

get_instance_snapshot(client, input, options \\ [])

View Source

Returns information about a specific instance snapshot.

Link to this function

get_instance_snapshots(client, input, options \\ [])

View Source

Returns all instance snapshots for the user's account.

Link to this function

get_instance_state(client, input, options \\ [])

View Source

Returns the state of a specific instance.

Works on one instance at a time.

Link to this function

get_instances(client, input, options \\ [])

View Source

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

Link to this function

get_key_pair(client, input, options \\ [])

View Source

Returns information about a specific key pair.

Link to this function

get_key_pairs(client, input, options \\ [])

View Source

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

Link to this function

get_load_balancer(client, input, options \\ [])

View Source

Returns information about the specified Lightsail load balancer.

Link to this function

get_load_balancer_metric_data(client, input, options \\ [])

View Source

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.

Link to this function

get_load_balancer_tls_certificates(client, input, options \\ [])

View Source

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.

Link to this function

get_load_balancers(client, input, options \\ [])

View Source

Returns information about all load balancers in an account.

Link to this function

get_operation(client, input, options \\ [])

View Source

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.

Link to this function

get_operations(client, input, options \\ [])

View Source

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.

Link to this function

get_operations_for_resource(client, input, options \\ [])

View Source

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

Link to this function

get_regions(client, input, options \\ [])

View Source

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.

Link to this function

get_relational_database(client, input, options \\ [])

View Source

Returns information about a specific database in Amazon Lightsail.

Link to this function

get_relational_database_blueprints(client, input, options \\ [])

View Source

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.

Link to this function

get_relational_database_bundles(client, input, options \\ [])

View Source

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.

Link to this function

get_relational_database_events(client, input, options \\ [])

View Source

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

Link to this function

get_relational_database_log_events(client, input, options \\ [])

View Source

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

Link to this function

get_relational_database_log_streams(client, input, options \\ [])

View Source

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

Link to this function

get_relational_database_master_user_password(client, input, options \\ [])

View Source

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.

Link to this function

get_relational_database_metric_data(client, input, options \\ [])

View Source

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.

Link to this function

get_relational_database_parameters(client, input, options \\ [])

View Source

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.

Link to this function

get_relational_database_snapshot(client, input, options \\ [])

View Source

Returns information about a specific database snapshot in Amazon Lightsail.

Link to this function

get_relational_database_snapshots(client, input, options \\ [])

View Source

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

Link to this function

get_relational_databases(client, input, options \\ [])

View Source

Returns information about all of your databases in Amazon Lightsail.

Link to this function

get_static_ip(client, input, options \\ [])

View Source

Returns information about an Amazon Lightsail static IP.

Link to this function

get_static_ips(client, input, options \\ [])

View Source

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

Link to this function

import_key_pair(client, input, options \\ [])

View Source

Imports a public SSH key from a specific key pair.

Link to this function

is_vpc_peered(client, input, options \\ [])

View Source

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

Link to this function

open_instance_public_ports(client, input, options \\ [])

View Source

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

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

Link to this function

peer_vpc(client, input, options \\ [])

View Source

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

Link to this function

put_alarm(client, input, options \\ [])

View Source

Creates or updates an alarm, and associates it with the specified metric.

An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.

When this action creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.

When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. The alarm is then evaluated with the updated configuration.

Link to this function

put_instance_public_ports(client, input, options \\ [])

View Source

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

This action also closes all currently open ports that are not included in the request. Include all of the ports and the protocols you want to open in your PutInstancePublicPortsrequest. Or use the OpenInstancePublicPorts action to open ports without closing currently open ports.

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

Link to this function

reboot_instance(client, input, options \\ [])

View Source

Restarts a specific instance.

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

Link to this function

reboot_relational_database(client, input, options \\ [])

View Source

Restarts a specific database in Amazon Lightsail.

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

Link to this function

register_container_image(client, input, options \\ [])

View Source

Registers a container image to your Amazon Lightsail container service.

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

Link to this function

release_static_ip(client, input, options \\ [])

View Source

Deletes a specific static IP from your account.

Link to this function

reset_distribution_cache(client, input, options \\ [])

View Source

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.

Link to this function

send_contact_method_verification(client, input, options \\ [])

View Source

Sends a verification request to an email contact method to ensure it's owned by the requester.

SMS contact methods don't need to be verified.

A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

A verification request is sent to the contact method when you initially create it. Use this action to send another verification request if a previous verification request was deleted, or has expired.

Notifications are not sent to an email contact method until after it is verified, and confirmed as valid.

Link to this function

set_ip_address_type(client, input, options \\ [])

View Source

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.

Link to this function

set_resource_access_for_bucket(client, input, options \\ [])

View Source

Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.

Lightsail buckets currently support setting access for Lightsail instances in the same AWS Region.

Link to this function

start_instance(client, input, options \\ [])

View Source

Starts a specific Amazon Lightsail instance from a stopped state.

To restart an instance, use the reboot instance operation.

When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.

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

Link to this function

start_relational_database(client, input, options \\ [])

View Source

Starts a specific database from a stopped state in Amazon Lightsail.

To restart a database, use the reboot relational database operation.

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

Link to this function

stop_instance(client, input, options \\ [])

View Source

Stops a specific Amazon Lightsail instance that is currently running.

When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.

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

Link to this function

stop_relational_database(client, input, options \\ [])

View Source

Stops a specific database that is currently running in Amazon Lightsail.

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

Link to this function

tag_resource(client, input, options \\ [])

View Source

Adds one or more tags to the specified Amazon Lightsail resource.

Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the Amazon Lightsail Developer Guide.

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

Link to this function

test_alarm(client, input, options \\ [])

View Source

Tests an alarm by displaying a banner on the Amazon Lightsail console.

If a notification trigger is configured for the specified alarm, the test also sends a notification to the notification protocol (Email and/or SMS) configured for the alarm.

An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.

Link to this function

unpeer_vpc(client, input, options \\ [])

View Source

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

Link to this function

untag_resource(client, input, options \\ [])

View Source

Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.

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

Link to this function

update_bucket(client, input, options \\ [])

View Source

Updates an existing Amazon Lightsail bucket.

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

Link to this function

update_bucket_bundle(client, input, options \\ [])

View Source

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 AWS billing cycle. To determine if you can update a bucket's bundle, use the GetBuckets action. The ableToUpdateBundle parameter in the response will indicate whether you can currently update a bucket's bundle.

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

Link to this function

update_container_service(client, input, options \\ [])

View Source

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

Link to this function

update_distribution(client, input, options \\ [])

View Source

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

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

Link to this function

update_distribution_bundle(client, input, options \\ [])

View Source

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 dsitribution.

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 AWS 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.

Link to this function

update_domain_entry(client, input, options \\ [])

View Source

Updates a domain recordset after it is created.

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

Link to this function

update_load_balancer_attribute(client, input, options \\ [])

View Source

Updates the specified attribute for a load balancer.

You can only update one attribute at a time.

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

Link to this function

update_relational_database(client, input, options \\ [])

View Source

Allows the update of one or more attributes of a database in Amazon Lightsail.

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

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

Link to this function

update_relational_database_parameters(client, input, options \\ [])

View Source

Allows the update of one or more parameters of a database in Amazon Lightsail.

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

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