AWS SDK for C++AWS SDK for C++ Version 1.11.607 |
Loading...
Searching...
No Matches
AWS SDK for C++AWS SDK for C++ Version 1.11.607 |
#include <LightsailClient.h>
Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes everything you need to launch your project quickly - instances (virtual private servers), container services, storage buckets, managed databases, SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN) distributions, DNS management of registered domains, and resource snapshots (backups) - for a low, predictable monthly price.
You can manage your Lightsail resources using the Lightsail console, Lightsail API, Command Line Interface (CLI), or SDKs. For more information about Lightsail concepts and tasks, see the Amazon Lightsail Developer Guide.
This API Reference provides detailed information about the actions, data types, parameters, and errors of the Lightsail service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see Amazon Lightsail Endpoints and Quotas in the Amazon Web Services General Reference.
Definition at line 38 of file LightsailClient.h.
Definition at line 41 of file LightsailClient.h.
Definition at line 45 of file LightsailClient.h.
Definition at line 46 of file LightsailClient.h.
Aws::Lightsail::LightsailClientConfiguration(),
nullptr
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr,
Aws::Lightsail::LightsailClientConfiguration()
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr,
Aws::Lightsail::LightsailClientConfiguration()
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
nullptr
An Async wrapper for AllocateStaticIp that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 116 of file LightsailClient.h.
A Callable wrapper for AllocateStaticIp that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 107 of file LightsailClient.h.
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.
nullptr
An Async wrapper for AttachCertificateToDistribution that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 150 of file LightsailClient.h.
A Callable wrapper for AttachCertificateToDistribution that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 141 of file LightsailClient.h.
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.
nullptr
An Async wrapper for AttachDisk that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 181 of file LightsailClient.h.
A Callable wrapper for AttachDisk that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 172 of file LightsailClient.h.
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.
nullptr
An Async wrapper for AttachInstancesToLoadBalancer that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 213 of file LightsailClient.h.
A Callable wrapper for AttachInstancesToLoadBalancer that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 204 of file LightsailClient.h.
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.
nullptr
An Async wrapper for AttachLoadBalancerTlsCertificate that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 249 of file LightsailClient.h.
A Callable wrapper for AttachLoadBalancerTlsCertificate that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 240 of file LightsailClient.h.
nullptr
An Async wrapper for AttachStaticIp that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 275 of file LightsailClient.h.
A Callable wrapper for AttachStaticIp that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 266 of file LightsailClient.h.
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.
nullptr
An Async wrapper for CloseInstancePublicPorts that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 305 of file LightsailClient.h.
A Callable wrapper for CloseInstancePublicPorts that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 296 of file LightsailClient.h.
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.
nullptr
An Async wrapper for CopySnapshot that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 340 of file LightsailClient.h.
A Callable wrapper for CopySnapshot that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 331 of file LightsailClient.h.
Creates an Amazon Lightsail bucket.
A bucket is a cloud storage resource available in the Lightsail object storage service. Use buckets to store objects such as data and its descriptive metadata. For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.
Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of an access key ID and corresponding secret access key.
Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the GetBucketAccessKeys action to get a list of current access keys for a specific bucket. For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.
The secretAccessKey value is returned only in response to the CreateBucketAccessKey action. You can get a secret access key only when you first create an access key; you cannot get the secret access key later. If you lose the secret access key, you must create a new access key.
nullptr
An Async wrapper for CreateBucketAccessKey that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 409 of file LightsailClient.h.
A Callable wrapper for CreateBucketAccessKey that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 400 of file LightsailClient.h.
nullptr
An Async wrapper for CreateBucket that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 371 of file LightsailClient.h.
A Callable wrapper for CreateBucket that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 362 of file LightsailClient.h.
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.
nullptr
An Async wrapper for CreateCertificate that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 444 of file LightsailClient.h.
A Callable wrapper for CreateCertificate that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 435 of file LightsailClient.h.
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.
nullptr
An Async wrapper for CreateCloudFormationStack that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 476 of file LightsailClient.h.
A Callable wrapper for CreateCloudFormationStack that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 467 of file LightsailClient.h.
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.
nullptr
An Async wrapper for CreateContactMethod that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 508 of file LightsailClient.h.
A Callable wrapper for CreateContactMethod that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 499 of file LightsailClient.h.
Creates an Amazon Lightsail container service.
A Lightsail container service is a compute resource to which you can deploy containers. For more information, see Container services in Amazon Lightsail in the Lightsail Dev Guide.
nullptr
An Async wrapper for CreateContainerService that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 538 of file LightsailClient.h.
A Callable wrapper for CreateContainerService that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 529 of file LightsailClient.h.
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 in the Amazon Lightsail Developer Guide.
nullptr
An Async wrapper for CreateContainerServiceDeployment that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 574 of file LightsailClient.h.
A Callable wrapper for CreateContainerServiceDeployment that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 565 of file LightsailClient.h.
{})
const
Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine. After you're logged in, you can use the native Docker commands to push your local container images to the container image registry of your Amazon Lightsail account so that you can use them with your Lightsail container service. The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials.
You can only push container images to the container service registry of your Lightsail account. You cannot pull container images or perform any other container image management actions on the container service registry.
After you push your container images to the container image registry of your Lightsail account, use the RegisterContainerImage action to register the pushed images to a specific Lightsail container service.
This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.
nullptr,
{}
An Async wrapper for CreateContainerServiceRegistryLogin that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 618 of file LightsailClient.h.
{})
const
A Callable wrapper for CreateContainerServiceRegistryLogin that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 609 of file LightsailClient.h.
Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (us-east-2a).
The create disk operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.
nullptr
An Async wrapper for CreateDisk that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 648 of file LightsailClient.h.
A Callable wrapper for CreateDisk that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 639 of file LightsailClient.h.
Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to an Amazon Lightsail instance in the same Availability Zone (us-east-2a).
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.
nullptr
An Async wrapper for CreateDiskFromSnapshot that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 680 of file LightsailClient.h.
A Callable wrapper for CreateDiskFromSnapshot that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 671 of file LightsailClient.h.
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.
nullptr
An Async wrapper for CreateDiskSnapshot that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 727 of file LightsailClient.h.
A Callable wrapper for CreateDiskSnapshot that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 718 of file LightsailClient.h.
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.
nullptr
An Async wrapper for CreateDistribution that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 757 of file LightsailClient.h.
A Callable wrapper for CreateDistribution that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 748 of file LightsailClient.h.
Creates a domain resource for the specified domain (example.com).
The create domain operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.
nullptr
An Async wrapper for CreateDomain that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 786 of file LightsailClient.h.
A Callable wrapper for CreateDomain that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 777 of file LightsailClient.h.
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.
nullptr
An Async wrapper for CreateDomainEntry that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 818 of file LightsailClient.h.
A Callable wrapper for CreateDomainEntry that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 809 of file LightsailClient.h.
Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session. The primary URL initiates a web-based Amazon DCV session to the virtual computer's application. The secondary URL initiates a web-based Amazon DCV session to the virtual computer's operating session.
Use StartGUISession to open the session.
nullptr
An Async wrapper for CreateGUISessionAccessDetails that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 848 of file LightsailClient.h.
A Callable wrapper for CreateGUISessionAccessDetails that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 839 of file LightsailClient.h.
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.
nullptr
An Async wrapper for CreateInstances that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 907 of file LightsailClient.h.
A Callable wrapper for CreateInstances that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 898 of file LightsailClient.h.
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.
nullptr
An Async wrapper for CreateInstancesFromSnapshot that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 938 of file LightsailClient.h.
A Callable wrapper for CreateInstancesFromSnapshot that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 929 of file LightsailClient.h.
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.
nullptr
An Async wrapper for CreateInstanceSnapshot that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 878 of file LightsailClient.h.
A Callable wrapper for CreateInstanceSnapshot that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 869 of file LightsailClient.h.
Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.
Use the DownloadDefaultKeyPair action to create a Lightsail default key pair 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.
nullptr
An Async wrapper for CreateKeyPair that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 971 of file LightsailClient.h.
A Callable wrapper for CreateKeyPair that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 962 of file LightsailClient.h.
Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing. You can create up to 5 load balancers per AWS Region in your account.
When you create a load balancer, you can specify a unique name and port settings. To change additional load balancer settings, use the UpdateLoadBalancerAttribute operation.
The create load balancer operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.
nullptr
An Async wrapper for CreateLoadBalancer that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1006 of file LightsailClient.h.
A Callable wrapper for CreateLoadBalancer that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 997 of file LightsailClient.h.
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.
nullptr
An Async wrapper for CreateLoadBalancerTlsCertificate that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1037 of file LightsailClient.h.
A Callable wrapper for CreateLoadBalancerTlsCertificate that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1028 of file LightsailClient.h.
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.
nullptr
An Async wrapper for CreateRelationalDatabase that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1066 of file LightsailClient.h.
A Callable wrapper for CreateRelationalDatabase that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1057 of file LightsailClient.h.
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.
nullptr
An Async wrapper for CreateRelationalDatabaseFromSnapshot that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1099 of file LightsailClient.h.
A Callable wrapper for CreateRelationalDatabaseFromSnapshot that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1090 of file LightsailClient.h.
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.
nullptr
An Async wrapper for CreateRelationalDatabaseSnapshot that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1130 of file LightsailClient.h.
A Callable wrapper for CreateRelationalDatabaseSnapshot that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1121 of file LightsailClient.h.
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.
nullptr
An Async wrapper for DeleteAlarm that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1160 of file LightsailClient.h.
A Callable wrapper for DeleteAlarm that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1151 of file LightsailClient.h.
Deletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide.
nullptr
An Async wrapper for DeleteAutoSnapshot that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1188 of file LightsailClient.h.
A Callable wrapper for DeleteAutoSnapshot that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1179 of file LightsailClient.h.
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.
Deletes an access key for the specified Amazon Lightsail bucket.
We recommend that you delete an access key if the secret access key is compromised.
For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.
nullptr
An Async wrapper for DeleteBucketAccessKey that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1245 of file LightsailClient.h.
A Callable wrapper for DeleteBucketAccessKey that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1236 of file LightsailClient.h.
nullptr
An Async wrapper for DeleteBucket that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1215 of file LightsailClient.h.
A Callable wrapper for DeleteBucket that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1206 of file LightsailClient.h.
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.
nullptr
An Async wrapper for DeleteCertificate that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1274 of file LightsailClient.h.
A Callable wrapper for DeleteCertificate that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1265 of file LightsailClient.h.
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.
nullptr
An Async wrapper for DeleteContactMethod that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1306 of file LightsailClient.h.
A Callable wrapper for DeleteContactMethod that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1297 of file LightsailClient.h.
Deletes a container image that is registered to your Amazon Lightsail container service.
nullptr
An Async wrapper for DeleteContainerImage that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1332 of file LightsailClient.h.
A Callable wrapper for DeleteContainerImage that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1323 of file LightsailClient.h.
nullptr
An Async wrapper for DeleteContainerService that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1358 of file LightsailClient.h.
A Callable wrapper for DeleteContainerService that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1349 of file LightsailClient.h.
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.
nullptr
An Async wrapper for DeleteDisk that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1390 of file LightsailClient.h.
A Callable wrapper for DeleteDisk that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1381 of file LightsailClient.h.
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.
nullptr
An Async wrapper for DeleteDiskSnapshot that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1425 of file LightsailClient.h.
A Callable wrapper for DeleteDiskSnapshot that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1416 of file LightsailClient.h.
{})
const
Deletes your Amazon Lightsail content delivery network (CDN) distribution.
nullptr,
{}
An Async wrapper for DeleteDistribution that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1451 of file LightsailClient.h.
{})
const
A Callable wrapper for DeleteDistribution that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1442 of file LightsailClient.h.
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.
nullptr
An Async wrapper for DeleteDomain that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1481 of file LightsailClient.h.
A Callable wrapper for DeleteDomain that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1472 of file LightsailClient.h.
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.
nullptr
An Async wrapper for DeleteDomainEntry that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1511 of file LightsailClient.h.
A Callable wrapper for DeleteDomainEntry that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1502 of file LightsailClient.h.
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.
nullptr
An Async wrapper for DeleteInstance that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1541 of file LightsailClient.h.
A Callable wrapper for DeleteInstance that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1532 of file LightsailClient.h.
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.
nullptr
An Async wrapper for DeleteInstanceSnapshot that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1572 of file LightsailClient.h.
A Callable wrapper for DeleteInstanceSnapshot that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1563 of file LightsailClient.h.
Deletes the specified key pair by removing the public key from Amazon Lightsail.
You can delete key pairs that were created using the ImportKeyPair and CreateKeyPair 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 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.
nullptr
An Async wrapper for DeleteKeyPair that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1610 of file LightsailClient.h.
A Callable wrapper for DeleteKeyPair that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1601 of file LightsailClient.h.
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.
nullptr
An Async wrapper for DeleteKnownHostKeys that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1644 of file LightsailClient.h.
A Callable wrapper for DeleteKnownHostKeys that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1635 of file LightsailClient.h.
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.
nullptr
An Async wrapper for DeleteLoadBalancer that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1676 of file LightsailClient.h.
A Callable wrapper for DeleteLoadBalancer that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1667 of file LightsailClient.h.
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.
nullptr
An Async wrapper for DeleteLoadBalancerTlsCertificate that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1706 of file LightsailClient.h.
A Callable wrapper for DeleteLoadBalancerTlsCertificate that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1697 of file LightsailClient.h.
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.
nullptr
An Async wrapper for DeleteRelationalDatabase that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1736 of file LightsailClient.h.
A Callable wrapper for DeleteRelationalDatabase that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1727 of file LightsailClient.h.
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.
nullptr
An Async wrapper for DeleteRelationalDatabaseSnapshot that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1766 of file LightsailClient.h.
A Callable wrapper for DeleteRelationalDatabaseSnapshot that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1757 of file LightsailClient.h.
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.
nullptr
An Async wrapper for DetachCertificateFromDistribution that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1794 of file LightsailClient.h.
A Callable wrapper for DetachCertificateFromDistribution that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1785 of file LightsailClient.h.
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.
nullptr
An Async wrapper for DetachDisk that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1826 of file LightsailClient.h.
A Callable wrapper for DetachDisk that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1817 of file LightsailClient.h.
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.
nullptr
An Async wrapper for DetachInstancesFromLoadBalancer that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1858 of file LightsailClient.h.
A Callable wrapper for DetachInstancesFromLoadBalancer that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1849 of file LightsailClient.h.
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
nullptr
An Async wrapper for DetachStaticIp that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1884 of file LightsailClient.h.
A Callable wrapper for DetachStaticIp that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1875 of file LightsailClient.h.
Disables an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.
nullptr
An Async wrapper for DisableAddOn that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1912 of file LightsailClient.h.
A Callable wrapper for DisableAddOn that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1903 of file LightsailClient.h.
{})
const
nullptr,
{}
An Async wrapper for DownloadDefaultKeyPair that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1939 of file LightsailClient.h.
{})
const
A Callable wrapper for DownloadDefaultKeyPair that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1930 of file LightsailClient.h.
Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.
nullptr
An Async wrapper for EnableAddOn that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 1967 of file LightsailClient.h.
A Callable wrapper for EnableAddOn that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1958 of file LightsailClient.h.
Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot record that can be used with the create cloud formation stack operation to create new Amazon EC2 instances.
Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot.
The export snapshot operation supports tag-based access control via resource tags applied to the resource identified by source snapshot name. For more information, see the Amazon Lightsail Developer Guide.
Use the get instance snapshots or get disk snapshots operations to get a list of snapshots that you can export to Amazon EC2.
nullptr
An Async wrapper for ExportSnapshot that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2007 of file LightsailClient.h.
A Callable wrapper for ExportSnapshot that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 1998 of file LightsailClient.h.
{})
const
nullptr,
{}
An Async wrapper for GetActiveNames that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2033 of file LightsailClient.h.
{})
const
A Callable wrapper for GetActiveNames that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2024 of file LightsailClient.h.
{})
const
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.
nullptr,
{}
An Async wrapper for GetAlarms that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2066 of file LightsailClient.h.
{})
const
A Callable wrapper for GetAlarms that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2057 of file LightsailClient.h.
Returns the available automatic snapshots for an instance or disk. For more information, see the Amazon Lightsail Developer Guide.
nullptr
An Async wrapper for GetAutoSnapshots that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2094 of file LightsailClient.h.
A Callable wrapper for GetAutoSnapshots that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2085 of file LightsailClient.h.
{})
const
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.
nullptr,
{}
An Async wrapper for GetBlueprints that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2127 of file LightsailClient.h.
{})
const
A Callable wrapper for GetBlueprints that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2118 of file LightsailClient.h.
Returns the existing access key IDs for the specified Amazon Lightsail bucket.
This action does not return the secret access key value of an access key. You can get a secret access key only when you create it from the response of the CreateBucketAccessKey action. If you lose the secret access key, you must create a new access key.
nullptr
An Async wrapper for GetBucketAccessKeys that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2158 of file LightsailClient.h.
A Callable wrapper for GetBucketAccessKeys that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2149 of file LightsailClient.h.
{})
const
Returns the bundles that you can apply to a Amazon Lightsail bucket.
The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a bucket.
Use the UpdateBucketBundle action to update the bundle for a bucket.
nullptr,
{}
An Async wrapper for GetBucketBundles that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2187 of file LightsailClient.h.
{})
const
A Callable wrapper for GetBucketBundles that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2178 of file LightsailClient.h.
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.
nullptr
An Async wrapper for GetBucketMetricData that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2216 of file LightsailClient.h.
A Callable wrapper for GetBucketMetricData that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2207 of file LightsailClient.h.
{})
const
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 in the Amazon Lightsail Developer Guide.
nullptr,
{}
An Async wrapper for GetBuckets that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2247 of file LightsailClient.h.
{})
const
A Callable wrapper for GetBuckets that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2238 of file LightsailClient.h.
{})
const
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.
nullptr,
{}
An Async wrapper for GetBundles that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2277 of file LightsailClient.h.
{})
const
A Callable wrapper for GetBundles that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2268 of file LightsailClient.h.
{})
const
Returns information about one or more Amazon Lightsail SSL/TLS certificates.
To get a summary of a certificate, omit includeCertificateDetails from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.
nullptr,
{}
An Async wrapper for GetCertificates that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2306 of file LightsailClient.h.
{})
const
A Callable wrapper for GetCertificates that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2297 of file LightsailClient.h.
{})
const
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.
nullptr,
{}
An Async wrapper for GetCloudFormationStackRecords that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2334 of file LightsailClient.h.
{})
const
A Callable wrapper for GetCloudFormationStackRecords that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2325 of file LightsailClient.h.
{})
const
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.
nullptr,
{}
An Async wrapper for GetContactMethods that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2367 of file LightsailClient.h.
{})
const
A Callable wrapper for GetContactMethods that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2358 of file LightsailClient.h.
{})
const
nullptr,
{}
An Async wrapper for GetContainerAPIMetadata that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2394 of file LightsailClient.h.
{})
const
A Callable wrapper for GetContainerAPIMetadata that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2385 of file LightsailClient.h.
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.
nullptr
An Async wrapper for GetContainerImages that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2424 of file LightsailClient.h.
A Callable wrapper for GetContainerImages that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2415 of file LightsailClient.h.
Returns the log events of a container of your Amazon Lightsail container service.
If your container service has more than one node (i.e., a scale greater than 1), then the log events that are returned for the specified container are merged from all nodes on your container service.
Container logs are retained for a certain amount of time. For more information, see Amazon Lightsail endpoints and quotas in the Amazon Web Services General Reference.
nullptr
An Async wrapper for GetContainerLog that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2457 of file LightsailClient.h.
A Callable wrapper for GetContainerLog that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2448 of file LightsailClient.h.
Returns the deployments for your Amazon Lightsail container service
A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.
The deployments are ordered by version in ascending order. The newest version is listed at the top of the response.
A set number of deployments are kept before the oldest one is replaced with the newest one. For more information, see Amazon Lightsail endpoints and quotas in the Amazon Web Services General Reference.
nullptr
An Async wrapper for GetContainerServiceDeployments that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 2490 of file LightsailClient.h.
A Callable wrapper for GetContainerServiceDeployments that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 2481 of file LightsailClient.h.
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.