AmazonLightsail (AWS SDK for Java

All Known Subinterfaces:

AmazonLightsailAsync

All Known Implementing Classes:

AbstractAmazonLightsail, AbstractAmazonLightsailAsync, AmazonLightsailAsyncClient, AmazonLightsailClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonLightsail
```
Interface for accessing Amazon Lightsail.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonLightsail instead.

Amazon Lightsail is the easiest way to get started with AWS for developers who just need virtual private servers. Lightsail includes everything you need to launch your project quickly - a virtual machine, SSD-based storage, data transfer, DNS management, and a static IP - for a low, predictable price. You manage those Lightsail servers through the Lightsail console or by using the API or command-line interface (CLI).

For more information about Lightsail concepts and tasks, see the Lightsail Dev Guide.

To use the Lightsail API or the CLI, you will need to use AWS Identity and Access Management (IAM) to generate access keys. For details about how to set this up, see the Lightsail Dev Guide.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`AllocateStaticIpResult`	`allocateStaticIp(AllocateStaticIpRequest allocateStaticIpRequest)` Allocates a static IP address.
`AttachDiskResult`	`attachDisk(AttachDiskRequest attachDiskRequest)` Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.
`AttachInstancesToLoadBalancerResult`	`attachInstancesToLoadBalancer(AttachInstancesToLoadBalancerRequest attachInstancesToLoadBalancerRequest)` Attaches one or more Lightsail instances to a load balancer.
`AttachLoadBalancerTlsCertificateResult`	`attachLoadBalancerTlsCertificate(AttachLoadBalancerTlsCertificateRequest attachLoadBalancerTlsCertificateRequest)` Attaches a Transport Layer Security (TLS) certificate to your load balancer.
`AttachStaticIpResult`	`attachStaticIp(AttachStaticIpRequest attachStaticIpRequest)` Attaches a static IP address to a specific Amazon Lightsail instance.
`CloseInstancePublicPortsResult`	`closeInstancePublicPorts(CloseInstancePublicPortsRequest closeInstancePublicPortsRequest)` Closes the public ports on a specific Amazon Lightsail instance.
`CreateDiskResult`	`createDisk(CreateDiskRequest createDiskRequest)` Creates a block storage disk that can be attached to a Lightsail instance in the same Availability Zone (e.g., `us-east-2a`).
`CreateDiskFromSnapshotResult`	`createDiskFromSnapshot(CreateDiskFromSnapshotRequest createDiskFromSnapshotRequest)` Creates a block storage disk from a disk snapshot that can be attached to a Lightsail instance in the same Availability Zone (e.g., `us-east-2a`).
`CreateDiskSnapshotResult`	`createDiskSnapshot(CreateDiskSnapshotRequest createDiskSnapshotRequest)` Creates a snapshot of a block storage disk.
`CreateDomainResult`	`createDomain(CreateDomainRequest createDomainRequest)` Creates a domain resource for the specified domain (e.g., example.com).
`CreateDomainEntryResult`	`createDomainEntry(CreateDomainEntryRequest createDomainEntryRequest)` Creates one of the following entry records associated with the domain: A record, CNAME record, TXT record, or MX record.
`CreateInstancesResult`	`createInstances(CreateInstancesRequest createInstancesRequest)` Creates one or more Amazon Lightsail virtual private servers, or instances.
`CreateInstancesFromSnapshotResult`	`createInstancesFromSnapshot(CreateInstancesFromSnapshotRequest createInstancesFromSnapshotRequest)` Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical configuration.
`CreateInstanceSnapshotResult`	`createInstanceSnapshot(CreateInstanceSnapshotRequest createInstanceSnapshotRequest)` Creates a snapshot of a specific virtual private server, or instance.
`CreateKeyPairResult`	`createKeyPair(CreateKeyPairRequest createKeyPairRequest)` Creates sn SSH key pair.
`CreateLoadBalancerResult`	`createLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest)` Creates a Lightsail load balancer.
`CreateLoadBalancerTlsCertificateResult`	`createLoadBalancerTlsCertificate(CreateLoadBalancerTlsCertificateRequest createLoadBalancerTlsCertificateRequest)` Creates a Lightsail load balancer TLS certificate.
`DeleteDiskResult`	`deleteDisk(DeleteDiskRequest deleteDiskRequest)` Deletes the specified block storage disk.
`DeleteDiskSnapshotResult`	`deleteDiskSnapshot(DeleteDiskSnapshotRequest deleteDiskSnapshotRequest)` Deletes the specified disk snapshot.
`DeleteDomainResult`	`deleteDomain(DeleteDomainRequest deleteDomainRequest)` Deletes the specified domain recordset and all of its domain records.
`DeleteDomainEntryResult`	`deleteDomainEntry(DeleteDomainEntryRequest deleteDomainEntryRequest)` Deletes a specific domain entry.
`DeleteInstanceResult`	`deleteInstance(DeleteInstanceRequest deleteInstanceRequest)` Deletes a specific Amazon Lightsail virtual private server, or instance.
`DeleteInstanceSnapshotResult`	`deleteInstanceSnapshot(DeleteInstanceSnapshotRequest deleteInstanceSnapshotRequest)` Deletes a specific snapshot of a virtual private server (or instance).
`DeleteKeyPairResult`	`deleteKeyPair(DeleteKeyPairRequest deleteKeyPairRequest)` Deletes a specific SSH key pair.
`DeleteLoadBalancerResult`	`deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest)` Deletes a Lightsail load balancer and all its associated SSL/TLS certificates.
`DeleteLoadBalancerTlsCertificateResult`	`deleteLoadBalancerTlsCertificate(DeleteLoadBalancerTlsCertificateRequest deleteLoadBalancerTlsCertificateRequest)` Deletes an SSL/TLS certificate associated with a Lightsail load balancer.
`DetachDiskResult`	`detachDisk(DetachDiskRequest detachDiskRequest)` Detaches a stopped block storage disk from a Lightsail instance.
`DetachInstancesFromLoadBalancerResult`	`detachInstancesFromLoadBalancer(DetachInstancesFromLoadBalancerRequest detachInstancesFromLoadBalancerRequest)` Detaches the specified instances from a Lightsail load balancer.
`DetachStaticIpResult`	`detachStaticIp(DetachStaticIpRequest detachStaticIpRequest)` Detaches a static IP from the Amazon Lightsail instance to which it is attached.
`DownloadDefaultKeyPairResult`	`downloadDefaultKeyPair(DownloadDefaultKeyPairRequest downloadDefaultKeyPairRequest)` Downloads the default SSH key pair from the user's account.
`GetActiveNamesResult`	`getActiveNames(GetActiveNamesRequest getActiveNamesRequest)` Returns the names of all active (not deleted) resources.
`GetBlueprintsResult`	`getBlueprints(GetBlueprintsRequest getBlueprintsRequest)` Returns the list of available instance images, or blueprints.
`GetBundlesResult`	`getBundles(GetBundlesRequest getBundlesRequest)` Returns the list of bundles that are available for purchase.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetDiskResult`	`getDisk(GetDiskRequest getDiskRequest)` Returns information about a specific block storage disk.
`GetDisksResult`	`getDisks(GetDisksRequest getDisksRequest)` Returns information about all block storage disks in your AWS account and region.
`GetDiskSnapshotResult`	`getDiskSnapshot(GetDiskSnapshotRequest getDiskSnapshotRequest)` Returns information about a specific block storage disk snapshot.
`GetDiskSnapshotsResult`	`getDiskSnapshots(GetDiskSnapshotsRequest getDiskSnapshotsRequest)` Returns information about all block storage disk snapshots in your AWS account and region.
`GetDomainResult`	`getDomain(GetDomainRequest getDomainRequest)` Returns information about a specific domain recordset.
`GetDomainsResult`	`getDomains(GetDomainsRequest getDomainsRequest)` Returns a list of all domains in the user's account.
`GetInstanceResult`	`getInstance(GetInstanceRequest getInstanceRequest)` Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
`GetInstanceAccessDetailsResult`	`getInstanceAccessDetails(GetInstanceAccessDetailsRequest getInstanceAccessDetailsRequest)` Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
`GetInstanceMetricDataResult`	`getInstanceMetricData(GetInstanceMetricDataRequest getInstanceMetricDataRequest)` Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
`GetInstancePortStatesResult`	`getInstancePortStates(GetInstancePortStatesRequest getInstancePortStatesRequest)` Returns the port states for a specific virtual private server, or instance.
`GetInstancesResult`	`getInstances(GetInstancesRequest getInstancesRequest)` Returns information about all Amazon Lightsail virtual private servers, or instances.
`GetInstanceSnapshotResult`	`getInstanceSnapshot(GetInstanceSnapshotRequest getInstanceSnapshotRequest)` Returns information about a specific instance snapshot.
`GetInstanceSnapshotsResult`	`getInstanceSnapshots(GetInstanceSnapshotsRequest getInstanceSnapshotsRequest)` Returns all instance snapshots for the user's account.
`GetInstanceStateResult`	`getInstanceState(GetInstanceStateRequest getInstanceStateRequest)` Returns the state of a specific instance.
`GetKeyPairResult`	`getKeyPair(GetKeyPairRequest getKeyPairRequest)` Returns information about a specific key pair.
`GetKeyPairsResult`	`getKeyPairs(GetKeyPairsRequest getKeyPairsRequest)` Returns information about all key pairs in the user's account.
`GetLoadBalancerResult`	`getLoadBalancer(GetLoadBalancerRequest getLoadBalancerRequest)` Returns information about the specified Lightsail load balancer.
`GetLoadBalancerMetricDataResult`	`getLoadBalancerMetricData(GetLoadBalancerMetricDataRequest getLoadBalancerMetricDataRequest)` Returns information about health metrics for your Lightsail load balancer.
`GetLoadBalancersResult`	`getLoadBalancers(GetLoadBalancersRequest getLoadBalancersRequest)` Returns information about all load balancers in an account.
`GetLoadBalancerTlsCertificatesResult`	`getLoadBalancerTlsCertificates(GetLoadBalancerTlsCertificatesRequest getLoadBalancerTlsCertificatesRequest)` Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.
`GetOperationResult`	`getOperation(GetOperationRequest getOperationRequest)` Returns information about a specific operation.
`GetOperationsResult`	`getOperations(GetOperationsRequest getOperationsRequest)` Returns information about all operations.
`GetOperationsForResourceResult`	`getOperationsForResource(GetOperationsForResourceRequest getOperationsForResourceRequest)` Gets operations for a specific resource (e.g., an instance or a static IP).
`GetRegionsResult`	`getRegions(GetRegionsRequest getRegionsRequest)` Returns a list of all valid regions for Amazon Lightsail.
`GetStaticIpResult`	`getStaticIp(GetStaticIpRequest getStaticIpRequest)` Returns information about a specific static IP.
`GetStaticIpsResult`	`getStaticIps(GetStaticIpsRequest getStaticIpsRequest)` Returns information about all static IPs in the user's account.
`ImportKeyPairResult`	`importKeyPair(ImportKeyPairRequest importKeyPairRequest)` Imports a public SSH key from a specific key pair.
`IsVpcPeeredResult`	`isVpcPeered(IsVpcPeeredRequest isVpcPeeredRequest)` Returns a Boolean value indicating whether your Lightsail VPC is peered.
`OpenInstancePublicPortsResult`	`openInstancePublicPorts(OpenInstancePublicPortsRequest openInstancePublicPortsRequest)` Adds public ports to an Amazon Lightsail instance.
`PeerVpcResult`	`peerVpc(PeerVpcRequest peerVpcRequest)` Tries to peer the Lightsail VPC with the user's default VPC.
`PutInstancePublicPortsResult`	`putInstancePublicPorts(PutInstancePublicPortsRequest putInstancePublicPortsRequest)` Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not included in the current request.
`RebootInstanceResult`	`rebootInstance(RebootInstanceRequest rebootInstanceRequest)` Restarts a specific instance.
`ReleaseStaticIpResult`	`releaseStaticIp(ReleaseStaticIpRequest releaseStaticIpRequest)` Deletes a specific static IP from your account.
`void`	`setEndpoint(String endpoint)` Deprecated. use `AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)` for example: `builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));`
`void`	`setRegion(Region region)` Deprecated. use `AwsClientBuilder#setRegion(String)`
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartInstanceResult`	`startInstance(StartInstanceRequest startInstanceRequest)` Starts a specific Amazon Lightsail instance from a stopped state.
`StopInstanceResult`	`stopInstance(StopInstanceRequest stopInstanceRequest)` Stops a specific Amazon Lightsail instance that is currently running.
`UnpeerVpcResult`	`unpeerVpc(UnpeerVpcRequest unpeerVpcRequest)` Attempts to unpeer the Lightsail VPC from the user's default VPC.
`UpdateDomainEntryResult`	`updateDomainEntry(UpdateDomainEntryRequest updateDomainEntryRequest)` Updates a domain recordset after it is created.
`UpdateLoadBalancerAttributeResult`	`updateLoadBalancerAttribute(UpdateLoadBalancerAttributeRequest updateLoadBalancerAttributeRequest)` Updates the specified attribute for a load balancer.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    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 Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - setEndpoint
```
@Deprecated
void setEndpoint(String endpoint)
```
    Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
    
    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 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.
    
    Parameters:
    
    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.
  - setRegion
```
@Deprecated
void setRegion(Region region)
```
    Deprecated. use AwsClientBuilder#setRegion(String)
    
    An alternative to 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 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.
    
    Parameters:
    
    region - The region this client will communicate with. See 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 Also:
    
    Region#getRegion(com.amazonaws.regions.Regions), Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - allocateStaticIp
```
AllocateStaticIpResult allocateStaticIp(AllocateStaticIpRequest allocateStaticIpRequest)
```
    Allocates a static IP address.
    
    Parameters:
    
    allocateStaticIpRequest -
    
    Returns:
    
    Result of the AllocateStaticIp operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - attachDisk
```
AttachDiskResult attachDisk(AttachDiskRequest attachDiskRequest)
```
    Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.
    
    Parameters:
    
    attachDiskRequest -
    
    Returns:
    
    Result of the AttachDisk operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - attachInstancesToLoadBalancer
```
AttachInstancesToLoadBalancerResult attachInstancesToLoadBalancer(AttachInstancesToLoadBalancerRequest attachInstancesToLoadBalancerRequest)
```
    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.
    
    Parameters:
    
    attachInstancesToLoadBalancerRequest -
    
    Returns:
    
    Result of the AttachInstancesToLoadBalancer operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - attachLoadBalancerTlsCertificate
```
AttachLoadBalancerTlsCertificateResult attachLoadBalancerTlsCertificate(AttachLoadBalancerTlsCertificateRequest attachLoadBalancerTlsCertificateRequest)
```
    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 operation with the non-attached certificate, and it will replace the existing one and become the attached certificate.
    
    Parameters:
    
    attachLoadBalancerTlsCertificateRequest -
    
    Returns:
    
    Result of the AttachLoadBalancerTlsCertificate operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - attachStaticIp
```
AttachStaticIpResult attachStaticIp(AttachStaticIpRequest attachStaticIpRequest)
```
    Attaches a static IP address to a specific Amazon Lightsail instance.
    
    Parameters:
    
    attachStaticIpRequest -
    
    Returns:
    
    Result of the AttachStaticIp operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - closeInstancePublicPorts
```
CloseInstancePublicPortsResult closeInstancePublicPorts(CloseInstancePublicPortsRequest closeInstancePublicPortsRequest)
```
    Closes the public ports on a specific Amazon Lightsail instance.
    
    Parameters:
    
    closeInstancePublicPortsRequest -
    
    Returns:
    
    Result of the CloseInstancePublicPorts operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - createDisk
```
CreateDiskResult createDisk(CreateDiskRequest createDiskRequest)
```
    Creates a block storage disk that can be attached to a Lightsail instance in the same Availability Zone (e.g., us-east-2a). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see Regions and Availability Zones in Lightsail.
    
    Parameters:
    
    createDiskRequest -
    
    Returns:
    
    Result of the CreateDisk operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - createDiskFromSnapshot
```
CreateDiskFromSnapshotResult createDiskFromSnapshot(CreateDiskFromSnapshotRequest createDiskFromSnapshotRequest)
```
    Creates a block storage disk from a disk snapshot that can be attached to a Lightsail instance in the same Availability Zone (e.g., us-east-2a). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see Regions and Availability Zones in Lightsail.
    
    Parameters:
    
    createDiskFromSnapshotRequest -
    
    Returns:
    
    Result of the CreateDiskFromSnapshot operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - createDiskSnapshot
```
CreateDiskSnapshotResult createDiskSnapshot(CreateDiskSnapshotRequest createDiskSnapshotRequest)
```
    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.
    
    Parameters:
    
    createDiskSnapshotRequest -
    
    Returns:
    
    Result of the CreateDiskSnapshot operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - createDomain
```
CreateDomainResult createDomain(CreateDomainRequest createDomainRequest)
```
    Creates a domain resource for the specified domain (e.g., example.com).
    
    Parameters:
    
    createDomainRequest -
    
    Returns:
    
    Result of the CreateDomain operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - createDomainEntry
```
CreateDomainEntryResult createDomainEntry(CreateDomainEntryRequest createDomainEntryRequest)
```
    Creates one of the following entry records associated with the domain: A record, CNAME record, TXT record, or MX record.
    
    Parameters:
    
    createDomainEntryRequest -
    
    Returns:
    
    Result of the CreateDomainEntry operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - createInstanceSnapshot
```
CreateInstanceSnapshotResult createInstanceSnapshot(CreateInstanceSnapshotRequest createInstanceSnapshotRequest)
```
    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.
    
    Parameters:
    
    createInstanceSnapshotRequest -
    
    Returns:
    
    Result of the CreateInstanceSnapshot operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - createInstances
```
CreateInstancesResult createInstances(CreateInstancesRequest createInstancesRequest)
```
    Creates one or more Amazon Lightsail virtual private servers, or instances.
    
    Parameters:
    
    createInstancesRequest -
    
    Returns:
    
    Result of the CreateInstances operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - createInstancesFromSnapshot
```
CreateInstancesFromSnapshotResult createInstancesFromSnapshot(CreateInstancesFromSnapshotRequest createInstancesFromSnapshotRequest)
```
    Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical configuration.
    
    Parameters:
    
    createInstancesFromSnapshotRequest -
    
    Returns:
    
    Result of the CreateInstancesFromSnapshot operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - createKeyPair
```
CreateKeyPairResult createKeyPair(CreateKeyPairRequest createKeyPairRequest)
```
    Creates sn SSH key pair.
    
    Parameters:
    
    createKeyPairRequest -
    
    Returns:
    
    Result of the CreateKeyPair operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - createLoadBalancer
```
CreateLoadBalancerResult createLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest)
```
    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.
    
    Parameters:
    
    createLoadBalancerRequest -
    
    Returns:
    
    Result of the CreateLoadBalancer operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - createLoadBalancerTlsCertificate
```
CreateLoadBalancerTlsCertificateResult createLoadBalancerTlsCertificate(CreateLoadBalancerTlsCertificateRequest createLoadBalancerTlsCertificateRequest)
```
    Creates a Lightsail load balancer TLS certificate.
    
    TLS is just an updated, more secure version of Secure Socket Layer (SSL).
    
    Parameters:
    
    createLoadBalancerTlsCertificateRequest -
    
    Returns:
    
    Result of the CreateLoadBalancerTlsCertificate operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - deleteDisk
```
DeleteDiskResult deleteDisk(DeleteDiskRequest deleteDiskRequest)
```
    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.
    
    Parameters:
    
    deleteDiskRequest -
    
    Returns:
    
    Result of the DeleteDisk operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - deleteDiskSnapshot
```
DeleteDiskSnapshotResult deleteDiskSnapshot(DeleteDiskSnapshotRequest deleteDiskSnapshotRequest)
```
    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.
    
    Parameters:
    
    deleteDiskSnapshotRequest -
    
    Returns:
    
    Result of the DeleteDiskSnapshot operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - deleteDomain
```
DeleteDomainResult deleteDomain(DeleteDomainRequest deleteDomainRequest)
```
    Deletes the specified domain recordset and all of its domain records.
    
    Parameters:
    
    deleteDomainRequest -
    
    Returns:
    
    Result of the DeleteDomain operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - deleteDomainEntry
```
DeleteDomainEntryResult deleteDomainEntry(DeleteDomainEntryRequest deleteDomainEntryRequest)
```
    Deletes a specific domain entry.
    
    Parameters:
    
    deleteDomainEntryRequest -
    
    Returns:
    
    Result of the DeleteDomainEntry operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - deleteInstance
```
DeleteInstanceResult deleteInstance(DeleteInstanceRequest deleteInstanceRequest)
```
    Deletes a specific Amazon Lightsail virtual private server, or instance.
    
    Parameters:
    
    deleteInstanceRequest -
    
    Returns:
    
    Result of the DeleteInstance operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - deleteInstanceSnapshot
```
DeleteInstanceSnapshotResult deleteInstanceSnapshot(DeleteInstanceSnapshotRequest deleteInstanceSnapshotRequest)
```
    Deletes a specific snapshot of a virtual private server (or instance).
    
    Parameters:
    
    deleteInstanceSnapshotRequest -
    
    Returns:
    
    Result of the DeleteInstanceSnapshot operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - deleteKeyPair
```
DeleteKeyPairResult deleteKeyPair(DeleteKeyPairRequest deleteKeyPairRequest)
```
    Deletes a specific SSH key pair.
    
    Parameters:
    
    deleteKeyPairRequest -
    
    Returns:
    
    Result of the DeleteKeyPair operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - deleteLoadBalancer
```
DeleteLoadBalancerResult deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest)
```
    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.
    
    Parameters:
    
    deleteLoadBalancerRequest -
    
    Returns:
    
    Result of the DeleteLoadBalancer operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - deleteLoadBalancerTlsCertificate
```
DeleteLoadBalancerTlsCertificateResult deleteLoadBalancerTlsCertificate(DeleteLoadBalancerTlsCertificateRequest deleteLoadBalancerTlsCertificateRequest)
```
    Deletes an SSL/TLS certificate associated with a Lightsail load balancer.
    
    Parameters:
    
    deleteLoadBalancerTlsCertificateRequest -
    
    Returns:
    
    Result of the DeleteLoadBalancerTlsCertificate operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - detachDisk
```
DetachDiskResult detachDisk(DetachDiskRequest detachDiskRequest)
```
    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.
    
    Parameters:
    
    detachDiskRequest -
    
    Returns:
    
    Result of the DetachDisk operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - detachInstancesFromLoadBalancer
```
DetachInstancesFromLoadBalancerResult detachInstancesFromLoadBalancer(DetachInstancesFromLoadBalancerRequest detachInstancesFromLoadBalancerRequest)
```
    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.
    
    Parameters:
    
    detachInstancesFromLoadBalancerRequest -
    
    Returns:
    
    Result of the DetachInstancesFromLoadBalancer operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - detachStaticIp
```
DetachStaticIpResult detachStaticIp(DetachStaticIpRequest detachStaticIpRequest)
```
    Detaches a static IP from the Amazon Lightsail instance to which it is attached.
    
    Parameters:
    
    detachStaticIpRequest -
    
    Returns:
    
    Result of the DetachStaticIp operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - downloadDefaultKeyPair
```
DownloadDefaultKeyPairResult downloadDefaultKeyPair(DownloadDefaultKeyPairRequest downloadDefaultKeyPairRequest)
```
    Downloads the default SSH key pair from the user's account.
    
    Parameters:
    
    downloadDefaultKeyPairRequest -
    
    Returns:
    
    Result of the DownloadDefaultKeyPair operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - getActiveNames
```
GetActiveNamesResult getActiveNames(GetActiveNamesRequest getActiveNamesRequest)
```
    Returns the names of all active (not deleted) resources.
    
    Parameters:
    
    getActiveNamesRequest -
    
    Returns:
    
    Result of the GetActiveNames operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - getBlueprints
```
GetBlueprintsResult getBlueprints(GetBlueprintsRequest getBlueprintsRequest)
```
    Returns the list of available instance images, or blueprints. You can use a blueprint to create a new virtual private server 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.
    
    Parameters:
    
    getBlueprintsRequest -
    
    Returns:
    
    Result of the GetBlueprints operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - getBundles
```
GetBundlesResult getBundles(GetBundlesRequest getBundlesRequest)
```
    Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance).
    
    Parameters:
    
    getBundlesRequest -
    
    Returns:
    
    Result of the GetBundles operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - getDisk
```
GetDiskResult getDisk(GetDiskRequest getDiskRequest)
```
    Returns information about a specific block storage disk.
    
    Parameters:
    
    getDiskRequest -
    
    Returns:
    
    Result of the GetDisk operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - getDiskSnapshot
```
GetDiskSnapshotResult getDiskSnapshot(GetDiskSnapshotRequest getDiskSnapshotRequest)
```
    Returns information about a specific block storage disk snapshot.
    
    Parameters:
    
    getDiskSnapshotRequest -
    
    Returns:
    
    Result of the GetDiskSnapshot operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - getDiskSnapshots
```
GetDiskSnapshotsResult getDiskSnapshots(GetDiskSnapshotsRequest getDiskSnapshotsRequest)
```
    Returns information about all block storage disk snapshots in your AWS account and region.
    
    If you are describing a long list of disk snapshots, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
    
    Parameters:
    
    getDiskSnapshotsRequest -
    
    Returns:
    
    Result of the GetDiskSnapshots operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - getDisks
```
GetDisksResult getDisks(GetDisksRequest getDisksRequest)
```
    Returns information about all block storage disks in your AWS account and region.
    
    If you are describing a long list of disks, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
    
    Parameters:
    
    getDisksRequest -
    
    Returns:
    
    Result of the GetDisks operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - getDomain
```
GetDomainResult getDomain(GetDomainRequest getDomainRequest)
```
    Returns information about a specific domain recordset.
    
    Parameters:
    
    getDomainRequest -
    
    Returns:
    
    Result of the GetDomain operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - getDomains
```
GetDomainsResult getDomains(GetDomainsRequest getDomainsRequest)
```
    Returns a list of all domains in the user's account.
    
    Parameters:
    
    getDomainsRequest -
    
    Returns:
    
    Result of the GetDomains operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - getInstance
```
GetInstanceResult getInstance(GetInstanceRequest getInstanceRequest)
```
    Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
    
    Parameters:
    
    getInstanceRequest -
    
    Returns:
    
    Result of the GetInstance operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - getInstanceAccessDetails
```
GetInstanceAccessDetailsResult getInstanceAccessDetails(GetInstanceAccessDetailsRequest getInstanceAccessDetailsRequest)
```
    Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
    
    Parameters:
    
    getInstanceAccessDetailsRequest -
    
    Returns:
    
    Result of the GetInstanceAccessDetails operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - getInstanceMetricData
```
GetInstanceMetricDataResult getInstanceMetricData(GetInstanceMetricDataRequest getInstanceMetricDataRequest)
```
    Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
    
    Parameters:
    
    getInstanceMetricDataRequest -
    
    Returns:
    
    Result of the GetInstanceMetricData operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - getInstancePortStates
```
GetInstancePortStatesResult getInstancePortStates(GetInstancePortStatesRequest getInstancePortStatesRequest)
```
    Returns the port states for a specific virtual private server, or instance.
    
    Parameters:
    
    getInstancePortStatesRequest -
    
    Returns:
    
    Result of the GetInstancePortStates operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - getInstanceSnapshot
```
GetInstanceSnapshotResult getInstanceSnapshot(GetInstanceSnapshotRequest getInstanceSnapshotRequest)
```
    Returns information about a specific instance snapshot.
    
    Parameters:
    
    getInstanceSnapshotRequest -
    
    Returns:
    
    Result of the GetInstanceSnapshot operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - getInstanceSnapshots
```
GetInstanceSnapshotsResult getInstanceSnapshots(GetInstanceSnapshotsRequest getInstanceSnapshotsRequest)
```
    Returns all instance snapshots for the user's account.
    
    Parameters:
    
    getInstanceSnapshotsRequest -
    
    Returns:
    
    Result of the GetInstanceSnapshots operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - getInstanceState
```
GetInstanceStateResult getInstanceState(GetInstanceStateRequest getInstanceStateRequest)
```
    Returns the state of a specific instance. Works on one instance at a time.
    
    Parameters:
    
    getInstanceStateRequest -
    
    Returns:
    
    Result of the GetInstanceState operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - getInstances
```
GetInstancesResult getInstances(GetInstancesRequest getInstancesRequest)
```
    Returns information about all Amazon Lightsail virtual private servers, or instances.
    
    Parameters:
    
    getInstancesRequest -
    
    Returns:
    
    Result of the GetInstances operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - getKeyPair
```
GetKeyPairResult getKeyPair(GetKeyPairRequest getKeyPairRequest)
```
    Returns information about a specific key pair.
    
    Parameters:
    
    getKeyPairRequest -
    
    Returns:
    
    Result of the GetKeyPair operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - getKeyPairs
```
GetKeyPairsResult getKeyPairs(GetKeyPairsRequest getKeyPairsRequest)
```
    Returns information about all key pairs in the user's account.
    
    Parameters:
    
    getKeyPairsRequest -
    
    Returns:
    
    Result of the GetKeyPairs operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - getLoadBalancer
```
GetLoadBalancerResult getLoadBalancer(GetLoadBalancerRequest getLoadBalancerRequest)
```
    Returns information about the specified Lightsail load balancer.
    
    Parameters:
    
    getLoadBalancerRequest -
    
    Returns:
    
    Result of the GetLoadBalancer operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - getLoadBalancerMetricData
```
GetLoadBalancerMetricDataResult getLoadBalancerMetricData(GetLoadBalancerMetricDataRequest getLoadBalancerMetricDataRequest)
```
    Returns information about health metrics for your Lightsail load balancer.
    
    Parameters:
    
    getLoadBalancerMetricDataRequest -
    
    Returns:
    
    Result of the GetLoadBalancerMetricData operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - getLoadBalancerTlsCertificates
```
GetLoadBalancerTlsCertificatesResult getLoadBalancerTlsCertificates(GetLoadBalancerTlsCertificatesRequest getLoadBalancerTlsCertificatesRequest)
```
    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.
    
    Parameters:
    
    getLoadBalancerTlsCertificatesRequest -
    
    Returns:
    
    Result of the GetLoadBalancerTlsCertificates operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - getLoadBalancers
```
GetLoadBalancersResult getLoadBalancers(GetLoadBalancersRequest getLoadBalancersRequest)
```
    Returns information about all load balancers in an account.
    
    If you are describing a long list of load balancers, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
    
    Parameters:
    
    getLoadBalancersRequest -
    
    Returns:
    
    Result of the GetLoadBalancers operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - getOperation
```
GetOperationResult getOperation(GetOperationRequest getOperationRequest)
```
    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.
    
    Parameters:
    
    getOperationRequest -
    
    Returns:
    
    Result of the GetOperation operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - getOperations
```
GetOperationsResult getOperations(GetOperationsRequest getOperationsRequest)
```
    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.
    
    Parameters:
    
    getOperationsRequest -
    
    Returns:
    
    Result of the GetOperations operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - getOperationsForResource
```
GetOperationsForResourceResult getOperationsForResource(GetOperationsForResourceRequest getOperationsForResourceRequest)
```
    Gets operations for a specific resource (e.g., an instance or a static IP).
    
    Parameters:
    
    getOperationsForResourceRequest -
    
    Returns:
    
    Result of the GetOperationsForResource operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - getRegions
```
GetRegionsResult getRegions(GetRegionsRequest getRegionsRequest)
```
    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.
    
    Parameters:
    
    getRegionsRequest -
    
    Returns:
    
    Result of the GetRegions operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - getStaticIp
```
GetStaticIpResult getStaticIp(GetStaticIpRequest getStaticIpRequest)
```
    Returns information about a specific static IP.
    
    Parameters:
    
    getStaticIpRequest -
    
    Returns:
    
    Result of the GetStaticIp operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - getStaticIps
```
GetStaticIpsResult getStaticIps(GetStaticIpsRequest getStaticIpsRequest)
```
    Returns information about all static IPs in the user's account.
    
    Parameters:
    
    getStaticIpsRequest -
    
    Returns:
    
    Result of the GetStaticIps operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - importKeyPair
```
ImportKeyPairResult importKeyPair(ImportKeyPairRequest importKeyPairRequest)
```
    Imports a public SSH key from a specific key pair.
    
    Parameters:
    
    importKeyPairRequest -
    
    Returns:
    
    Result of the ImportKeyPair operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - isVpcPeered
```
IsVpcPeeredResult isVpcPeered(IsVpcPeeredRequest isVpcPeeredRequest)
```
    Returns a Boolean value indicating whether your Lightsail VPC is peered.
    
    Parameters:
    
    isVpcPeeredRequest -
    
    Returns:
    
    Result of the IsVpcPeered operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - openInstancePublicPorts
```
OpenInstancePublicPortsResult openInstancePublicPorts(OpenInstancePublicPortsRequest openInstancePublicPortsRequest)
```
    Adds public ports to an Amazon Lightsail instance.
    
    Parameters:
    
    openInstancePublicPortsRequest -
    
    Returns:
    
    Result of the OpenInstancePublicPorts operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - peerVpc
```
PeerVpcResult peerVpc(PeerVpcRequest peerVpcRequest)
```
    Tries to peer the Lightsail VPC with the user's default VPC.
    
    Parameters:
    
    peerVpcRequest -
    
    Returns:
    
    Result of the PeerVpc operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - putInstancePublicPorts
```
PutInstancePublicPortsResult putInstancePublicPorts(PutInstancePublicPortsRequest putInstancePublicPortsRequest)
```
    Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not included in the current request.
    
    Parameters:
    
    putInstancePublicPortsRequest -
    
    Returns:
    
    Result of the PutInstancePublicPorts operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - rebootInstance
```
RebootInstanceResult rebootInstance(RebootInstanceRequest rebootInstanceRequest)
```
    Restarts a specific instance. When your Amazon Lightsail instance is finished rebooting, Lightsail assigns a new public IP address. To use the same IP address after restarting, create a static IP address and attach it to the instance.
    
    Parameters:
    
    rebootInstanceRequest -
    
    Returns:
    
    Result of the RebootInstance operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - releaseStaticIp
```
ReleaseStaticIpResult releaseStaticIp(ReleaseStaticIpRequest releaseStaticIpRequest)
```
    Deletes a specific static IP from your account.
    
    Parameters:
    
    releaseStaticIpRequest -
    
    Returns:
    
    Result of the ReleaseStaticIp operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - startInstance
```
StartInstanceResult startInstance(StartInstanceRequest startInstanceRequest)
```
    Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation.
    
    Parameters:
    
    startInstanceRequest -
    
    Returns:
    
    Result of the StartInstance operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - stopInstance
```
StopInstanceResult stopInstance(StopInstanceRequest stopInstanceRequest)
```
    Stops a specific Amazon Lightsail instance that is currently running.
    
    Parameters:
    
    stopInstanceRequest -
    
    Returns:
    
    Result of the StopInstance operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - unpeerVpc
```
UnpeerVpcResult unpeerVpc(UnpeerVpcRequest unpeerVpcRequest)
```
    Attempts to unpeer the Lightsail VPC from the user's default VPC.
    
    Parameters:
    
    unpeerVpcRequest -
    
    Returns:
    
    Result of the UnpeerVpc operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - updateDomainEntry
```
UpdateDomainEntryResult updateDomainEntry(UpdateDomainEntryRequest updateDomainEntryRequest)
```
    Updates a domain recordset after it is created.
    
    Parameters:
    
    updateDomainEntryRequest -
    
    Returns:
    
    Result of the UpdateDomainEntry operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - updateLoadBalancerAttribute
```
UpdateLoadBalancerAttributeResult updateLoadBalancerAttribute(UpdateLoadBalancerAttributeRequest updateLoadBalancerAttributeRequest)
```
    Updates the specified attribute for a load balancer. You can only update one attribute at a time.
    
    Parameters:
    
    updateLoadBalancerAttributeRequest -
    
    Returns:
    
    Result of the UpdateLoadBalancerAttribute operation returned by the service.
    
    Throws:
    
    ServiceException - A general service exception.
    
    InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input field.
    
    Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
    
    NotFoundException - Lightsail throws this exception when it cannot find a resource.
    
    OperationFailureException - Lightsail throws this exception when an operation fails to execute.
    
    AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
    
    AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.
    
    UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    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.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    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.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AmazonLightsail

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

setEndpoint

setRegion

allocateStaticIp

attachDisk

attachInstancesToLoadBalancer

attachLoadBalancerTlsCertificate

attachStaticIp

closeInstancePublicPorts

createDisk

createDiskFromSnapshot

createDiskSnapshot

createDomain

createDomainEntry

createInstanceSnapshot

createInstances

createInstancesFromSnapshot

createKeyPair

createLoadBalancer

createLoadBalancerTlsCertificate

deleteDisk

deleteDiskSnapshot

deleteDomain

deleteDomainEntry

deleteInstance

deleteInstanceSnapshot

deleteKeyPair

deleteLoadBalancer

deleteLoadBalancerTlsCertificate

detachDisk

detachInstancesFromLoadBalancer

detachStaticIp

downloadDefaultKeyPair

getActiveNames

getBlueprints

getBundles

getDisk

getDiskSnapshot

getDiskSnapshots

getDisks

getDomain

getDomains

getInstance

getInstanceAccessDetails

getInstanceMetricData

getInstancePortStates

getInstanceSnapshot

getInstanceSnapshots

getInstanceState

getInstances

getKeyPair

getKeyPairs

getLoadBalancer

getLoadBalancerMetricData

getLoadBalancerTlsCertificates

getLoadBalancers

getOperation

getOperations

getOperationsForResource

getRegions

getStaticIp

getStaticIps

importKeyPair

isVpcPeered

openInstancePublicPorts

peerVpc

putInstancePublicPorts

rebootInstance

releaseStaticIp

startInstance

stopInstance

unpeerVpc

updateDomainEntry

updateLoadBalancerAttribute