/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.lightsail; import javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.lightsail.model.*; /** * Interface for accessing Amazon Lightsail. *

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.lightsail.AbstractAmazonLightsail} instead. *

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

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonLightsail { /** * The region metadata service name for computing region endpoints. You can use this value to retrieve metadata * (such as supported regions) of the service. * * @see RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "lightsail"; /** * Overrides the default endpoint for this client ("lightsail.us-east-1.amazonaws.com"). Callers can use this method * to control which AWS region they want to work with. *

* Callers can pass in just the endpoint (ex: "lightsail.us-east-1.amazonaws.com") or a full URL, including the * protocol (ex: "lightsail.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol * from this client's {@link ClientConfiguration} will be used, which by default is HTTPS. *

* For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available * endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- * choose-endpoint *

* This method is not threadsafe. An endpoint should be configured when the client is created and before any * service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in * transit or retrying. * * @param endpoint * The endpoint (ex: "lightsail.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: * "lightsail.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate * with. * @deprecated use {@link AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)} for * example: * {@code builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));} */ @Deprecated void setEndpoint(String endpoint); /** * An alternative to {@link AmazonLightsail#setEndpoint(String)}, sets the regional endpoint for this client's * service calls. Callers can use this method to control which AWS region they want to work with. *

* By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the * {@link ClientConfiguration} supplied at construction. *

* This method is not threadsafe. A region should be configured when the client is created and before any service * requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit * or retrying. * * @param region * The region this client will communicate with. See * {@link com.amazonaws.regions.Region#getRegion(com.amazonaws.regions.Regions)} for accessing a given * region. Must not be null and must be a region where the service is available. * * @see Region#getRegion(com.amazonaws.regions.Regions) * @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration) * @see com.amazonaws.regions.Region#isServiceSupported(String) * @deprecated use {@link AwsClientBuilder#setRegion(String)} */ @Deprecated void setRegion(com.amazonaws.regions.Region region); /** *

* Allocates a static IP address. *

* * @param allocateStaticIpRequest * @return Result of the AllocateStaticIp operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web * Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to * create, view, or edit these resources. *

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

* * * @param attachCertificateToDistributionRequest * @return Result of the AttachCertificateToDistribution operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param attachDiskRequest * @return Result of the AttachDisk operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param attachInstancesToLoadBalancerRequest * @return Result of the AttachInstancesToLoadBalancer operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param attachLoadBalancerTlsCertificateRequest * @return Result of the AttachLoadBalancerTlsCertificate operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param attachStaticIpRequest * @return Result of the AttachStaticIp operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param closeInstancePublicPortsRequest * @return Result of the CloseInstancePublicPorts operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param copySnapshotRequest * @return Result of the CopySnapshot operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param createBucketRequest * @return Result of the CreateBucket operation returned by the service. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws ServiceException * A general service exception. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.CreateBucket * @see AWS API * Documentation */ CreateBucketResult createBucket(CreateBucketRequest createBucketRequest); /** *

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

* * * @param createBucketAccessKeyRequest * @return Result of the CreateBucketAccessKey operation returned by the service. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws ServiceException * A general service exception. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.CreateBucketAccessKey * @see AWS API Documentation */ CreateBucketAccessKeyResult createBucketAccessKey(CreateBucketAccessKeyRequest createBucketAccessKeyRequest); /** *

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

* *

* * * @param createCertificateRequest * @return Result of the CreateCertificate operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.CreateCertificate * @see AWS * API Documentation */ CreateCertificateResult createCertificate(CreateCertificateRequest createCertificateRequest); /** *

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

* * * @param createCloudFormationStackRequest * @return Result of the CreateCloudFormationStack operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param createContactMethodRequest * @return Result of the CreateContactMethod operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param createContainerServiceRequest * @return Result of the CreateContainerService operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.CreateContainerService * @see AWS API Documentation */ CreateContainerServiceResult createContainerService(CreateContainerServiceRequest createContainerServiceRequest); /** *

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

* * @param createContainerServiceDeploymentRequest * @return Result of the CreateContainerServiceDeployment operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.CreateContainerServiceDeployment * @see AWS API Documentation */ CreateContainerServiceDeploymentResult createContainerServiceDeployment(CreateContainerServiceDeploymentRequest createContainerServiceDeploymentRequest); /** *

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

* * * @param createContainerServiceRegistryLoginRequest * @return Result of the CreateContainerServiceRegistryLogin operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.CreateContainerServiceRegistryLogin * @see AWS API Documentation */ CreateContainerServiceRegistryLoginResult createContainerServiceRegistryLogin( CreateContainerServiceRegistryLoginRequest createContainerServiceRegistryLoginRequest); /** *

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

* * @param createDiskRequest * @return Result of the CreateDisk operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param createDiskFromSnapshotRequest * @return Result of the CreateDiskFromSnapshot operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param createDiskSnapshotRequest * @return Result of the CreateDiskSnapshot operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param createDistributionRequest * @return Result of the CreateDistribution operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param createDomainRequest * @return Result of the CreateDomain operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param createDomainEntryRequest * @return Result of the CreateDomainEntry operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param createGUISessionAccessDetailsRequest * @return Result of the CreateGUISessionAccessDetails operation returned by the service. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws ServiceException * A general service exception. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.CreateGUISessionAccessDetails * @see AWS API Documentation */ CreateGUISessionAccessDetailsResult createGUISessionAccessDetails(CreateGUISessionAccessDetailsRequest createGUISessionAccessDetailsRequest); /** *

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

* * @param createInstanceSnapshotRequest * @return Result of the CreateInstanceSnapshot operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param createInstancesRequest * @return Result of the CreateInstances operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param createInstancesFromSnapshotRequest * @return Result of the CreateInstancesFromSnapshot operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param createKeyPairRequest * @return Result of the CreateKeyPair operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param createLoadBalancerRequest * @return Result of the CreateLoadBalancer operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param createLoadBalancerTlsCertificateRequest * @return Result of the CreateLoadBalancerTlsCertificate operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param createRelationalDatabaseRequest * @return Result of the CreateRelationalDatabase operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param createRelationalDatabaseFromSnapshotRequest * @return Result of the CreateRelationalDatabaseFromSnapshot operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param createRelationalDatabaseSnapshotRequest * @return Result of the CreateRelationalDatabaseSnapshot operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param deleteAlarmRequest * @return Result of the DeleteAlarm operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws OperationFailureException * Lightsail throws this exception when an operation fails to execute. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @sample AmazonLightsail.DeleteAlarm * @see AWS API * Documentation */ DeleteAlarmResult deleteAlarm(DeleteAlarmRequest deleteAlarmRequest); /** *

* Deletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide. *

* * @param deleteAutoSnapshotRequest * @return Result of the DeleteAutoSnapshot operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * * @param deleteBucketRequest * @return Result of the DeleteBucket operation returned by the service. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws ServiceException * A general service exception. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.DeleteBucket * @see AWS API * Documentation */ DeleteBucketResult deleteBucket(DeleteBucketRequest deleteBucketRequest); /** *

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

* * @param deleteBucketAccessKeyRequest * @return Result of the DeleteBucketAccessKey operation returned by the service. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws ServiceException * A general service exception. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.DeleteBucketAccessKey * @see AWS API Documentation */ DeleteBucketAccessKeyResult deleteBucketAccessKey(DeleteBucketAccessKeyRequest deleteBucketAccessKeyRequest); /** *

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

* * @param deleteCertificateRequest * @return Result of the DeleteCertificate operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.DeleteCertificate * @see AWS * API Documentation */ DeleteCertificateResult deleteCertificate(DeleteCertificateRequest deleteCertificateRequest); /** *

* Deletes a contact method. *

* * @param deleteContactMethodRequest * @return Result of the DeleteContactMethod operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws OperationFailureException * Lightsail throws this exception when an operation fails to execute. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @sample AmazonLightsail.DeleteContactMethod * @see AWS * API Documentation */ DeleteContactMethodResult deleteContactMethod(DeleteContactMethodRequest deleteContactMethodRequest); /** *

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

* * @param deleteContainerImageRequest * @return Result of the DeleteContainerImage operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.DeleteContainerImage * @see AWS * API Documentation */ DeleteContainerImageResult deleteContainerImage(DeleteContainerImageRequest deleteContainerImageRequest); /** *

* Deletes your Amazon Lightsail container service. *

* * @param deleteContainerServiceRequest * @return Result of the DeleteContainerService operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.DeleteContainerService * @see AWS API Documentation */ DeleteContainerServiceResult deleteContainerService(DeleteContainerServiceRequest deleteContainerServiceRequest); /** *

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

* * @param deleteDiskRequest * @return Result of the DeleteDisk operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param deleteDiskSnapshotRequest * @return Result of the DeleteDiskSnapshot operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param deleteDistributionRequest * @return Result of the DeleteDistribution operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param deleteDomainRequest * @return Result of the DeleteDomain operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param deleteDomainEntryRequest * @return Result of the DeleteDomainEntry operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param deleteInstanceRequest * @return Result of the DeleteInstance operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param deleteInstanceSnapshotRequest * @return Result of the DeleteInstanceSnapshot operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param deleteKeyPairRequest * @return Result of the DeleteKeyPair operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * * @param deleteKnownHostKeysRequest * @return Result of the DeleteKnownHostKeys operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param deleteLoadBalancerRequest * @return Result of the DeleteLoadBalancer operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param deleteLoadBalancerTlsCertificateRequest * @return Result of the DeleteLoadBalancerTlsCertificate operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param deleteRelationalDatabaseRequest * @return Result of the DeleteRelationalDatabase operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param deleteRelationalDatabaseSnapshotRequest * @return Result of the DeleteRelationalDatabaseSnapshot operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param detachCertificateFromDistributionRequest * @return Result of the DetachCertificateFromDistribution operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param detachDiskRequest * @return Result of the DetachDisk operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param detachInstancesFromLoadBalancerRequest * @return Result of the DetachInstancesFromLoadBalancer operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param detachStaticIpRequest * @return Result of the DetachStaticIp operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* Disables an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide. *

* * @param disableAddOnRequest * @return Result of the DisableAddOn operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param downloadDefaultKeyPairRequest * @return Result of the DownloadDefaultKeyPair operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide. *

* * @param enableAddOnRequest * @return Result of the EnableAddOn operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * * @param exportSnapshotRequest * @return Result of the ExportSnapshot operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getActiveNamesRequest * @return Result of the GetActiveNames operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getAlarmsRequest * @return Result of the GetAlarms operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws OperationFailureException * Lightsail throws this exception when an operation fails to execute. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @sample AmazonLightsail.GetAlarms * @see AWS API * Documentation */ GetAlarmsResult getAlarms(GetAlarmsRequest getAlarmsRequest); /** *

* Returns the available automatic snapshots for an instance or disk. For more information, see the Amazon Lightsail Developer Guide. *

* * @param getAutoSnapshotsRequest * @return Result of the GetAutoSnapshots operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * * @param getBlueprintsRequest * @return Result of the GetBlueprints operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * * @param getBucketAccessKeysRequest * @return Result of the GetBucketAccessKeys operation returned by the service. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws ServiceException * A general service exception. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.GetBucketAccessKeys * @see AWS * API Documentation */ GetBucketAccessKeysResult getBucketAccessKeys(GetBucketAccessKeysRequest getBucketAccessKeysRequest); /** *

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

* * @param getBucketBundlesRequest * @return Result of the GetBucketBundles operation returned by the service. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws ServiceException * A general service exception. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.GetBucketBundles * @see AWS API * Documentation */ GetBucketBundlesResult getBucketBundles(GetBucketBundlesRequest getBucketBundlesRequest); /** *

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

* * @param getBucketMetricDataRequest * @return Result of the GetBucketMetricData operation returned by the service. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws ServiceException * A general service exception. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.GetBucketMetricData * @see AWS * API Documentation */ GetBucketMetricDataResult getBucketMetricData(GetBucketMetricDataRequest getBucketMetricDataRequest); /** *

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

* * @param getBucketsRequest * @return Result of the GetBuckets operation returned by the service. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws ServiceException * A general service exception. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.GetBuckets * @see AWS API * Documentation */ GetBucketsResult getBuckets(GetBucketsRequest getBucketsRequest); /** *

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

* * * @param getBundlesRequest * @return Result of the GetBundles operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * * @param getCertificatesRequest * @return Result of the GetCertificates operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.GetCertificates * @see AWS API * Documentation */ GetCertificatesResult getCertificates(GetCertificatesRequest getCertificatesRequest); /** *

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

* * @param getCloudFormationStackRecordsRequest * @return Result of the GetCloudFormationStackRecords operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* Returns information about the configured contact methods. Specify a protocol in your request to return * information about a specific contact method. *

* * @param getContactMethodsRequest * @return Result of the GetContactMethods operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getContainerAPIMetadataRequest * @return Result of the GetContainerAPIMetadata operation returned by the service. * @throws ServiceException * A general service exception. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.GetContainerAPIMetadata * @see AWS API Documentation */ GetContainerAPIMetadataResult getContainerAPIMetadata(GetContainerAPIMetadataRequest getContainerAPIMetadataRequest); /** *

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

* * * @param getContainerImagesRequest * @return Result of the GetContainerImages operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.GetContainerImages * @see AWS * API Documentation */ GetContainerImagesResult getContainerImages(GetContainerImagesRequest getContainerImagesRequest); /** *

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

* * * @param getContainerLogRequest * @return Result of the GetContainerLog operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.GetContainerLog * @see AWS API * Documentation */ GetContainerLogResult getContainerLog(GetContainerLogRequest getContainerLogRequest); /** *

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

* * * @param getContainerServiceDeploymentsRequest * @return Result of the GetContainerServiceDeployments operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.GetContainerServiceDeployments * @see AWS API Documentation */ GetContainerServiceDeploymentsResult getContainerServiceDeployments(GetContainerServiceDeploymentsRequest getContainerServiceDeploymentsRequest); /** *

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

* * @param getContainerServiceMetricDataRequest * @return Result of the GetContainerServiceMetricData operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.GetContainerServiceMetricData * @see AWS API Documentation */ GetContainerServiceMetricDataResult getContainerServiceMetricData(GetContainerServiceMetricDataRequest getContainerServiceMetricDataRequest); /** *

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

* * @param getContainerServicePowersRequest * @return Result of the GetContainerServicePowers operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.GetContainerServicePowers * @see AWS API Documentation */ GetContainerServicePowersResult getContainerServicePowers(GetContainerServicePowersRequest getContainerServicePowersRequest); /** *

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

* * @param getContainerServicesRequest * @return Result of the GetContainerServices operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.GetContainerServices * @see AWS * API Documentation */ GetContainerServicesResult getContainerServices(GetContainerServicesRequest getContainerServicesRequest); /** *

* Retrieves information about the cost estimate for a specified resource. A cost estimate will not generate for a * resource that has been deleted. *

* * @param getCostEstimateRequest * @return Result of the GetCostEstimate operation returned by the service. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws ServiceException * A general service exception. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.GetCostEstimate * @see AWS API * Documentation */ GetCostEstimateResult getCostEstimate(GetCostEstimateRequest getCostEstimateRequest); /** *

* Returns information about a specific block storage disk. *

* * @param getDiskRequest * @return Result of the GetDisk operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* Returns information about a specific block storage disk snapshot. *

* * @param getDiskSnapshotRequest * @return Result of the GetDiskSnapshot operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getDiskSnapshotsRequest * @return Result of the GetDiskSnapshots operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getDisksRequest * @return Result of the GetDisks operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getDistributionBundlesRequest * @return Result of the GetDistributionBundles operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getDistributionLatestCacheResetRequest * @return Result of the GetDistributionLatestCacheReset operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getDistributionMetricDataRequest * @return Result of the GetDistributionMetricData operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getDistributionsRequest * @return Result of the GetDistributions operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* Returns information about a specific domain recordset. *

* * @param getDomainRequest * @return Result of the GetDomain operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getDomainsRequest * @return Result of the GetDomains operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

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

* * @param getExportSnapshotRecordsRequest * @return Result of the GetExportSnapshotRecords operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getInstanceRequest * @return Result of the GetInstance operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getInstanceAccessDetailsRequest * @return Result of the GetInstanceAccessDetails operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* Returns the data points for the specified Amazon Lightsail instance metric, given an instance name. *

* * @param getInstanceMetricDataRequest * @return Result of the GetInstanceMetricData operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getInstancePortStatesRequest * @return Result of the GetInstancePortStates operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* Returns information about a specific instance snapshot. *

* * @param getInstanceSnapshotRequest * @return Result of the GetInstanceSnapshot operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* Returns all instance snapshots for the user's account. *

* * @param getInstanceSnapshotsRequest * @return Result of the GetInstanceSnapshots operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* Returns the state of a specific instance. Works on one instance at a time. *

* * @param getInstanceStateRequest * @return Result of the GetInstanceState operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getInstancesRequest * @return Result of the GetInstances operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* Returns information about a specific key pair. *

* * @param getKeyPairRequest * @return Result of the GetKeyPair operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getKeyPairsRequest * @return Result of the GetKeyPairs operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* Returns information about the specified Lightsail load balancer. *

* * @param getLoadBalancerRequest * @return Result of the GetLoadBalancer operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* Returns information about health metrics for your Lightsail load balancer. *

* * @param getLoadBalancerMetricDataRequest * @return Result of the GetLoadBalancerMetricData operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getLoadBalancerTlsCertificatesRequest * @return Result of the GetLoadBalancerTlsCertificates operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getLoadBalancerTlsPoliciesRequest * @return Result of the GetLoadBalancerTlsPolicies operation returned by the service. * @throws ServiceException * A general service exception. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws AccountSetupInProgressException * Lightsail throws this exception when an account is still in the setup in progress state. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @sample AmazonLightsail.GetLoadBalancerTlsPolicies * @see AWS API Documentation */ GetLoadBalancerTlsPoliciesResult getLoadBalancerTlsPolicies(GetLoadBalancerTlsPoliciesRequest getLoadBalancerTlsPoliciesRequest); /** *

* Returns information about all load balancers in an account. *

* * @param getLoadBalancersRequest * @return Result of the GetLoadBalancers operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getOperationRequest * @return Result of the GetOperation operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getOperationsRequest * @return Result of the GetOperations operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getOperationsForResourceRequest * @return Result of the GetOperationsForResource operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getRegionsRequest * @return Result of the GetRegions operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* Returns information about a specific database in Amazon Lightsail. *

* * @param getRelationalDatabaseRequest * @return Result of the GetRelationalDatabase operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getRelationalDatabaseBlueprintsRequest * @return Result of the GetRelationalDatabaseBlueprints operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getRelationalDatabaseBundlesRequest * @return Result of the GetRelationalDatabaseBundles operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getRelationalDatabaseEventsRequest * @return Result of the GetRelationalDatabaseEvents operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getRelationalDatabaseLogEventsRequest * @return Result of the GetRelationalDatabaseLogEvents operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getRelationalDatabaseLogStreamsRequest * @return Result of the GetRelationalDatabaseLogStreams operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getRelationalDatabaseMasterUserPasswordRequest * @return Result of the GetRelationalDatabaseMasterUserPassword operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* Returns the data points of the specified metric for a database in Amazon Lightsail. *

* * @param getRelationalDatabaseMetricDataRequest * @return Result of the GetRelationalDatabaseMetricData operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getRelationalDatabaseParametersRequest * @return Result of the GetRelationalDatabaseParameters operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* Returns information about a specific database snapshot in Amazon Lightsail. *

* * @param getRelationalDatabaseSnapshotRequest * @return Result of the GetRelationalDatabaseSnapshot operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getRelationalDatabaseSnapshotsRequest * @return Result of the GetRelationalDatabaseSnapshots operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* Returns information about all of your databases in Amazon Lightsail. *

* * @param getRelationalDatabasesRequest * @return Result of the GetRelationalDatabases operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* Returns information about an Amazon Lightsail static IP. *

* * @param getStaticIpRequest * @return Result of the GetStaticIp operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param getStaticIpsRequest * @return Result of the GetStaticIps operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* Imports a public SSH key from a specific key pair. *

* * @param importKeyPairRequest * @return Result of the ImportKeyPair operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param isVpcPeeredRequest * @return Result of the IsVpcPeered operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param openInstancePublicPortsRequest * @return Result of the OpenInstancePublicPorts operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param peerVpcRequest * @return Result of the PeerVpc operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

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

* * @param putAlarmRequest * @return Result of the PutAlarm operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws OperationFailureException * Lightsail throws this exception when an operation fails to execute. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @sample AmazonLightsail.PutAlarm * @see AWS API * Documentation */ PutAlarmResult putAlarm(PutAlarmRequest putAlarmRequest); /** *

* Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the * instance through the ports, and the protocol. This action also closes all currently open ports that are not * included in the request. Include all of the ports and the protocols you want to open in your * PutInstancePublicPortsrequest. Or use the OpenInstancePublicPorts action to open ports * without closing currently open ports. *

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

* * @param putInstancePublicPortsRequest * @return Result of the PutInstancePublicPorts operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param rebootInstanceRequest * @return Result of the RebootInstance operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param rebootRelationalDatabaseRequest * @return Result of the RebootRelationalDatabase operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* Registers a container image to your Amazon Lightsail container service. *

* *

* * * @param registerContainerImageRequest * @return Result of the RegisterContainerImage operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.RegisterContainerImage * @see AWS API Documentation */ RegisterContainerImageResult registerContainerImage(RegisterContainerImageRequest registerContainerImageRequest); /** *

* Deletes a specific static IP from your account. *

* * @param releaseStaticIpRequest * @return Result of the ReleaseStaticIp operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param resetDistributionCacheRequest * @return Result of the ResetDistributionCache operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * * @param sendContactMethodVerificationRequest * @return Result of the SendContactMethodVerification operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws OperationFailureException * Lightsail throws this exception when an operation fails to execute. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @sample AmazonLightsail.SendContactMethodVerification * @see AWS API Documentation */ SendContactMethodVerificationResult sendContactMethodVerification(SendContactMethodVerificationRequest sendContactMethodVerificationRequest); /** *

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

* * @param setIpAddressTypeRequest * @return Result of the SetIpAddressType operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param setResourceAccessForBucketRequest * @return Result of the SetResourceAccessForBucket operation returned by the service. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws ServiceException * A general service exception. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.SetResourceAccessForBucket * @see AWS API Documentation */ SetResourceAccessForBucketResult setResourceAccessForBucket(SetResourceAccessForBucketRequest setResourceAccessForBucketRequest); /** *

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

* * @param startGUISessionRequest * @return Result of the StartGUISession operation returned by the service. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws ServiceException * A general service exception. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.StartGUISession * @see AWS API * Documentation */ StartGUISessionResult startGUISession(StartGUISessionRequest startGUISessionRequest); /** *

* Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the * reboot instance operation. *

* *

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

* *

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

* * @param startInstanceRequest * @return Result of the StartInstance operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param startRelationalDatabaseRequest * @return Result of the StartRelationalDatabase operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param stopGUISessionRequest * @return Result of the StopGUISession operation returned by the service. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws ServiceException * A general service exception. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.StopGUISession * @see AWS API * Documentation */ StopGUISessionResult stopGUISession(StopGUISessionRequest stopGUISessionRequest); /** *

* Stops a specific Amazon Lightsail instance that is currently running. *

* *

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

* * @param stopInstanceRequest * @return Result of the StopInstance operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param stopRelationalDatabaseRequest * @return Result of the StopRelationalDatabase operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

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

* * @param tagResourceRequest * @return Result of the TagResource operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param testAlarmRequest * @return Result of the TestAlarm operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws OperationFailureException * Lightsail throws this exception when an operation fails to execute. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @sample AmazonLightsail.TestAlarm * @see AWS API * Documentation */ TestAlarmResult testAlarm(TestAlarmRequest testAlarmRequest); /** *

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

* * @param unpeerVpcRequest * @return Result of the UnpeerVpc operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param untagResourceRequest * @return Result of the UntagResource operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param updateBucketRequest * @return Result of the UpdateBucket operation returned by the service. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws ServiceException * A general service exception. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.UpdateBucket * @see AWS API * Documentation */ UpdateBucketResult updateBucket(UpdateBucketRequest updateBucketRequest); /** *

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

* * @param updateBucketBundleRequest * @return Result of the UpdateBucketBundle operation returned by the service. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws ServiceException * A general service exception. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.UpdateBucketBundle * @see AWS * API Documentation */ UpdateBucketBundleResult updateBucketBundle(UpdateBucketBundleRequest updateBucketBundleRequest); /** *

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

* * @param updateContainerServiceRequest * @return Result of the UpdateContainerService operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.UpdateContainerService * @see AWS API Documentation */ UpdateContainerServiceResult updateContainerService(UpdateContainerServiceRequest updateContainerServiceRequest); /** *

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

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

* * @param updateDistributionRequest * @return Result of the UpdateDistribution operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param updateDistributionBundleRequest * @return Result of the UpdateDistributionBundle operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param updateDomainEntryRequest * @return Result of the UpdateDomainEntry operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* Modifies the Amazon Lightsail instance metadata parameters on a running or stopped instance. When you modify the * parameters on a running instance, the GetInstance or GetInstances API operation * initially responds with a state of pending. After the parameter modifications are successfully * applied, the state changes to applied in subsequent GetInstance or * GetInstances API calls. For more information, see Use IMDSv2 with an Amazon Lightsail instance in the Amazon Lightsail Developer Guide. *

* * @param updateInstanceMetadataOptionsRequest * @return Result of the UpdateInstanceMetadataOptions operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param updateLoadBalancerAttributeRequest * @return Result of the UpdateLoadBalancerAttribute operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param updateRelationalDatabaseRequest * @return Result of the UpdateRelationalDatabase operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

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

* * @param updateRelationalDatabaseParametersRequest * @return Result of the UpdateRelationalDatabaseParameters operation returned by the service. * @throws ServiceException * A general service exception. * @throws InvalidInputException * Lightsail throws this exception when user input does not conform to the validation rules of an input * field.

* @throws NotFoundException * Lightsail throws this exception when it cannot find a resource. * @throws OperationFailureException * Lightsail throws this exception when an operation fails to execute. * @throws AccessDeniedException * Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to * access a resource. * @throws AccountSetupInProgressException * Lightsail throws this exception when an account is still in the setup in progress state. * @throws UnauthenticatedException * Lightsail throws this exception when the user has not been authenticated. * @sample AmazonLightsail.UpdateRelationalDatabaseParameters * @see AWS API Documentation */ UpdateRelationalDatabaseParametersResult updateRelationalDatabaseParameters( UpdateRelationalDatabaseParametersRequest updateRelationalDatabaseParametersRequest); /** * Shuts down this client object, releasing any resources that might be held open. This is an optional method, and * callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client * has been shutdown, it should not be used to make any more requests. */ void shutdown(); /** * Returns additional metadata for a previously executed successful request, typically used for debugging issues * where a service isn't acting as expected. This data isn't considered part of the result data returned by an * operation, so it's available through this separate, diagnostic interface. *

* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic * information for an executed request, you should use this method to retrieve it as soon as possible after * executing a request. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }