Packages
aws
0.13.2
1.0.14
1.0.13
1.0.12
1.0.11
1.0.10
1.0.9
1.0.8
1.0.7
1.0.6
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
0.14.1
0.14.0
0.13.3
0.13.2
0.13.1
0.13.0
0.12.0
0.11.0
0.10.1
0.10.0
0.9.2
0.9.1
0.9.0
0.8.0
0.7.0
0.6.0
0.5.0
0.4.0
0.3.0
0.2.0
0.1.0
0.0.12
0.0.11
0.0.10
0.0.9
0.0.8
0.0.7
0.0.6
0.0.5
0.0.4
0.0.3
0.0.2
0.0.1
AWS clients for Elixir
Current section
Files
Jump to
Current section
Files
lib/aws/generated/lightsail.ex
# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.Lightsail do
@moduledoc """
Amazon Lightsail is the easiest way to get started with Amazon Web Services
(Amazon Web Services) for developers who need to build websites or web
applications.
It includes everything you need to launch your project quickly - instances
(virtual private servers), container services, storage buckets, managed
databases, SSD-based block storage, static IP addresses, load balancers, content
delivery network (CDN) distributions, DNS management of registered domains, and
resource snapshots (backups) - for a low, predictable monthly price.
You can manage your Lightsail resources using the Lightsail console, Lightsail
API, Command Line Interface (CLI), or SDKs. For more information about Lightsail
concepts and tasks, see the [Amazon Lightsail Developer Guide](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/lightsail-how-to-set-up-access-keys-to-use-sdk-api-cli).
This API Reference provides detailed information about the actions, data types,
parameters, and errors of the Lightsail service. For more information about the
supported Amazon Web Services Regions, endpoints, and service quotas of the
Lightsail service, see [Amazon Lightsail Endpoints and Quotas](https://docs.aws.amazon.com/general/latest/gr/lightsail.html) in the
*Amazon Web Services General Reference*.
"""
alias AWS.Client
alias AWS.Request
def metadata do
%{
abbreviation: nil,
api_version: "2016-11-28",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "lightsail",
global?: false,
protocol: "json",
service_id: "Lightsail",
signature_version: "v4",
signing_name: "lightsail",
target_prefix: "Lightsail_20161128"
}
end
@doc """
Allocates a static IP address.
"""
def allocate_static_ip(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "AllocateStaticIp", input, options)
end
@doc """
Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery
network (CDN) distribution.
After the certificate is attached, your distribution accepts HTTPS traffic for
all of the domains that are associated with the certificate.
Use the `CreateCertificate` action to create a certificate that you can attach
to your distribution.
Only certificates created in the `us-east-1` Amazon Web Services Region can be
attached to Lightsail distributions. Lightsail distributions are global
resources that can reference an origin in any Amazon Web Services Region, and
distribute its content globally. However, all distributions are located in the
`us-east-1` Region.
"""
def attach_certificate_to_distribution(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "AttachCertificateToDistribution", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def attach_disk(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "AttachDisk", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def attach_instances_to_load_balancer(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "AttachInstancesToLoadBalancer", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def attach_load_balancer_tls_certificate(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "AttachLoadBalancerTlsCertificate", input, options)
end
@doc """
Attaches a static IP address to a specific Amazon Lightsail instance.
"""
def attach_static_ip(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "AttachStaticIp", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def close_instance_public_ports(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CloseInstancePublicPorts", input, options)
end
@doc """
Copies a manual snapshot of an instance or disk as another manual snapshot, or
copies an automatic snapshot of an instance or disk as a manual snapshot.
This operation can also be used to copy a manual or automatic snapshot of an
instance or a disk from one Amazon Web Services Region to another in Amazon
Lightsail.
When copying a *manual snapshot*, be sure to define the `source region`, `source
snapshot name`, and `target snapshot name` parameters.
When copying an *automatic snapshot*, be sure to define the `source region`,
`source resource name`, `target snapshot name`, and either the `restore date` or
the `use latest restorable auto snapshot` parameters.
"""
def copy_snapshot(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CopySnapshot", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/buckets-in-amazon-lightsail)
in the *Amazon Lightsail Developer Guide*.
"""
def create_bucket(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateBucket", input, options)
end
@doc """
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](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketAccessKeys.html) 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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-bucket-access-keys)
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.
"""
def create_bucket_access_key(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateBucketAccessKey", input, options)
end
@doc """
Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network
(CDN) distribution and a container service.
After the certificate is valid, use the `AttachCertificateToDistribution` action
to use the certificate and its domains with your distribution. Or use the
`UpdateContainerService` action to use the certificate and its domains with your
container service.
Only certificates created in the `us-east-1` Amazon Web Services Region can be
attached to Lightsail distributions. Lightsail distributions are global
resources that can reference an origin in any Amazon Web Services Region, and
distribute its content globally. However, all distributions are located in the
`us-east-1` Region.
"""
def create_certificate(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateCertificate", input, options)
end
@doc """
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.
"""
def create_cloud_formation_stack(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateCloudFormationStack", input, options)
end
@doc """
Creates an email or SMS text message contact method.
A contact method is used to send you notifications about your Amazon Lightsail
resources. You can add one email address and one mobile phone number contact
method in each Amazon Web Services Region. However, SMS text messaging is not
supported in some Amazon Web Services Regions, and SMS text messages cannot be
sent to some countries/regions. For more information, see [Notifications in Amazon
Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications).
"""
def create_contact_method(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateContactMethod", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-container-services)
in the *Lightsail Dev Guide*.
"""
def create_container_service(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateContainerService", input, options)
end
@doc """
Creates a deployment for your Amazon Lightsail container service.
A deployment specifies the containers that will be launched on the container
service and their settings, such as the ports to open, the environment variables
to apply, and the launch command to run. It also specifies the container that
will serve as the public endpoint of the deployment and its settings, such as
the HTTP or HTTPS port to use, and the health check configuration.
You can deploy containers to your container service using container images from
a public registry such as Amazon ECR Public, or from your local machine. For
more information, see [Creating container images for your Amazon Lightsail container
services](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-container-images)
in the *Amazon Lightsail Developer Guide*.
"""
def create_container_service_deployment(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateContainerServiceDeployment", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-pushing-container-images)
in the *Amazon Lightsail Developer Guide*.
"""
def create_container_service_registry_login(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateContainerServiceRegistryLogin", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def create_disk(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateDisk", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def create_disk_from_snapshot(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateDiskFromSnapshot", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def create_disk_snapshot(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateDiskSnapshot", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-content-delivery-network-distributions).
"""
def create_distribution(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateDistribution", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def create_domain(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateDomain", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def create_domain_entry(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateDomainEntry", input, options)
end
@doc """
Creates two URLs that are used to access a virtual computer’s graphical user
interface (GUI) session.
The primary URL initiates a web-based NICE DCV session to the virtual computer's
application. The secondary URL initiates a web-based NICE DCV session to the
virtual computer's operating session.
Use `StartGUISession` to open the session.
"""
def create_g_ui_session_access_details(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateGUISessionAccessDetails", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def create_instance_snapshot(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateInstanceSnapshot", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def create_instances(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateInstances", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def create_instances_from_snapshot(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateInstancesFromSnapshot", input, options)
end
@doc """
Creates a custom SSH key pair that you can use with an Amazon Lightsail
instance.
Use the
[DownloadDefaultKeyPair](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_DownloadDefaultKeyPair.html) action to create a Lightsail default key pair in an Amazon Web Services Region
where a default key pair does not currently exist.
The `create key pair` operation supports tag-based access control via request
tags. For more information, see the [Amazon Lightsail Developer
Guide](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def create_key_pair(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateKeyPair", input, options)
end
@doc """
Creates a Lightsail load balancer.
To learn more about deciding whether to load balance your application, see
[Configure your Lightsail instances for load balancing](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/configure-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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def create_load_balancer(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateLoadBalancer", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def create_load_balancer_tls_certificate(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateLoadBalancerTlsCertificate", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def create_relational_database(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateRelationalDatabase", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def create_relational_database_from_snapshot(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateRelationalDatabaseFromSnapshot", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def create_relational_database_snapshot(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateRelationalDatabaseSnapshot", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms).
"""
def delete_alarm(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteAlarm", input, options)
end
@doc """
Deletes an automatic snapshot of an instance or disk.
For more information, see the [Amazon Lightsail Developer Guide](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots).
"""
def delete_auto_snapshot(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteAutoSnapshot", input, options)
end
@doc """
Deletes a Amazon Lightsail bucket.
When you delete your bucket, the bucket name is released and can be reused for a
new bucket in your account or another Amazon Web Services account.
"""
def delete_bucket(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteBucket", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-bucket-access-keys)
in the *Amazon Lightsail Developer Guide*.
"""
def delete_bucket_access_key(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteBucketAccessKey", input, options)
end
@doc """
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.
"""
def delete_certificate(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteCertificate", input, options)
end
@doc """
Deletes a contact method.
A contact method is used to send you notifications about your Amazon Lightsail
resources. You can add one email address and one mobile phone number contact
method in each Amazon Web Services Region. However, SMS text messaging is not
supported in some Amazon Web Services Regions, and SMS text messages cannot be
sent to some countries/regions. For more information, see [Notifications in Amazon
Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications).
"""
def delete_contact_method(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteContactMethod", input, options)
end
@doc """
Deletes a container image that is registered to your Amazon Lightsail container
service.
"""
def delete_container_image(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteContainerImage", input, options)
end
@doc """
Deletes your Amazon Lightsail container service.
"""
def delete_container_service(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteContainerService", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def delete_disk(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteDisk", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def delete_disk_snapshot(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteDiskSnapshot", input, options)
end
@doc """
Deletes your Amazon Lightsail content delivery network (CDN) distribution.
"""
def delete_distribution(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteDistribution", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def delete_domain(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteDomain", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def delete_domain_entry(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteDomainEntry", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def delete_instance(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteInstance", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def delete_instance_snapshot(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteInstanceSnapshot", input, options)
end
@doc """
Deletes the specified key pair by removing the public key from Amazon Lightsail.
You can delete key pairs that were created using the
[ImportKeyPair](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_ImportKeyPair.html) and
[CreateKeyPair](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateKeyPair.html)
actions, as well as the Lightsail default key pair. A new default key pair will
not be created unless you launch an instance without specifying a custom key
pair, or you call the
[DownloadDefaultKeyPair](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_DownloadDefaultKeyPair.html) API.
The `delete key pair` operation supports tag-based access control via resource
tags applied to the resource identified by `key pair name`. For more
information, see the [Amazon Lightsail Developer
Guide](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def delete_key_pair(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteKeyPair", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-troubleshooting-browser-based-ssh-rdp-client-connection).
"""
def delete_known_host_keys(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteKnownHostKeys", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def delete_load_balancer(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteLoadBalancer", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def delete_load_balancer_tls_certificate(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteLoadBalancerTlsCertificate", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def delete_relational_database(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteRelationalDatabase", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def delete_relational_database_snapshot(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteRelationalDatabaseSnapshot", input, options)
end
@doc """
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.
"""
def detach_certificate_from_distribution(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DetachCertificateFromDistribution", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def detach_disk(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DetachDisk", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def detach_instances_from_load_balancer(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DetachInstancesFromLoadBalancer", input, options)
end
@doc """
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
"""
def detach_static_ip(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DetachStaticIp", input, options)
end
@doc """
Disables an add-on for an Amazon Lightsail resource.
For more information, see the [Amazon Lightsail Developer Guide](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots).
"""
def disable_add_on(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DisableAddOn", input, options)
end
@doc """
Downloads the regional Amazon Lightsail default key pair.
This action also creates a Lightsail default key pair if a default key pair does
not currently exist in the Amazon Web Services Region.
"""
def download_default_key_pair(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DownloadDefaultKeyPair", input, options)
end
@doc """
Enables or modifies an add-on for an Amazon Lightsail resource.
For more information, see the [Amazon Lightsail Developer Guide](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots).
"""
def enable_add_on(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "EnableAddOn", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
Use the `get instance snapshots` or `get disk snapshots` operations to get a
list of snapshots that you can export to Amazon EC2.
"""
def export_snapshot(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ExportSnapshot", input, options)
end
@doc """
Returns the names of all active (not deleted) resources.
"""
def get_active_names(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetActiveNames", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms).
"""
def get_alarms(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetAlarms", input, options)
end
@doc """
Returns the available automatic snapshots for an instance or disk.
For more information, see the [Amazon Lightsail Developer Guide](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-automatic-snapshots).
"""
def get_auto_snapshots(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetAutoSnapshots", input, options)
end
@doc """
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.
"""
def get_blueprints(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetBlueprints", input, options)
end
@doc """
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](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateBucketAccessKey.html)
action. If you lose the secret access key, you must create a new access key.
"""
def get_bucket_access_keys(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetBucketAccessKeys", input, options)
end
@doc """
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](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html)
action to update the bundle for a bucket.
"""
def get_bucket_bundles(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetBucketBundles", input, options)
end
@doc """
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.
"""
def get_bucket_metric_data(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetBucketMetricData", input, options)
end
@doc """
Returns information about one or more Amazon Lightsail buckets.
The information returned includes the synchronization status of the Amazon
Simple Storage Service (Amazon S3) account-level block public access feature for
your Lightsail buckets.
For more information about buckets, see [Buckets in Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/buckets-in-amazon-lightsail)
in the *Amazon Lightsail Developer Guide*.
"""
def get_buckets(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetBuckets", input, options)
end
@doc """
Returns the bundles that you can apply to an Amazon Lightsail instance when you
create it.
A bundle describes the specifications of an instance, such as the monthly cost,
amount of memory, the number of vCPUs, amount of storage space, and monthly
network data transfer quota.
Bundles are referred to as *instance plans* in the Lightsail console.
"""
def get_bundles(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetBundles", input, options)
end
@doc """
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.
"""
def get_certificates(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetCertificates", input, options)
end
@doc """
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.
"""
def get_cloud_formation_stack_records(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetCloudFormationStackRecords", input, options)
end
@doc """
Returns information about the configured contact methods.
Specify a protocol in your request to return information about a specific
contact method.
A contact method is used to send you notifications about your Amazon Lightsail
resources. You can add one email address and one mobile phone number contact
method in each Amazon Web Services Region. However, SMS text messaging is not
supported in some Amazon Web Services Regions, and SMS text messages cannot be
sent to some countries/regions. For more information, see [Notifications in Amazon
Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications).
"""
def get_contact_methods(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetContactMethods", input, options)
end
@doc """
Returns information about Amazon Lightsail containers, such as the current
version of the Lightsail Control (lightsailctl) plugin.
"""
def get_container_api_metadata(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetContainerAPIMetadata", input, options)
end
@doc """
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.
"""
def get_container_images(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetContainerImages", input, options)
end
@doc """
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](https://docs.aws.amazon.com/general/latest/gr/lightsail.html) in the
*Amazon Web Services General Reference*.
"""
def get_container_log(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetContainerLog", input, options)
end
@doc """
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](https://docs.aws.amazon.com/general/latest/gr/lightsail.html) in the
*Amazon Web Services General Reference*.
"""
def get_container_service_deployments(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetContainerServiceDeployments", input, options)
end
@doc """
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.
"""
def get_container_service_metric_data(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetContainerServiceMetricData", input, options)
end
@doc """
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.
"""
def get_container_service_powers(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetContainerServicePowers", input, options)
end
@doc """
Returns information about one or more of your Amazon Lightsail container
services.
"""
def get_container_services(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetContainerServices", input, options)
end
@doc """
Retrieves information about the cost estimate for a specified resource.
A cost estimate will not generate for a resource that has been deleted.
"""
def get_cost_estimate(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetCostEstimate", input, options)
end
@doc """
Returns information about a specific block storage disk.
"""
def get_disk(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetDisk", input, options)
end
@doc """
Returns information about a specific block storage disk snapshot.
"""
def get_disk_snapshot(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetDiskSnapshot", input, options)
end
@doc """
Returns information about all block storage disk snapshots in your AWS account
and region.
"""
def get_disk_snapshots(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetDiskSnapshots", input, options)
end
@doc """
Returns information about all block storage disks in your AWS account and
region.
"""
def get_disks(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetDisks", input, options)
end
@doc """
Returns the bundles that can be applied to your Amazon Lightsail content
delivery network (CDN) distributions.
A distribution bundle specifies the monthly network transfer quota and monthly
cost of your distribution.
"""
def get_distribution_bundles(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetDistributionBundles", input, options)
end
@doc """
Returns the timestamp and status of the last cache reset of a specific Amazon
Lightsail content delivery network (CDN) distribution.
"""
def get_distribution_latest_cache_reset(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetDistributionLatestCacheReset", input, options)
end
@doc """
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.
"""
def get_distribution_metric_data(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetDistributionMetricData", input, options)
end
@doc """
Returns information about one or more of your Amazon Lightsail content delivery
network (CDN) distributions.
"""
def get_distributions(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetDistributions", input, options)
end
@doc """
Returns information about a specific domain recordset.
"""
def get_domain(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetDomain", input, options)
end
@doc """
Returns a list of all domains in the user's account.
"""
def get_domains(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetDomains", input, options)
end
@doc """
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](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateCloudFormationStack.html)
action.
"""
def get_export_snapshot_records(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetExportSnapshotRecords", input, options)
end
@doc """
Returns information about a specific Amazon Lightsail instance, which is a
virtual private server.
"""
def get_instance(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetInstance", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def get_instance_access_details(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetInstanceAccessDetails", input, options)
end
@doc """
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.
"""
def get_instance_metric_data(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetInstanceMetricData", input, options)
end
@doc """
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.
"""
def get_instance_port_states(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetInstancePortStates", input, options)
end
@doc """
Returns information about a specific instance snapshot.
"""
def get_instance_snapshot(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetInstanceSnapshot", input, options)
end
@doc """
Returns all instance snapshots for the user's account.
"""
def get_instance_snapshots(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetInstanceSnapshots", input, options)
end
@doc """
Returns the state of a specific instance.
Works on one instance at a time.
"""
def get_instance_state(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetInstanceState", input, options)
end
@doc """
Returns information about all Amazon Lightsail virtual private servers, or
*instances*.
"""
def get_instances(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetInstances", input, options)
end
@doc """
Returns information about a specific key pair.
"""
def get_key_pair(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetKeyPair", input, options)
end
@doc """
Returns information about all key pairs in the user's account.
"""
def get_key_pairs(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetKeyPairs", input, options)
end
@doc """
Returns information about the specified Lightsail load balancer.
"""
def get_load_balancer(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetLoadBalancer", input, options)
end
@doc """
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.
"""
def get_load_balancer_metric_data(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetLoadBalancerMetricData", input, options)
end
@doc """
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.
"""
def get_load_balancer_tls_certificates(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetLoadBalancerTlsCertificates", input, options)
end
@doc """
Returns a list of TLS security policies that you can apply to Lightsail load
balancers.
For more information about load balancer TLS security policies, see [Configuring TLS security policies on your Amazon Lightsail load
balancers](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configure-load-balancer-tls-security-policy)
in the *Amazon Lightsail Developer Guide*.
"""
def get_load_balancer_tls_policies(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetLoadBalancerTlsPolicies", input, options)
end
@doc """
Returns information about all load balancers in an account.
"""
def get_load_balancers(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetLoadBalancers", input, options)
end
@doc """
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.
"""
def get_operation(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetOperation", input, options)
end
@doc """
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.
"""
def get_operations(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetOperations", input, options)
end
@doc """
Gets operations for a specific resource (e.g., an instance or a static IP).
"""
def get_operations_for_resource(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetOperationsForResource", input, options)
end
@doc """
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.
"""
def get_regions(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetRegions", input, options)
end
@doc """
Returns information about a specific database in Amazon Lightsail.
"""
def get_relational_database(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetRelationalDatabase", input, options)
end
@doc """
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.
"""
def get_relational_database_blueprints(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetRelationalDatabaseBlueprints", input, options)
end
@doc """
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.
"""
def get_relational_database_bundles(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetRelationalDatabaseBundles", input, options)
end
@doc """
Returns a list of events for a specific database in Amazon Lightsail.
"""
def get_relational_database_events(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetRelationalDatabaseEvents", input, options)
end
@doc """
Returns a list of log events for a database in Amazon Lightsail.
"""
def get_relational_database_log_events(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetRelationalDatabaseLogEvents", input, options)
end
@doc """
Returns a list of available log streams for a specific database in Amazon
Lightsail.
"""
def get_relational_database_log_streams(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetRelationalDatabaseLogStreams", input, options)
end
@doc """
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.
"""
def get_relational_database_master_user_password(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetRelationalDatabaseMasterUserPassword", input, options)
end
@doc """
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.
"""
def get_relational_database_metric_data(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetRelationalDatabaseMetricData", input, options)
end
@doc """
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.
"""
def get_relational_database_parameters(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetRelationalDatabaseParameters", input, options)
end
@doc """
Returns information about a specific database snapshot in Amazon Lightsail.
"""
def get_relational_database_snapshot(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetRelationalDatabaseSnapshot", input, options)
end
@doc """
Returns information about all of your database snapshots in Amazon Lightsail.
"""
def get_relational_database_snapshots(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetRelationalDatabaseSnapshots", input, options)
end
@doc """
Returns information about all of your databases in Amazon Lightsail.
"""
def get_relational_databases(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetRelationalDatabases", input, options)
end
@doc """
Returns information about an Amazon Lightsail static IP.
"""
def get_static_ip(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetStaticIp", input, options)
end
@doc """
Returns information about all static IPs in the user's account.
"""
def get_static_ips(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "GetStaticIps", input, options)
end
@doc """
Imports a public SSH key from a specific key pair.
"""
def import_key_pair(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ImportKeyPair", input, options)
end
@doc """
Returns a Boolean value indicating whether your Lightsail VPC is peered.
"""
def is_vpc_peered(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "IsVpcPeered", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def open_instance_public_ports(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "OpenInstancePublicPorts", input, options)
end
@doc """
Peers the Lightsail VPC with the user's default VPC.
"""
def peer_vpc(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "PeerVpc", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms).
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.
"""
def put_alarm(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "PutAlarm", input, options)
end
@doc """
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.
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def put_instance_public_ports(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "PutInstancePublicPorts", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def reboot_instance(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "RebootInstance", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def reboot_relational_database(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "RebootRelationalDatabase", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-pushing-container-images)
in the *Amazon Lightsail Developer Guide*.
"""
def register_container_image(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "RegisterContainerImage", input, options)
end
@doc """
Deletes a specific static IP from your account.
"""
def release_static_ip(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ReleaseStaticIp", input, options)
end
@doc """
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.
"""
def reset_distribution_cache(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ResetDistributionCache", input, options)
end
@doc """
Sends a verification request to an email contact method to ensure it's owned by
the requester.
SMS contact methods don't need to be verified.
A contact method is used to send you notifications about your Amazon Lightsail
resources. You can add one email address and one mobile phone number contact
method in each Amazon Web Services Region. However, SMS text messaging is not
supported in some Amazon Web Services Regions, and SMS text messages cannot be
sent to some countries/regions. For more information, see [Notifications in Amazon
Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-notifications).
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.
"""
def send_contact_method_verification(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "SendContactMethodVerification", input, options)
end
@doc """
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.
"""
def set_ip_address_type(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "SetIpAddressType", input, options)
end
@doc """
Sets the Amazon Lightsail resources that can access the specified Lightsail
bucket.
Lightsail buckets currently support setting access for Lightsail instances in
the same Amazon Web Services Region.
"""
def set_resource_access_for_bucket(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "SetResourceAccessForBucket", input, options)
end
@doc """
Initiates a graphical user interface (GUI) session that’s used to access a
virtual computer’s operating system and application.
The session will be active for 1 hour. Use this action to resume the session
after it expires.
"""
def start_g_ui_session(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "StartGUISession", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/lightsail-create-static-ip).
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def start_instance(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "StartInstance", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def start_relational_database(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "StartRelationalDatabase", input, options)
end
@doc """
Terminates a web-based NICE DCV session that’s used to access a virtual
computer’s operating system or application.
The session will close and any unsaved data will be lost.
"""
def stop_g_ui_session(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "StopGUISession", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/lightsail-create-static-ip).
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def stop_instance(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "StopInstance", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def stop_relational_database(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "StopRelationalDatabase", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags).
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def tag_resource(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "TagResource", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-alarms).
"""
def test_alarm(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "TestAlarm", input, options)
end
@doc """
Unpeers the Lightsail VPC from the user's default VPC.
"""
def unpeer_vpc(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UnpeerVpc", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def untag_resource(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UntagResource", input, options)
end
@doc """
Updates an existing Amazon Lightsail bucket.
Use this action to update the configuration of an existing bucket, such as
versioning, public accessibility, and the Amazon Web Services accounts that can
access the bucket.
"""
def update_bucket(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateBucket", input, options)
end
@doc """
Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.
A bucket bundle specifies the monthly cost, storage space, and data transfer
quota for a bucket. You can update a bucket's bundle only one time within a
monthly Amazon Web Services billing cycle. To determine if you can update a
bucket's bundle, use the
[GetBuckets](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBuckets.html)
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.
"""
def update_bucket_bundle(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateBucketBundle", input, options)
end
@doc """
Updates the configuration of your Amazon Lightsail container service, such as
its power, scale, and public domain names.
"""
def update_container_service(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateContainerService", input, options)
end
@doc """
Updates an existing Amazon Lightsail content delivery network (CDN)
distribution.
Use this action to update the configuration of your existing distribution.
"""
def update_distribution(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateDistribution", input, options)
end
@doc """
Updates the bundle of your Amazon Lightsail content delivery network (CDN)
distribution.
A distribution bundle specifies the monthly network transfer quota and monthly
cost of your distribution.
Update your distribution's bundle if your distribution is going over its monthly
network transfer quota and is incurring an overage fee.
You can update your distribution's bundle only one time within your monthly
Amazon Web Services billing cycle. To determine if you can update your
distribution's bundle, use the `GetDistributions` action. The
`ableToUpdateBundle` parameter in the result will indicate whether you can
currently update your distribution's bundle.
"""
def update_distribution_bundle(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateDistributionBundle", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def update_domain_entry(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateDomainEntry", input, options)
end
@doc """
Modifies the Amazon Lightsail instance metadata parameters on a running or
stopped instance.
When you modify the parameters on a running instance, the `GetInstance` or
`GetInstances` API operation initially responds with a state of `pending`. After
the parameter modifications are successfully applied, the state changes to
`applied` in subsequent `GetInstance` or `GetInstances` API calls. For more
information, see [Use IMDSv2 with an Amazon Lightsail instance](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-configuring-instance-metadata-service)
in the *Amazon Lightsail Developer Guide*.
"""
def update_instance_metadata_options(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateInstanceMetadataOptions", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def update_load_balancer_attribute(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateLoadBalancerAttribute", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def update_relational_database(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateRelationalDatabase", input, options)
end
@doc """
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](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-controlling-access-using-tags).
"""
def update_relational_database_parameters(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateRelationalDatabaseParameters", input, options)
end
end