aws_lightsail
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), managed databases, SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN) distributions, DNS management of registered domains, and 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 Lightsail Dev 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 for the Lightsail service, see Amazon Lightsail Endpoints and Quotas in the AWS General Reference.Summary
Functions
-
allocate_static_ip(Client, Input)
Allocates a static IP address.
- allocate_static_ip(Client, Input, Options)
-
attach_certificate_to_distribution(Client, Input)
Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.
- attach_certificate_to_distribution(Client, Input, Options)
-
attach_disk(Client, Input)
Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.
- attach_disk(Client, Input, Options)
-
attach_instances_to_load_balancer(Client, Input)
Attaches one or more Lightsail instances to a load balancer.
- attach_instances_to_load_balancer(Client, Input, Options)
-
attach_load_balancer_tls_certificate(Client, Input)
Attaches a Transport Layer Security (TLS) certificate to your load balancer.
- attach_load_balancer_tls_certificate(Client, Input, Options)
-
attach_static_ip(Client, Input)
Attaches a static IP address to a specific Amazon Lightsail instance.
- attach_static_ip(Client, Input, Options)
-
close_instance_public_ports(Client, Input)
Closes ports for a specific Amazon Lightsail instance.
- close_instance_public_ports(Client, Input, Options)
-
copy_snapshot(Client, Input)
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.
- copy_snapshot(Client, Input, Options)
-
create_certificate(Client, Input)
Creates an SSL/TLS certificate for a Amazon Lightsail content delivery network (CDN) distribution.
- create_certificate(Client, Input, Options)
-
create_cloud_formation_stack(Client, Input)
Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot.
- create_cloud_formation_stack(Client, Input, Options)
-
create_contact_method(Client, Input)
Creates an email or SMS text message contact method.
- create_contact_method(Client, Input, Options)
-
create_disk(Client, Input)
Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g.,
us-east-2a
). - create_disk(Client, Input, Options)
-
create_disk_from_snapshot(Client, Input)
Creates a block storage disk from a manual or automatic snapshot of a disk.
- create_disk_from_snapshot(Client, Input, Options)
-
create_disk_snapshot(Client, Input)
Creates a snapshot of a block storage disk.
- create_disk_snapshot(Client, Input, Options)
-
create_distribution(Client, Input)
Creates an Amazon Lightsail content delivery network (CDN) distribution.
- create_distribution(Client, Input, Options)
-
create_domain(Client, Input)
Creates a domain resource for the specified domain (e.g., example.com).
- create_domain(Client, Input, Options)
-
create_domain_entry(Client, Input)
Creates one of the following entry records associated with the domain: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).
- create_domain_entry(Client, Input, Options)
-
create_instance_snapshot(Client, Input)
Creates a snapshot of a specific virtual private server, or instance.
- create_instance_snapshot(Client, Input, Options)
-
create_instances(Client, Input)
Creates one or more Amazon Lightsail instances.
- create_instances(Client, Input, Options)
-
create_instances_from_snapshot(Client, Input)
Creates one or more new instances from a manual or automatic snapshot of an instance.
- create_instances_from_snapshot(Client, Input, Options)
-
create_key_pair(Client, Input)
Creates an SSH key pair.
- create_key_pair(Client, Input, Options)
-
create_load_balancer(Client, Input)
Creates a Lightsail load balancer.
- create_load_balancer(Client, Input, Options)
-
create_load_balancer_tls_certificate(Client, Input)
Creates a Lightsail load balancer TLS certificate.
- create_load_balancer_tls_certificate(Client, Input, Options)
-
create_relational_database(Client, Input)
Creates a new database in Amazon Lightsail.
- create_relational_database(Client, Input, Options)
-
create_relational_database_from_snapshot(Client, Input)
Creates a new database from an existing database snapshot in Amazon Lightsail.
- create_relational_database_from_snapshot(Client, Input, Options)
-
create_relational_database_snapshot(Client, Input)
Creates a snapshot of your database in Amazon Lightsail.
- create_relational_database_snapshot(Client, Input, Options)
-
delete_alarm(Client, Input)
Deletes an alarm.
- delete_alarm(Client, Input, Options)
-
delete_auto_snapshot(Client, Input)
Deletes an automatic snapshot of an instance or disk.
- delete_auto_snapshot(Client, Input, Options)
-
delete_certificate(Client, Input)
Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.
- delete_certificate(Client, Input, Options)
-
delete_contact_method(Client, Input)
Deletes a contact method.
- delete_contact_method(Client, Input, Options)
-
delete_disk(Client, Input)
Deletes the specified block storage disk.
- delete_disk(Client, Input, Options)
-
delete_disk_snapshot(Client, Input)
Deletes the specified disk snapshot.
- delete_disk_snapshot(Client, Input, Options)
-
delete_distribution(Client, Input)
Deletes your Amazon Lightsail content delivery network (CDN) distribution.
- delete_distribution(Client, Input, Options)
-
delete_domain(Client, Input)
Deletes the specified domain recordset and all of its domain records.
- delete_domain(Client, Input, Options)
-
delete_domain_entry(Client, Input)
Deletes a specific domain entry.
- delete_domain_entry(Client, Input, Options)
-
delete_instance(Client, Input)
Deletes an Amazon Lightsail instance.
- delete_instance(Client, Input, Options)
-
delete_instance_snapshot(Client, Input)
Deletes a specific snapshot of a virtual private server (or instance).
- delete_instance_snapshot(Client, Input, Options)
-
delete_key_pair(Client, Input)
Deletes a specific SSH key pair.
- delete_key_pair(Client, Input, Options)
-
delete_known_host_keys(Client, Input)
Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance.
- delete_known_host_keys(Client, Input, Options)
-
delete_load_balancer(Client, Input)
Deletes a Lightsail load balancer and all its associated SSL/TLS certificates.
- delete_load_balancer(Client, Input, Options)
-
delete_load_balancer_tls_certificate(Client, Input)
Deletes an SSL/TLS certificate associated with a Lightsail load balancer.
- delete_load_balancer_tls_certificate(Client, Input, Options)
-
delete_relational_database(Client, Input)
Deletes a database in Amazon Lightsail.
- delete_relational_database(Client, Input, Options)
-
delete_relational_database_snapshot(Client, Input)
Deletes a database snapshot in Amazon Lightsail.
- delete_relational_database_snapshot(Client, Input, Options)
-
detach_certificate_from_distribution(Client, Input)
Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.
- detach_certificate_from_distribution(Client, Input, Options)
-
detach_disk(Client, Input)
Detaches a stopped block storage disk from a Lightsail instance.
- detach_disk(Client, Input, Options)
-
detach_instances_from_load_balancer(Client, Input)
Detaches the specified instances from a Lightsail load balancer.
- detach_instances_from_load_balancer(Client, Input, Options)
-
detach_static_ip(Client, Input)
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
- detach_static_ip(Client, Input, Options)
-
disable_add_on(Client, Input)
Disables an add-on for an Amazon Lightsail resource.
- disable_add_on(Client, Input, Options)
-
download_default_key_pair(Client, Input)
Downloads the default SSH key pair from the user's account.
- download_default_key_pair(Client, Input, Options)
-
enable_add_on(Client, Input)
Enables or modifies an add-on for an Amazon Lightsail resource.
- enable_add_on(Client, Input, Options)
-
export_snapshot(Client, Input)
Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2).
- export_snapshot(Client, Input, Options)
-
get_active_names(Client, Input)
Returns the names of all active (not deleted) resources.
- get_active_names(Client, Input, Options)
-
get_alarms(Client, Input)
Returns information about the configured alarms.
- get_alarms(Client, Input, Options)
-
get_auto_snapshots(Client, Input)
Returns the available automatic snapshots for an instance or disk.
- get_auto_snapshots(Client, Input, Options)
-
get_blueprints(Client, Input)
Returns the list of available instance images, or blueprints.
- get_blueprints(Client, Input, Options)
-
get_bundles(Client, Input)
Returns the list of bundles that are available for purchase.
- get_bundles(Client, Input, Options)
-
get_certificates(Client, Input)
Returns information about one or more Amazon Lightsail SSL/TLS certificates.
- get_certificates(Client, Input, Options)
-
get_cloud_formation_stack_records(Client, Input)
Returns the CloudFormation stack record created as a result of the
create cloud formation stack
operation. - get_cloud_formation_stack_records(Client, Input, Options)
-
get_contact_methods(Client, Input)
Returns information about the configured contact methods.
- get_contact_methods(Client, Input, Options)
-
get_disk(Client, Input)
Returns information about a specific block storage disk.
- get_disk(Client, Input, Options)
-
get_disk_snapshot(Client, Input)
Returns information about a specific block storage disk snapshot.
- get_disk_snapshot(Client, Input, Options)
-
get_disk_snapshots(Client, Input)
Returns information about all block storage disk snapshots in your AWS account and region.
- get_disk_snapshots(Client, Input, Options)
-
get_disks(Client, Input)
Returns information about all block storage disks in your AWS account and region.
- get_disks(Client, Input, Options)
-
get_distribution_bundles(Client, Input)
Returns the list bundles that can be applied to you Amazon Lightsail content delivery network (CDN) distributions.
- get_distribution_bundles(Client, Input, Options)
-
get_distribution_latest_cache_reset(Client, Input)
Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution.
- get_distribution_latest_cache_reset(Client, Input, Options)
-
get_distribution_metric_data(Client, Input)
Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.
- get_distribution_metric_data(Client, Input, Options)
-
get_distributions(Client, Input)
Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.
- get_distributions(Client, Input, Options)
-
get_domain(Client, Input)
Returns information about a specific domain recordset.
- get_domain(Client, Input, Options)
-
get_domains(Client, Input)
Returns a list of all domains in the user's account.
- get_domains(Client, Input, Options)
-
get_export_snapshot_records(Client, Input)
Returns the export snapshot record created as a result of the
export snapshot
operation. - get_export_snapshot_records(Client, Input, Options)
-
get_instance(Client, Input)
Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
- get_instance(Client, Input, Options)
-
get_instance_access_details(Client, Input)
Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
- get_instance_access_details(Client, Input, Options)
-
get_instance_metric_data(Client, Input)
Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
- get_instance_metric_data(Client, Input, Options)
-
get_instance_port_states(Client, Input)
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.
- get_instance_port_states(Client, Input, Options)
-
get_instance_snapshot(Client, Input)
Returns information about a specific instance snapshot.
- get_instance_snapshot(Client, Input, Options)
-
get_instance_snapshots(Client, Input)
Returns all instance snapshots for the user's account.
- get_instance_snapshots(Client, Input, Options)
-
get_instance_state(Client, Input)
Returns the state of a specific instance.
- get_instance_state(Client, Input, Options)
-
get_instances(Client, Input)
Returns information about all Amazon Lightsail virtual private servers, or instances.
- get_instances(Client, Input, Options)
-
get_key_pair(Client, Input)
Returns information about a specific key pair.
- get_key_pair(Client, Input, Options)
-
get_key_pairs(Client, Input)
Returns information about all key pairs in the user's account.
- get_key_pairs(Client, Input, Options)
-
get_load_balancer(Client, Input)
Returns information about the specified Lightsail load balancer.
- get_load_balancer(Client, Input, Options)
-
get_load_balancer_metric_data(Client, Input)
Returns information about health metrics for your Lightsail load balancer.
- get_load_balancer_metric_data(Client, Input, Options)
-
get_load_balancer_tls_certificates(Client, Input)
Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.
- get_load_balancer_tls_certificates(Client, Input, Options)
-
get_load_balancers(Client, Input)
Returns information about all load balancers in an account.
- get_load_balancers(Client, Input, Options)
-
get_operation(Client, Input)
Returns information about a specific operation.
- get_operation(Client, Input, Options)
-
get_operations(Client, Input)
Returns information about all operations.
- get_operations(Client, Input, Options)
-
get_operations_for_resource(Client, Input)
Gets operations for a specific resource (e.g., an instance or a static IP).
- get_operations_for_resource(Client, Input, Options)
-
get_regions(Client, Input)
Returns a list of all valid regions for Amazon Lightsail.
- get_regions(Client, Input, Options)
-
get_relational_database(Client, Input)
Returns information about a specific database in Amazon Lightsail.
- get_relational_database(Client, Input, Options)
-
get_relational_database_blueprints(Client, Input)
Returns a list of available database blueprints in Amazon Lightsail.
- get_relational_database_blueprints(Client, Input, Options)
-
get_relational_database_bundles(Client, Input)
Returns the list of bundles that are available in Amazon Lightsail.
- get_relational_database_bundles(Client, Input, Options)
-
get_relational_database_events(Client, Input)
Returns a list of events for a specific database in Amazon Lightsail.
- get_relational_database_events(Client, Input, Options)
-
get_relational_database_log_events(Client, Input)
Returns a list of log events for a database in Amazon Lightsail.
- get_relational_database_log_events(Client, Input, Options)
-
get_relational_database_log_streams(Client, Input)
Returns a list of available log streams for a specific database in Amazon Lightsail.
- get_relational_database_log_streams(Client, Input, Options)
-
get_relational_database_master_user_password(Client, Input)
Returns the current, previous, or pending versions of the master user password for a Lightsail database.
- get_relational_database_master_user_password(Client, Input, Options)
-
get_relational_database_metric_data(Client, Input)
Returns the data points of the specified metric for a database in Amazon Lightsail.
- get_relational_database_metric_data(Client, Input, Options)
-
get_relational_database_parameters(Client, Input)
Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail.
- get_relational_database_parameters(Client, Input, Options)
-
get_relational_database_snapshot(Client, Input)
Returns information about a specific database snapshot in Amazon Lightsail.
- get_relational_database_snapshot(Client, Input, Options)
-
get_relational_database_snapshots(Client, Input)
Returns information about all of your database snapshots in Amazon Lightsail.
- get_relational_database_snapshots(Client, Input, Options)
-
get_relational_databases(Client, Input)
Returns information about all of your databases in Amazon Lightsail.
- get_relational_databases(Client, Input, Options)
-
get_static_ip(Client, Input)
Returns information about a specific static IP.
- get_static_ip(Client, Input, Options)
-
get_static_ips(Client, Input)
Returns information about all static IPs in the user's account.
- get_static_ips(Client, Input, Options)
-
import_key_pair(Client, Input)
Imports a public SSH key from a specific key pair.
- import_key_pair(Client, Input, Options)
-
is_vpc_peered(Client, Input)
Returns a Boolean value indicating whether your Lightsail VPC is peered.
- is_vpc_peered(Client, Input, Options)
-
open_instance_public_ports(Client, Input)
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.
- open_instance_public_ports(Client, Input, Options)
-
peer_vpc(Client, Input)
Tries to peer the Lightsail VPC with the user's default VPC.
- peer_vpc(Client, Input, Options)
-
put_alarm(Client, Input)
Creates or updates an alarm, and associates it with the specified metric.
- put_alarm(Client, Input, Options)
-
put_instance_public_ports(Client, Input)
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.
- put_instance_public_ports(Client, Input, Options)
-
reboot_instance(Client, Input)
Restarts a specific instance.
- reboot_instance(Client, Input, Options)
-
reboot_relational_database(Client, Input)
Restarts a specific database in Amazon Lightsail.
- reboot_relational_database(Client, Input, Options)
-
release_static_ip(Client, Input)
Deletes a specific static IP from your account.
- release_static_ip(Client, Input, Options)
-
reset_distribution_cache(Client, Input)
Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution.
- reset_distribution_cache(Client, Input, Options)
-
send_contact_method_verification(Client, Input)
Sends a verification request to an email contact method to ensure it's owned by the requester.
- send_contact_method_verification(Client, Input, Options)
-
start_instance(Client, Input)
Starts a specific Amazon Lightsail instance from a stopped state.
- start_instance(Client, Input, Options)
-
start_relational_database(Client, Input)
Starts a specific database from a stopped state in Amazon Lightsail.
- start_relational_database(Client, Input, Options)
-
stop_instance(Client, Input)
Stops a specific Amazon Lightsail instance that is currently running.
- stop_instance(Client, Input, Options)
-
stop_relational_database(Client, Input)
Stops a specific database that is currently running in Amazon Lightsail.
- stop_relational_database(Client, Input, Options)
-
tag_resource(Client, Input)
Adds one or more tags to the specified Amazon Lightsail resource.
- tag_resource(Client, Input, Options)
-
test_alarm(Client, Input)
Tests an alarm by displaying a banner on the Amazon Lightsail console.
- test_alarm(Client, Input, Options)
-
unpeer_vpc(Client, Input)
Attempts to unpeer the Lightsail VPC from the user's default VPC.
- unpeer_vpc(Client, Input, Options)
-
untag_resource(Client, Input)
Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.
- untag_resource(Client, Input, Options)
-
update_distribution(Client, Input)
Updates an existing Amazon Lightsail content delivery network (CDN) distribution.
- update_distribution(Client, Input, Options)
-
update_distribution_bundle(Client, Input)
Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.
- update_distribution_bundle(Client, Input, Options)
-
update_domain_entry(Client, Input)
Updates a domain recordset after it is created.
- update_domain_entry(Client, Input, Options)
-
update_load_balancer_attribute(Client, Input)
Updates the specified attribute for a load balancer.
- update_load_balancer_attribute(Client, Input, Options)
-
update_relational_database(Client, Input)
Allows the update of one or more attributes of a database in Amazon Lightsail.
- update_relational_database(Client, Input, Options)
-
update_relational_database_parameters(Client, Input)
Allows the update of one or more parameters of a database in Amazon Lightsail.
- update_relational_database_parameters(Client, Input, Options)
Functions
allocate_static_ip(Client, Input)
Allocates a static IP address.
allocate_static_ip(Client, Input, Options)
attach_certificate_to_distribution(Client, Input)
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.
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.
attach_certificate_to_distribution(Client, Input, Options)
attach_disk(Client, Input)
Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.
Theattach disk
operation supports tag-based access control
via resource tags applied to the resource identified by disk
name
. For more information, see the Lightsail
Dev Guide.
attach_disk(Client, Input, Options)
attach_instances_to_load_balancer(Client, Input)
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.
Theattach 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
Dev Guide.
attach_instances_to_load_balancer(Client, Input, Options)
attach_load_balancer_tls_certificate(Client, Input)
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.
AttachLoadBalancerTlsCertificate
operation supports
tag-based access control via resource tags applied to the resource
identified by load balancer name
. For more information, see
the Lightsail
Dev Guide.
attach_load_balancer_tls_certificate(Client, Input, Options)
attach_static_ip(Client, Input)
Attaches a static IP address to a specific Amazon Lightsail instance.
attach_static_ip(Client, Input, Options)
close_instance_public_ports(Client, Input)
Closes ports for a specific Amazon Lightsail instance.
TheCloseInstancePublicPorts
action supports tag-based access
control via resource tags applied to the resource identified by
instanceName
. For more information, see the Lightsail
Dev Guide.
close_instance_public_ports(Client, Input, Options)
copy_snapshot(Client, Input)
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.
source region
, source resource name
,
target snapshot name
, and either the restore
date
or the use latest restorable auto snapshot
parameters.
copy_snapshot(Client, Input, Options)
create_certificate(Client, Input)
Creates an SSL/TLS certificate for a Amazon Lightsail content delivery network (CDN) distribution.
After the certificate is created, use the
AttachCertificateToDistribution
action to attach the
certificate to your distribution.
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.
create_certificate(Client, Input, Options)
create_cloud_formation_stack(Client, Input)
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.
create cloud formation stack
operation
again with the same export snapshot record.
create_cloud_formation_stack(Client, Input, Options)
create_contact_method(Client, Input)
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.create_contact_method(Client, Input, Options)
create_disk(Client, Input)
Creates a block storage disk that can be attached to an Amazon
Lightsail instance in the same Availability Zone (e.g.,
us-east-2a
).
create disk
operation supports tag-based access control
via request tags. For more information, see the Lightsail
Dev Guide.
create_disk(Client, Input, Options)
create_disk_from_snapshot(Client, Input)
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
).
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 Lightsail
Dev Guide.
create_disk_from_snapshot(Client, Input, Options)
create_disk_snapshot(Client, Input)
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.
create disk snapshot
operation supports tag-based access
control via request tags. For more information, see the Lightsail
Dev Guide.
create_disk_snapshot(Client, Input, Options)
create_distribution(Client, Input)
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.create_distribution(Client, Input, Options)
create_domain(Client, Input)
Creates a domain resource for the specified domain (e.g., example.com).
Thecreate domain
operation supports tag-based access control
via request tags. For more information, see the Lightsail
Dev Guide.
create_domain(Client, Input, Options)
create_domain_entry(Client, Input)
Creates one of the following entry records associated with the domain: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).
Thecreate domain entry
operation supports tag-based access
control via resource tags applied to the resource identified by
domain name
. For more information, see the Lightsail
Dev Guide.
create_domain_entry(Client, Input, Options)
create_instance_snapshot(Client, Input)
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.
Thecreate instance snapshot
operation supports tag-based
access control via request tags. For more information, see the Lightsail
Dev Guide.
create_instance_snapshot(Client, Input, Options)
create_instances(Client, Input)
Creates one or more Amazon Lightsail instances.
Thecreate instances
operation supports tag-based access
control via request tags. For more information, see the Lightsail
Dev Guide.
create_instances(Client, Input, Options)
create_instances_from_snapshot(Client, Input)
Creates one or more new instances from a manual or automatic snapshot of an instance.
Thecreate 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 Lightsail
Dev Guide.
create_instances_from_snapshot(Client, Input, Options)
create_key_pair(Client, Input)
Creates an SSH key pair.
Thecreate key pair
operation supports tag-based access
control via request tags. For more information, see the Lightsail
Dev Guide.
create_key_pair(Client, Input, Options)
create_load_balancer(Client, Input)
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.
create load balancer
operation supports tag-based access
control via request tags. For more information, see the Lightsail
Dev Guide.
create_load_balancer(Client, Input, Options)
create_load_balancer_tls_certificate(Client, Input)
Creates a Lightsail load balancer TLS certificate.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
TheCreateLoadBalancerTlsCertificate
operation supports
tag-based access control via resource tags applied to the resource
identified by load balancer name
. For more information, see
the Lightsail
Dev Guide.
create_load_balancer_tls_certificate(Client, Input, Options)
create_relational_database(Client, Input)
Creates a new database in Amazon Lightsail.
Thecreate relational database
operation supports tag-based
access control via request tags. For more information, see the Lightsail
Dev Guide.
create_relational_database(Client, Input, Options)
create_relational_database_from_snapshot(Client, Input)
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.
Thecreate 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 Lightsail
Dev Guide.
create_relational_database_from_snapshot(Client, Input, Options)
create_relational_database_snapshot(Client, Input)
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.
Thecreate relational database snapshot
operation supports
tag-based access control via request tags. For more information, see the
Lightsail
Dev Guide.
create_relational_database_snapshot(Client, Input, Options)
delete_alarm(Client, Input)
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.delete_alarm(Client, Input, Options)
delete_auto_snapshot(Client, Input)
Deletes an automatic snapshot of an instance or disk. For more information, see the Lightsail Dev Guide.
delete_auto_snapshot(Client, Input, Options)
delete_certificate(Client, Input)
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 theDetachCertificateFromDistribution
action to
detach a certificate from a distribution.
delete_certificate(Client, Input, Options)
delete_contact_method(Client, Input)
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.delete_contact_method(Client, Input, Options)
delete_disk(Client, Input)
Deletes the specified block storage disk. The disk must be in the
available
state (not attached to a Lightsail instance).
deleting
state for several
minutes.
delete disk
operation supports tag-based access
control via resource tags applied to the resource identified by disk
name
. For more information, see the Lightsail
Dev Guide.
delete_disk(Client, Input, Options)
delete_disk_snapshot(Client, Input)
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.
Thedelete 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 Lightsail
Dev Guide.
delete_disk_snapshot(Client, Input, Options)
delete_distribution(Client, Input)
Deletes your Amazon Lightsail content delivery network (CDN) distribution.
delete_distribution(Client, Input, Options)
delete_domain(Client, Input)
Deletes the specified domain recordset and all of its domain records.
Thedelete domain
operation supports tag-based access control
via resource tags applied to the resource identified by domain
name
. For more information, see the Lightsail
Dev Guide.
delete_domain(Client, Input, Options)
delete_domain_entry(Client, Input)
Deletes a specific domain entry.
Thedelete domain entry
operation supports tag-based access
control via resource tags applied to the resource identified by
domain name
. For more information, see the Lightsail
Dev Guide.
delete_domain_entry(Client, Input, Options)
delete_instance(Client, Input)
Deletes an Amazon Lightsail instance.
Thedelete instance
operation supports tag-based access
control via resource tags applied to the resource identified by
instance name
. For more information, see the Lightsail
Dev Guide.
delete_instance(Client, Input, Options)
delete_instance_snapshot(Client, Input)
Deletes a specific snapshot of a virtual private server (or instance).
Thedelete 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 Lightsail
Dev Guide.
delete_instance_snapshot(Client, Input, Options)
delete_key_pair(Client, Input)
Deletes a specific SSH key pair.
Thedelete 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 Lightsail
Dev Guide.
delete_key_pair(Client, Input, Options)
delete_known_host_keys(Client, Input)
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.
delete_known_host_keys(Client, Input, Options)
delete_load_balancer(Client, Input)
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.
Thedelete 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
Dev Guide.
delete_load_balancer(Client, Input, Options)
delete_load_balancer_tls_certificate(Client, Input)
Deletes an SSL/TLS certificate associated with a Lightsail load balancer.
TheDeleteLoadBalancerTlsCertificate
operation supports
tag-based access control via resource tags applied to the resource
identified by load balancer name
. For more information, see
the Lightsail
Dev Guide.
delete_load_balancer_tls_certificate(Client, Input, Options)
delete_relational_database(Client, Input)
Deletes a database in Amazon Lightsail.
Thedelete relational database
operation supports tag-based
access control via resource tags applied to the resource identified by
relationalDatabaseName. For more information, see the Lightsail
Dev Guide.
delete_relational_database(Client, Input, Options)
delete_relational_database_snapshot(Client, Input)
Deletes a database snapshot in Amazon Lightsail.
Thedelete relational database snapshot
operation supports
tag-based access control via resource tags applied to the resource
identified by relationalDatabaseName. For more information, see the Lightsail
Dev Guide.
delete_relational_database_snapshot(Client, Input, Options)
detach_certificate_from_distribution(Client, Input)
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.detach_certificate_from_distribution(Client, Input, Options)
detach_disk(Client, Input)
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.
Thedetach disk
operation supports tag-based access control
via resource tags applied to the resource identified by disk
name
. For more information, see the Lightsail
Dev Guide.
detach_disk(Client, Input, Options)
detach_instances_from_load_balancer(Client, Input)
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.
Thedetach 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 Lightsail
Dev Guide.
detach_instances_from_load_balancer(Client, Input, Options)
detach_static_ip(Client, Input)
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
detach_static_ip(Client, Input, Options)
disable_add_on(Client, Input)
Disables an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide.
disable_add_on(Client, Input, Options)
download_default_key_pair(Client, Input)
Downloads the default SSH key pair from the user's account.
download_default_key_pair(Client, Input, Options)
enable_add_on(Client, Input)
Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide.
enable_add_on(Client, Input, Options)
export_snapshot(Client, Input)
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 Lightsail
Dev Guide.
get instance snapshots
or get disk
snapshots
operations to get a list of snapshots that you can export
to Amazon EC2.
export_snapshot(Client, Input, Options)
get_active_names(Client, Input)
Returns the names of all active (not deleted) resources.
get_active_names(Client, Input, Options)
get_alarms(Client, Input)
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.get_alarms(Client, Input, Options)
get_auto_snapshots(Client, Input)
Returns the available automatic snapshots for an instance or disk. For more information, see the Lightsail Dev Guide.
get_auto_snapshots(Client, Input, Options)
get_blueprints(Client, Input)
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.
get_blueprints(Client, Input, Options)
get_bundles(Client, Input)
Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance).
get_bundles(Client, Input, Options)
get_certificates(Client, Input)
Returns information about one or more Amazon Lightsail SSL/TLS certificates.
includeCertificateDetails
from your request. The response
will include only the certificate Amazon Resource Name (ARN), certificate
name, domain name, and tags.
get_certificates(Client, Input, Options)
get_cloud_formation_stack_records(Client, Input)
Returns the CloudFormation stack record created as a result of the
create cloud formation stack
operation.
get_cloud_formation_stack_records(Client, Input, Options)
get_contact_methods(Client, Input)
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.get_contact_methods(Client, Input, Options)
get_disk(Client, Input)
Returns information about a specific block storage disk.
get_disk(Client, Input, Options)
get_disk_snapshot(Client, Input)
Returns information about a specific block storage disk snapshot.
get_disk_snapshot(Client, Input, Options)
get_disk_snapshots(Client, Input)
Returns information about all block storage disk snapshots in your AWS account and region.
get_disk_snapshots(Client, Input, Options)
get_disks(Client, Input)
Returns information about all block storage disks in your AWS account and region.
get_disks(Client, Input, Options)
get_distribution_bundles(Client, Input)
Returns the list bundles that can be applied to you Amazon Lightsail content delivery network (CDN) distributions.
A distribution bundle specifies the monthly network transfer quota and monthly cost of your dsitribution.get_distribution_bundles(Client, Input, Options)
get_distribution_latest_cache_reset(Client, Input)
Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution.
get_distribution_latest_cache_reset(Client, Input, Options)
get_distribution_metric_data(Client, Input)
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.get_distribution_metric_data(Client, Input, Options)
get_distributions(Client, Input)
Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.
get_distributions(Client, Input, Options)
get_domain(Client, Input)
Returns information about a specific domain recordset.
get_domain(Client, Input, Options)
get_domains(Client, Input)
Returns a list of all domains in the user's account.
get_domains(Client, Input, Options)
get_export_snapshot_records(Client, Input)
Returns the export snapshot record created as a result of the
export snapshot
operation.
create cloud formation
stack
operation.
get_export_snapshot_records(Client, Input, Options)
get_instance(Client, Input)
Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
get_instance(Client, Input, Options)
get_instance_access_details(Client, Input)
Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
Theget 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 Lightsail
Dev Guide.
get_instance_access_details(Client, Input, Options)
get_instance_metric_data(Client, Input)
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.get_instance_metric_data(Client, Input, Options)
get_instance_port_states(Client, Input)
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.
get_instance_port_states(Client, Input, Options)
get_instance_snapshot(Client, Input)
Returns information about a specific instance snapshot.
get_instance_snapshot(Client, Input, Options)
get_instance_snapshots(Client, Input)
Returns all instance snapshots for the user's account.
get_instance_snapshots(Client, Input, Options)
get_instance_state(Client, Input)
Returns the state of a specific instance. Works on one instance at a time.
get_instance_state(Client, Input, Options)
get_instances(Client, Input)
Returns information about all Amazon Lightsail virtual private servers, or instances.
get_instances(Client, Input, Options)
get_key_pair(Client, Input)
Returns information about a specific key pair.
get_key_pair(Client, Input, Options)
get_key_pairs(Client, Input)
Returns information about all key pairs in the user's account.
get_key_pairs(Client, Input, Options)
get_load_balancer(Client, Input)
Returns information about the specified Lightsail load balancer.
get_load_balancer(Client, Input, Options)
get_load_balancer_metric_data(Client, Input)
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.get_load_balancer_metric_data(Client, Input, Options)
get_load_balancer_tls_certificates(Client, Input)
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.get_load_balancer_tls_certificates(Client, Input, Options)
get_load_balancers(Client, Input)
Returns information about all load balancers in an account.
get_load_balancers(Client, Input, Options)
get_operation(Client, Input)
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.
get_operation(Client, Input, Options)
get_operations(Client, Input)
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 toGetOperations
use the maximum (last)
statusChangedAt
value from the previous request.
get_operations(Client, Input, Options)
get_operations_for_resource(Client, Input)
Gets operations for a specific resource (e.g., an instance or a static IP).
get_operations_for_resource(Client, Input, Options)
get_regions(Client, Input)
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.
get_regions(Client, Input, Options)
get_relational_database(Client, Input)
Returns information about a specific database in Amazon Lightsail.
get_relational_database(Client, Input, Options)
get_relational_database_blueprints(Client, Input)
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.get_relational_database_blueprints(Client, Input, Options)
get_relational_database_bundles(Client, Input)
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.get_relational_database_bundles(Client, Input, Options)
get_relational_database_events(Client, Input)
Returns a list of events for a specific database in Amazon Lightsail.
get_relational_database_events(Client, Input, Options)
get_relational_database_log_events(Client, Input)
Returns a list of log events for a database in Amazon Lightsail.
get_relational_database_log_events(Client, Input, Options)
get_relational_database_log_streams(Client, Input)
Returns a list of available log streams for a specific database in Amazon Lightsail.
get_relational_database_log_streams(Client, Input, Options)
get_relational_database_master_user_password(Client, Input)
Returns the current, previous, or pending versions of the master user password for a Lightsail database.
TheGetRelationalDatabaseMasterUserPassword
operation
supports tag-based access control via resource tags applied to the
resource identified by relationalDatabaseName.
get_relational_database_master_user_password(Client, Input, Options)
get_relational_database_metric_data(Client, Input)
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.get_relational_database_metric_data(Client, Input, Options)
get_relational_database_parameters(Client, Input)
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.get_relational_database_parameters(Client, Input, Options)
get_relational_database_snapshot(Client, Input)
Returns information about a specific database snapshot in Amazon Lightsail.
get_relational_database_snapshot(Client, Input, Options)
get_relational_database_snapshots(Client, Input)
Returns information about all of your database snapshots in Amazon Lightsail.
get_relational_database_snapshots(Client, Input, Options)
get_relational_databases(Client, Input)
Returns information about all of your databases in Amazon Lightsail.
get_relational_databases(Client, Input, Options)
get_static_ip(Client, Input)
Returns information about a specific static IP.
get_static_ip(Client, Input, Options)
get_static_ips(Client, Input)
Returns information about all static IPs in the user's account.
get_static_ips(Client, Input, Options)
import_key_pair(Client, Input)
Imports a public SSH key from a specific key pair.
import_key_pair(Client, Input, Options)
is_vpc_peered(Client, Input)
Returns a Boolean value indicating whether your Lightsail VPC is peered.
is_vpc_peered(Client, Input, Options)
open_instance_public_ports(Client, Input)
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.
TheOpenInstancePublicPorts
action supports tag-based access
control via resource tags applied to the resource identified by
instanceName
. For more information, see the Lightsail
Dev Guide.
open_instance_public_ports(Client, Input, Options)
peer_vpc(Client, Input)
Tries to peer the Lightsail VPC with the user's default VPC.
peer_vpc(Client, Input, Options)
put_alarm(Client, Input)
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.
put_alarm(Client, Input, Options)
put_instance_public_ports(Client, Input)
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.
PutInstancePublicPorts
action supports tag-based access
control via resource tags applied to the resource identified by
instanceName
. For more information, see the Lightsail
Dev Guide.
put_instance_public_ports(Client, Input, Options)
reboot_instance(Client, Input)
Restarts a specific instance.
Thereboot instance
operation supports tag-based access
control via resource tags applied to the resource identified by
instance name
. For more information, see the Lightsail
Dev Guide.
reboot_instance(Client, Input, Options)
reboot_relational_database(Client, Input)
Restarts a specific database in Amazon Lightsail.
Thereboot relational database
operation supports tag-based
access control via resource tags applied to the resource identified by
relationalDatabaseName. For more information, see the Lightsail
Dev Guide.
reboot_relational_database(Client, Input, Options)
release_static_ip(Client, Input)
Deletes a specific static IP from your account.
release_static_ip(Client, Input, Options)
reset_distribution_cache(Client, Input)
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.reset_distribution_cache(Client, Input, Options)
send_contact_method_verification(Client, Input)
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.
send_contact_method_verification(Client, Input, Options)
start_instance(Client, Input)
Starts a specific Amazon Lightsail instance from a stopped state. To
restart an instance, use the reboot instance
operation.
start instance
operation supports tag-based
access control via resource tags applied to the resource identified by
instance name
. For more information, see the Lightsail
Dev Guide.
start_instance(Client, Input, Options)
start_relational_database(Client, Input)
Starts a specific database from a stopped state in Amazon Lightsail.
To restart a database, use the reboot relational database
operation.
start relational database
operation supports tag-based
access control via resource tags applied to the resource identified by
relationalDatabaseName. For more information, see the Lightsail
Dev Guide.
start_relational_database(Client, Input, Options)
stop_instance(Client, Input)
Stops a specific Amazon Lightsail instance that is currently running.
stop instance
operation supports tag-based access
control via resource tags applied to the resource identified by
instance name
. For more information, see the Lightsail
Dev Guide.
stop_instance(Client, Input, Options)
stop_relational_database(Client, Input)
Stops a specific database that is currently running in Amazon Lightsail.
Thestop relational database
operation supports tag-based
access control via resource tags applied to the resource identified by
relationalDatabaseName. For more information, see the Lightsail
Dev Guide.
stop_relational_database(Client, Input, Options)
tag_resource(Client, Input)
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 Lightsail Dev Guide.
Thetag 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 Lightsail
Dev Guide.
tag_resource(Client, Input, Options)
test_alarm(Client, Input)
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.
test_alarm(Client, Input, Options)
unpeer_vpc(Client, Input)
Attempts to unpeer the Lightsail VPC from the user's default VPC.
unpeer_vpc(Client, Input, Options)
untag_resource(Client, Input)
Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.
Theuntag 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 Lightsail
Dev Guide.
untag_resource(Client, Input, Options)
update_distribution(Client, Input)
Updates an existing Amazon Lightsail content delivery network (CDN) distribution.
Use this action to update the configuration of your existing distributionupdate_distribution(Client, Input, Options)
update_distribution_bundle(Client, Input)
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 theGetDistributions
action. The
ableToUpdateBundle
parameter in the result will indicate
whether you can currently update your distribution's bundle.
update_distribution_bundle(Client, Input, Options)
update_domain_entry(Client, Input)
Updates a domain recordset after it is created.
Theupdate domain entry
operation supports tag-based access
control via resource tags applied to the resource identified by
domain name
. For more information, see the Lightsail
Dev Guide.
update_domain_entry(Client, Input, Options)
update_load_balancer_attribute(Client, Input)
Updates the specified attribute for a load balancer. You can only update one attribute at a time.
Theupdate 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 Lightsail
Dev Guide.
update_load_balancer_attribute(Client, Input, Options)
update_relational_database(Client, Input)
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.
Theupdate relational database
operation supports tag-based
access control via resource tags applied to the resource identified by
relationalDatabaseName. For more information, see the Lightsail
Dev Guide.
update_relational_database(Client, Input, Options)
update_relational_database_parameters(Client, Input)
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.
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 Lightsail
Dev Guide.