Package software.amazon.awssdk.services.lightsail

Interface LightsailAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface LightsailAsyncClient extends AwsClient
Service client for accessing Amazon Lightsail asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes everything you need to launch your project quickly - instances (virtual private servers), container services, storage buckets, managed databases, SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN) distributions, DNS management of registered domains, and resource snapshots (backups) - for a low, predictable monthly price.

You can manage your Lightsail resources using the Lightsail console, Lightsail API, Command Line Interface (CLI), or SDKs. For more information about Lightsail concepts and tasks, see the Amazon Lightsail Developer Guide.

This API Reference provides detailed information about the actions, data types, parameters, and errors of the Lightsail service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see Amazon Lightsail Endpoints and Quotas in the Amazon Web Services General Reference.

  • Field Details

  • Method Details

    • allocateStaticIp

      default CompletableFuture<AllocateStaticIpResponse> allocateStaticIp(AllocateStaticIpRequest allocateStaticIpRequest)

      Allocates a static IP address.

      Parameters:
      allocateStaticIpRequest -
      Returns:
      A Java Future containing the result of the AllocateStaticIp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • allocateStaticIp

      default CompletableFuture<AllocateStaticIpResponse> allocateStaticIp(Consumer<AllocateStaticIpRequest.Builder> allocateStaticIpRequest)

      Allocates a static IP address.


      This is a convenience which creates an instance of the AllocateStaticIpRequest.Builder avoiding the need to create one manually via AllocateStaticIpRequest.builder()

      Parameters:
      allocateStaticIpRequest - A Consumer that will call methods on AllocateStaticIpRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AllocateStaticIp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • attachCertificateToDistribution

      default CompletableFuture<AttachCertificateToDistributionResponse> attachCertificateToDistribution(AttachCertificateToDistributionRequest attachCertificateToDistributionRequest)

      Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.

      After the certificate is attached, your distribution accepts HTTPS traffic for all of the domains that are associated with the certificate.

      Use the CreateCertificate action to create a certificate that you can attach to your distribution.

      Only certificates created in the us-east-1 Amazon Web Services Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.

      Parameters:
      attachCertificateToDistributionRequest -
      Returns:
      A Java Future containing the result of the AttachCertificateToDistribution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • attachCertificateToDistribution

      default CompletableFuture<AttachCertificateToDistributionResponse> attachCertificateToDistribution(Consumer<AttachCertificateToDistributionRequest.Builder> attachCertificateToDistributionRequest)

      Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.

      After the certificate is attached, your distribution accepts HTTPS traffic for all of the domains that are associated with the certificate.

      Use the CreateCertificate action to create a certificate that you can attach to your distribution.

      Only certificates created in the us-east-1 Amazon Web Services Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.


      This is a convenience which creates an instance of the AttachCertificateToDistributionRequest.Builder avoiding the need to create one manually via AttachCertificateToDistributionRequest.builder()

      Parameters:
      attachCertificateToDistributionRequest - A Consumer that will call methods on AttachCertificateToDistributionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AttachCertificateToDistribution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • attachDisk

      default CompletableFuture<AttachDiskResponse> 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.

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

      Parameters:
      attachDiskRequest -
      Returns:
      A Java Future containing the result of the AttachDisk operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • attachDisk

      default CompletableFuture<AttachDiskResponse> attachDisk(Consumer<AttachDiskRequest.Builder> attachDiskRequest)

      Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.

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


      This is a convenience which creates an instance of the AttachDiskRequest.Builder avoiding the need to create one manually via AttachDiskRequest.builder()

      Parameters:
      attachDiskRequest - A Consumer that will call methods on AttachDiskRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AttachDisk operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • attachInstancesToLoadBalancer

      default CompletableFuture<AttachInstancesToLoadBalancerResponse> 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.

      The attach instances to load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Developer Guide.

      Parameters:
      attachInstancesToLoadBalancerRequest -
      Returns:
      A Java Future containing the result of the AttachInstancesToLoadBalancer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • attachInstancesToLoadBalancer

      default CompletableFuture<AttachInstancesToLoadBalancerResponse> attachInstancesToLoadBalancer(Consumer<AttachInstancesToLoadBalancerRequest.Builder> 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.

      The attach instances to load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Developer Guide.


      This is a convenience which creates an instance of the AttachInstancesToLoadBalancerRequest.Builder avoiding the need to create one manually via AttachInstancesToLoadBalancerRequest.builder()

      Parameters:
      attachInstancesToLoadBalancerRequest - A Consumer that will call methods on AttachInstancesToLoadBalancerRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AttachInstancesToLoadBalancer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • attachLoadBalancerTlsCertificate

      default CompletableFuture<AttachLoadBalancerTlsCertificateResponse> 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 action with the non-attached certificate, and it will replace the existing one and become the attached certificate.

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

      Parameters:
      attachLoadBalancerTlsCertificateRequest -
      Returns:
      A Java Future containing the result of the AttachLoadBalancerTlsCertificate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • attachLoadBalancerTlsCertificate

      default CompletableFuture<AttachLoadBalancerTlsCertificateResponse> attachLoadBalancerTlsCertificate(Consumer<AttachLoadBalancerTlsCertificateRequest.Builder> 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 action with the non-attached certificate, and it will replace the existing one and become the attached certificate.

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


      This is a convenience which creates an instance of the AttachLoadBalancerTlsCertificateRequest.Builder avoiding the need to create one manually via AttachLoadBalancerTlsCertificateRequest.builder()

      Parameters:
      attachLoadBalancerTlsCertificateRequest - A Consumer that will call methods on AttachLoadBalancerTlsCertificateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AttachLoadBalancerTlsCertificate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • attachStaticIp

      default CompletableFuture<AttachStaticIpResponse> attachStaticIp(AttachStaticIpRequest attachStaticIpRequest)

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

      Parameters:
      attachStaticIpRequest -
      Returns:
      A Java Future containing the result of the AttachStaticIp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • attachStaticIp

      default CompletableFuture<AttachStaticIpResponse> attachStaticIp(Consumer<AttachStaticIpRequest.Builder> attachStaticIpRequest)

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


      This is a convenience which creates an instance of the AttachStaticIpRequest.Builder avoiding the need to create one manually via AttachStaticIpRequest.builder()

      Parameters:
      attachStaticIpRequest - A Consumer that will call methods on AttachStaticIpRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AttachStaticIp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • closeInstancePublicPorts

      default CompletableFuture<CloseInstancePublicPortsResponse> closeInstancePublicPorts(CloseInstancePublicPortsRequest closeInstancePublicPortsRequest)

      Closes ports for a specific Amazon Lightsail instance.

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

      Parameters:
      closeInstancePublicPortsRequest -
      Returns:
      A Java Future containing the result of the CloseInstancePublicPorts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • closeInstancePublicPorts

      default CompletableFuture<CloseInstancePublicPortsResponse> closeInstancePublicPorts(Consumer<CloseInstancePublicPortsRequest.Builder> closeInstancePublicPortsRequest)

      Closes ports for a specific Amazon Lightsail instance.

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


      This is a convenience which creates an instance of the CloseInstancePublicPortsRequest.Builder avoiding the need to create one manually via CloseInstancePublicPortsRequest.builder()

      Parameters:
      closeInstancePublicPortsRequest - A Consumer that will call methods on CloseInstancePublicPortsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CloseInstancePublicPorts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • copySnapshot

      default CompletableFuture<CopySnapshotResponse> copySnapshot(CopySnapshotRequest copySnapshotRequest)

      Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an instance or disk as a manual snapshot. This operation can also be used to copy a manual or automatic snapshot of an instance or a disk from one Amazon Web Services Region to another in Amazon Lightsail.

      When copying a manual snapshot, be sure to define the source region, source snapshot name, and target snapshot name parameters.

      When copying an automatic snapshot, be sure to define the source region, source resource name, target snapshot name, and either the restore date or the use latest restorable auto snapshot parameters.

      Parameters:
      copySnapshotRequest -
      Returns:
      A Java Future containing the result of the CopySnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • copySnapshot

      default CompletableFuture<CopySnapshotResponse> copySnapshot(Consumer<CopySnapshotRequest.Builder> copySnapshotRequest)

      Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an instance or disk as a manual snapshot. This operation can also be used to copy a manual or automatic snapshot of an instance or a disk from one Amazon Web Services Region to another in Amazon Lightsail.

      When copying a manual snapshot, be sure to define the source region, source snapshot name, and target snapshot name parameters.

      When copying an automatic snapshot, be sure to define the source region, source resource name, target snapshot name, and either the restore date or the use latest restorable auto snapshot parameters.


      This is a convenience which creates an instance of the CopySnapshotRequest.Builder avoiding the need to create one manually via CopySnapshotRequest.builder()

      Parameters:
      copySnapshotRequest - A Consumer that will call methods on CopySnapshotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CopySnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createBucket

      default CompletableFuture<CreateBucketResponse> createBucket(CreateBucketRequest createBucketRequest)

      Creates an Amazon Lightsail bucket.

      A bucket is a cloud storage resource available in the Lightsail object storage service. Use buckets to store objects such as data and its descriptive metadata. For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.

      Parameters:
      createBucketRequest -
      Returns:
      A Java Future containing the result of the CreateBucket operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createBucket

      default CompletableFuture<CreateBucketResponse> createBucket(Consumer<CreateBucketRequest.Builder> createBucketRequest)

      Creates an Amazon Lightsail bucket.

      A bucket is a cloud storage resource available in the Lightsail object storage service. Use buckets to store objects such as data and its descriptive metadata. For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.


      This is a convenience which creates an instance of the CreateBucketRequest.Builder avoiding the need to create one manually via CreateBucketRequest.builder()

      Parameters:
      createBucketRequest - A Consumer that will call methods on CreateBucketRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateBucket operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createBucketAccessKey

      default CompletableFuture<CreateBucketAccessKeyResponse> createBucketAccessKey(CreateBucketAccessKeyRequest createBucketAccessKeyRequest)

      Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of an access key ID and corresponding secret access key.

      Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the GetBucketAccessKeys action to get a list of current access keys for a specific bucket. For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.

      The secretAccessKey value is returned only in response to the CreateBucketAccessKey action. You can get a secret access key only when you first create an access key; you cannot get the secret access key later. If you lose the secret access key, you must create a new access key.

      Parameters:
      createBucketAccessKeyRequest -
      Returns:
      A Java Future containing the result of the CreateBucketAccessKey operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createBucketAccessKey

      default CompletableFuture<CreateBucketAccessKeyResponse> createBucketAccessKey(Consumer<CreateBucketAccessKeyRequest.Builder> createBucketAccessKeyRequest)

      Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of an access key ID and corresponding secret access key.

      Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the GetBucketAccessKeys action to get a list of current access keys for a specific bucket. For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.

      The secretAccessKey value is returned only in response to the CreateBucketAccessKey action. You can get a secret access key only when you first create an access key; you cannot get the secret access key later. If you lose the secret access key, you must create a new access key.


      This is a convenience which creates an instance of the CreateBucketAccessKeyRequest.Builder avoiding the need to create one manually via CreateBucketAccessKeyRequest.builder()

      Parameters:
      createBucketAccessKeyRequest - A Consumer that will call methods on CreateBucketAccessKeyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateBucketAccessKey operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createCertificate

      default CompletableFuture<CreateCertificateResponse> createCertificate(CreateCertificateRequest createCertificateRequest)

      Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service.

      After the certificate is valid, use the AttachCertificateToDistribution action to use the certificate and its domains with your distribution. Or use the UpdateContainerService action to use the certificate and its domains with your container service.

      Only certificates created in the us-east-1 Amazon Web Services Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.

      Parameters:
      createCertificateRequest -
      Returns:
      A Java Future containing the result of the CreateCertificate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createCertificate

      default CompletableFuture<CreateCertificateResponse> createCertificate(Consumer<CreateCertificateRequest.Builder> createCertificateRequest)

      Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service.

      After the certificate is valid, use the AttachCertificateToDistribution action to use the certificate and its domains with your distribution. Or use the UpdateContainerService action to use the certificate and its domains with your container service.

      Only certificates created in the us-east-1 Amazon Web Services Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any Amazon Web Services Region, and distribute its content globally. However, all distributions are located in the us-east-1 Region.


      This is a convenience which creates an instance of the CreateCertificateRequest.Builder avoiding the need to create one manually via CreateCertificateRequest.builder()

      Parameters:
      createCertificateRequest - A Consumer that will call methods on CreateCertificateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateCertificate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createCloudFormationStack

      default CompletableFuture<CreateCloudFormationStackResponse> createCloudFormationStack(CreateCloudFormationStackRequest createCloudFormationStackRequest)

      Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot. This operation results in a CloudFormation stack record that can be used to track the AWS CloudFormation stack created. Use the get cloud formation stack records operation to get a list of the CloudFormation stacks created.

      Wait until after your new Amazon EC2 instance is created before running the create cloud formation stack operation again with the same export snapshot record.

      Parameters:
      createCloudFormationStackRequest -
      Returns:
      A Java Future containing the result of the CreateCloudFormationStack operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createCloudFormationStack

      default CompletableFuture<CreateCloudFormationStackResponse> createCloudFormationStack(Consumer<CreateCloudFormationStackRequest.Builder> createCloudFormationStackRequest)

      Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot. This operation results in a CloudFormation stack record that can be used to track the AWS CloudFormation stack created. Use the get cloud formation stack records operation to get a list of the CloudFormation stacks created.

      Wait until after your new Amazon EC2 instance is created before running the create cloud formation stack operation again with the same export snapshot record.


      This is a convenience which creates an instance of the CreateCloudFormationStackRequest.Builder avoiding the need to create one manually via CreateCloudFormationStackRequest.builder()

      Parameters:
      createCloudFormationStackRequest - A Consumer that will call methods on CreateCloudFormationStackRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateCloudFormationStack operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createContactMethod

      default CompletableFuture<CreateContactMethodResponse> createContactMethod(CreateContactMethodRequest createContactMethodRequest)

      Creates an email or SMS text message contact method.

      A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

      Parameters:
      createContactMethodRequest -
      Returns:
      A Java Future containing the result of the CreateContactMethod operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createContactMethod

      default CompletableFuture<CreateContactMethodResponse> createContactMethod(Consumer<CreateContactMethodRequest.Builder> createContactMethodRequest)

      Creates an email or SMS text message contact method.

      A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.


      This is a convenience which creates an instance of the CreateContactMethodRequest.Builder avoiding the need to create one manually via CreateContactMethodRequest.builder()

      Parameters:
      createContactMethodRequest - A Consumer that will call methods on CreateContactMethodRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateContactMethod operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createContainerService

      default CompletableFuture<CreateContainerServiceResponse> createContainerService(CreateContainerServiceRequest createContainerServiceRequest)

      Creates an Amazon Lightsail container service.

      A Lightsail container service is a compute resource to which you can deploy containers. For more information, see Container services in Amazon Lightsail in the Lightsail Dev Guide.

      Parameters:
      createContainerServiceRequest -
      Returns:
      A Java Future containing the result of the CreateContainerService operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createContainerService

      default CompletableFuture<CreateContainerServiceResponse> createContainerService(Consumer<CreateContainerServiceRequest.Builder> createContainerServiceRequest)

      Creates an Amazon Lightsail container service.

      A Lightsail container service is a compute resource to which you can deploy containers. For more information, see Container services in Amazon Lightsail in the Lightsail Dev Guide.


      This is a convenience which creates an instance of the CreateContainerServiceRequest.Builder avoiding the need to create one manually via CreateContainerServiceRequest.builder()

      Parameters:
      createContainerServiceRequest - A Consumer that will call methods on CreateContainerServiceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateContainerService operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createContainerServiceDeployment

      default CompletableFuture<CreateContainerServiceDeploymentResponse> createContainerServiceDeployment(CreateContainerServiceDeploymentRequest createContainerServiceDeploymentRequest)

      Creates a deployment for your Amazon Lightsail container service.

      A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.

      You can deploy containers to your container service using container images from a public registry such as Amazon ECR Public, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.

      Parameters:
      createContainerServiceDeploymentRequest -
      Returns:
      A Java Future containing the result of the CreateContainerServiceDeployment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createContainerServiceDeployment

      default CompletableFuture<CreateContainerServiceDeploymentResponse> createContainerServiceDeployment(Consumer<CreateContainerServiceDeploymentRequest.Builder> createContainerServiceDeploymentRequest)

      Creates a deployment for your Amazon Lightsail container service.

      A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.

      You can deploy containers to your container service using container images from a public registry such as Amazon ECR Public, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.


      This is a convenience which creates an instance of the CreateContainerServiceDeploymentRequest.Builder avoiding the need to create one manually via CreateContainerServiceDeploymentRequest.builder()

      Parameters:
      createContainerServiceDeploymentRequest - A Consumer that will call methods on CreateContainerServiceDeploymentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateContainerServiceDeployment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createContainerServiceRegistryLogin

      default CompletableFuture<CreateContainerServiceRegistryLoginResponse> createContainerServiceRegistryLogin(CreateContainerServiceRegistryLoginRequest createContainerServiceRegistryLoginRequest)

      Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine. After you're logged in, you can use the native Docker commands to push your local container images to the container image registry of your Amazon Lightsail account so that you can use them with your Lightsail container service. The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials.

      You can only push container images to the container service registry of your Lightsail account. You cannot pull container images or perform any other container image management actions on the container service registry.

      After you push your container images to the container image registry of your Lightsail account, use the RegisterContainerImage action to register the pushed images to a specific Lightsail container service.

      This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.

      Parameters:
      createContainerServiceRegistryLoginRequest -
      Returns:
      A Java Future containing the result of the CreateContainerServiceRegistryLogin operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createContainerServiceRegistryLogin

      default CompletableFuture<CreateContainerServiceRegistryLoginResponse> createContainerServiceRegistryLogin(Consumer<CreateContainerServiceRegistryLoginRequest.Builder> createContainerServiceRegistryLoginRequest)

      Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine. After you're logged in, you can use the native Docker commands to push your local container images to the container image registry of your Amazon Lightsail account so that you can use them with your Lightsail container service. The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials.

      You can only push container images to the container service registry of your Lightsail account. You cannot pull container images or perform any other container image management actions on the container service registry.

      After you push your container images to the container image registry of your Lightsail account, use the RegisterContainerImage action to register the pushed images to a specific Lightsail container service.

      This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.


      This is a convenience which creates an instance of the CreateContainerServiceRegistryLoginRequest.Builder avoiding the need to create one manually via CreateContainerServiceRegistryLoginRequest.builder()

      Parameters:
      createContainerServiceRegistryLoginRequest - A Consumer that will call methods on CreateContainerServiceRegistryLoginRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateContainerServiceRegistryLogin operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDisk

      default CompletableFuture<CreateDiskResponse> createDisk(CreateDiskRequest createDiskRequest)

      Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone ( us-east-2a).

      The create disk operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

      Parameters:
      createDiskRequest -
      Returns:
      A Java Future containing the result of the CreateDisk operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDisk

      default CompletableFuture<CreateDiskResponse> createDisk(Consumer<CreateDiskRequest.Builder> createDiskRequest)

      Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone ( us-east-2a).

      The create disk operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.


      This is a convenience which creates an instance of the CreateDiskRequest.Builder avoiding the need to create one manually via CreateDiskRequest.builder()

      Parameters:
      createDiskRequest - A Consumer that will call methods on CreateDiskRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateDisk operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDiskFromSnapshot

      default CompletableFuture<CreateDiskFromSnapshotResponse> createDiskFromSnapshot(CreateDiskFromSnapshotRequest createDiskFromSnapshotRequest)

      Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to an Amazon Lightsail instance in the same Availability Zone (us-east-2a).

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

      Parameters:
      createDiskFromSnapshotRequest -
      Returns:
      A Java Future containing the result of the CreateDiskFromSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDiskFromSnapshot

      default CompletableFuture<CreateDiskFromSnapshotResponse> createDiskFromSnapshot(Consumer<CreateDiskFromSnapshotRequest.Builder> createDiskFromSnapshotRequest)

      Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to an Amazon Lightsail instance in the same Availability Zone (us-east-2a).

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


      This is a convenience which creates an instance of the CreateDiskFromSnapshotRequest.Builder avoiding the need to create one manually via CreateDiskFromSnapshotRequest.builder()

      Parameters:
      createDiskFromSnapshotRequest - A Consumer that will call methods on CreateDiskFromSnapshotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateDiskFromSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDiskSnapshot

      default CompletableFuture<CreateDiskSnapshotResponse> 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.

      You can also use this operation to create a snapshot of an instance's system volume. You might want to do this, for example, to recover data from the system volume of a botched instance or to create a backup of the system volume like you would for a block storage disk. To create a snapshot of a system volume, just define the instance name parameter when issuing the snapshot command, and a snapshot of the defined instance's system volume will be created. After the snapshot is available, you can create a block storage disk from the snapshot and attach it to a running instance to access the data on the disk.

      The create disk snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

      Parameters:
      createDiskSnapshotRequest -
      Returns:
      A Java Future containing the result of the CreateDiskSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDiskSnapshot

      default CompletableFuture<CreateDiskSnapshotResponse> createDiskSnapshot(Consumer<CreateDiskSnapshotRequest.Builder> 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.

      You can also use this operation to create a snapshot of an instance's system volume. You might want to do this, for example, to recover data from the system volume of a botched instance or to create a backup of the system volume like you would for a block storage disk. To create a snapshot of a system volume, just define the instance name parameter when issuing the snapshot command, and a snapshot of the defined instance's system volume will be created. After the snapshot is available, you can create a block storage disk from the snapshot and attach it to a running instance to access the data on the disk.

      The create disk snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.


      This is a convenience which creates an instance of the CreateDiskSnapshotRequest.Builder avoiding the need to create one manually via CreateDiskSnapshotRequest.builder()

      Parameters:
      createDiskSnapshotRequest - A Consumer that will call methods on CreateDiskSnapshotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateDiskSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDistribution

      default CompletableFuture<CreateDistributionResponse> createDistribution(CreateDistributionRequest createDistributionRequest)

      Creates an Amazon Lightsail content delivery network (CDN) distribution.

      A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance. For more information, see Content delivery networks in Amazon Lightsail.

      Parameters:
      createDistributionRequest -
      Returns:
      A Java Future containing the result of the CreateDistribution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDistribution

      default CompletableFuture<CreateDistributionResponse> createDistribution(Consumer<CreateDistributionRequest.Builder> createDistributionRequest)

      Creates an Amazon Lightsail content delivery network (CDN) distribution.

      A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance. For more information, see Content delivery networks in Amazon Lightsail.


      This is a convenience which creates an instance of the CreateDistributionRequest.Builder avoiding the need to create one manually via CreateDistributionRequest.builder()

      Parameters:
      createDistributionRequest - A Consumer that will call methods on CreateDistributionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateDistribution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDomain

      default CompletableFuture<CreateDomainResponse> createDomain(CreateDomainRequest createDomainRequest)

      Creates a domain resource for the specified domain (example.com).

      The create domain operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

      Parameters:
      createDomainRequest -
      Returns:
      A Java Future containing the result of the CreateDomain operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDomain

      default CompletableFuture<CreateDomainResponse> createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest)

      Creates a domain resource for the specified domain (example.com).

      The create domain operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.


      This is a convenience which creates an instance of the CreateDomainRequest.Builder avoiding the need to create one manually via CreateDomainRequest.builder()

      Parameters:
      createDomainRequest - A Consumer that will call methods on CreateDomainRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateDomain operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDomainEntry

      default CompletableFuture<CreateDomainEntryResponse> createDomainEntry(CreateDomainEntryRequest createDomainEntryRequest)

      Creates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).

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

      Parameters:
      createDomainEntryRequest -
      Returns:
      A Java Future containing the result of the CreateDomainEntry operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDomainEntry

      default CompletableFuture<CreateDomainEntryResponse> createDomainEntry(Consumer<CreateDomainEntryRequest.Builder> createDomainEntryRequest)

      Creates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).

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


      This is a convenience which creates an instance of the CreateDomainEntryRequest.Builder avoiding the need to create one manually via CreateDomainEntryRequest.builder()

      Parameters:
      createDomainEntryRequest - A Consumer that will call methods on CreateDomainEntryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateDomainEntry operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createGUISessionAccessDetails

      default CompletableFuture<CreateGuiSessionAccessDetailsResponse> createGUISessionAccessDetails(CreateGuiSessionAccessDetailsRequest createGuiSessionAccessDetailsRequest)

      Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session. The primary URL initiates a web-based NICE DCV session to the virtual computer's application. The secondary URL initiates a web-based NICE DCV session to the virtual computer's operating session.

      Use StartGUISession to open the session.

      Parameters:
      createGuiSessionAccessDetailsRequest -
      Returns:
      A Java Future containing the result of the CreateGUISessionAccessDetails operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createGUISessionAccessDetails

      default CompletableFuture<CreateGuiSessionAccessDetailsResponse> createGUISessionAccessDetails(Consumer<CreateGuiSessionAccessDetailsRequest.Builder> createGuiSessionAccessDetailsRequest)

      Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session. The primary URL initiates a web-based NICE DCV session to the virtual computer's application. The secondary URL initiates a web-based NICE DCV session to the virtual computer's operating session.

      Use StartGUISession to open the session.


      This is a convenience which creates an instance of the CreateGuiSessionAccessDetailsRequest.Builder avoiding the need to create one manually via CreateGuiSessionAccessDetailsRequest.builder()

      Parameters:
      createGuiSessionAccessDetailsRequest - A Consumer that will call methods on CreateGuiSessionAccessDetailsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateGUISessionAccessDetails operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createInstanceSnapshot

      default CompletableFuture<CreateInstanceSnapshotResponse> 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.

      The create instance snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

      Parameters:
      createInstanceSnapshotRequest -
      Returns:
      A Java Future containing the result of the CreateInstanceSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createInstanceSnapshot

      default CompletableFuture<CreateInstanceSnapshotResponse> createInstanceSnapshot(Consumer<CreateInstanceSnapshotRequest.Builder> 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.

      The create instance snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.


      This is a convenience which creates an instance of the CreateInstanceSnapshotRequest.Builder avoiding the need to create one manually via CreateInstanceSnapshotRequest.builder()

      Parameters:
      createInstanceSnapshotRequest - A Consumer that will call methods on CreateInstanceSnapshotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateInstanceSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createInstances

      default CompletableFuture<CreateInstancesResponse> createInstances(CreateInstancesRequest createInstancesRequest)

      Creates one or more Amazon Lightsail instances.

      The create instances operation supports tag-based access control via request tags. For more information, see the Lightsail Developer Guide.

      Parameters:
      createInstancesRequest -
      Returns:
      A Java Future containing the result of the CreateInstances operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createInstances

      default CompletableFuture<CreateInstancesResponse> createInstances(Consumer<CreateInstancesRequest.Builder> createInstancesRequest)

      Creates one or more Amazon Lightsail instances.

      The create instances operation supports tag-based access control via request tags. For more information, see the Lightsail Developer Guide.


      This is a convenience which creates an instance of the CreateInstancesRequest.Builder avoiding the need to create one manually via CreateInstancesRequest.builder()

      Parameters:
      createInstancesRequest - A Consumer that will call methods on CreateInstancesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateInstances operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createInstancesFromSnapshot

      default CompletableFuture<CreateInstancesFromSnapshotResponse> createInstancesFromSnapshot(CreateInstancesFromSnapshotRequest createInstancesFromSnapshotRequest)

      Creates one or more new instances from a manual or automatic snapshot of an instance.

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

      Parameters:
      createInstancesFromSnapshotRequest -
      Returns:
      A Java Future containing the result of the CreateInstancesFromSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createInstancesFromSnapshot

      default CompletableFuture<CreateInstancesFromSnapshotResponse> createInstancesFromSnapshot(Consumer<CreateInstancesFromSnapshotRequest.Builder> createInstancesFromSnapshotRequest)

      Creates one or more new instances from a manual or automatic snapshot of an instance.

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


      This is a convenience which creates an instance of the CreateInstancesFromSnapshotRequest.Builder avoiding the need to create one manually via CreateInstancesFromSnapshotRequest.builder()

      Parameters:
      createInstancesFromSnapshotRequest - A Consumer that will call methods on CreateInstancesFromSnapshotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateInstancesFromSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createKeyPair

      default CompletableFuture<CreateKeyPairResponse> createKeyPair(CreateKeyPairRequest createKeyPairRequest)

      Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.

      Use the DownloadDefaultKeyPair action to create a Lightsail default key pair in an Amazon Web Services Region where a default key pair does not currently exist.

      The create key pair operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

      Parameters:
      createKeyPairRequest -
      Returns:
      A Java Future containing the result of the CreateKeyPair operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createKeyPair

      default CompletableFuture<CreateKeyPairResponse> createKeyPair(Consumer<CreateKeyPairRequest.Builder> createKeyPairRequest)

      Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.

      Use the DownloadDefaultKeyPair action to create a Lightsail default key pair in an Amazon Web Services Region where a default key pair does not currently exist.

      The create key pair operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.


      This is a convenience which creates an instance of the CreateKeyPairRequest.Builder avoiding the need to create one manually via CreateKeyPairRequest.builder()

      Parameters:
      createKeyPairRequest - A Consumer that will call methods on CreateKeyPairRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateKeyPair operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLoadBalancer

      default CompletableFuture<CreateLoadBalancerResponse> 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.

      The create load balancer operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

      Parameters:
      createLoadBalancerRequest -
      Returns:
      A Java Future containing the result of the CreateLoadBalancer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLoadBalancer

      default CompletableFuture<CreateLoadBalancerResponse> createLoadBalancer(Consumer<CreateLoadBalancerRequest.Builder> 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.

      The create load balancer operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.


      This is a convenience which creates an instance of the CreateLoadBalancerRequest.Builder avoiding the need to create one manually via CreateLoadBalancerRequest.builder()

      Parameters:
      createLoadBalancerRequest - A Consumer that will call methods on CreateLoadBalancerRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateLoadBalancer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLoadBalancerTlsCertificate

      default CompletableFuture<CreateLoadBalancerTlsCertificateResponse> createLoadBalancerTlsCertificate(CreateLoadBalancerTlsCertificateRequest createLoadBalancerTlsCertificateRequest)

      Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.

      TLS is just an updated, more secure version of Secure Socket Layer (SSL).

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

      Parameters:
      createLoadBalancerTlsCertificateRequest -
      Returns:
      A Java Future containing the result of the CreateLoadBalancerTlsCertificate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLoadBalancerTlsCertificate

      default CompletableFuture<CreateLoadBalancerTlsCertificateResponse> createLoadBalancerTlsCertificate(Consumer<CreateLoadBalancerTlsCertificateRequest.Builder> createLoadBalancerTlsCertificateRequest)

      Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.

      TLS is just an updated, more secure version of Secure Socket Layer (SSL).

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


      This is a convenience which creates an instance of the CreateLoadBalancerTlsCertificateRequest.Builder avoiding the need to create one manually via CreateLoadBalancerTlsCertificateRequest.builder()

      Parameters:
      createLoadBalancerTlsCertificateRequest - A Consumer that will call methods on CreateLoadBalancerTlsCertificateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateLoadBalancerTlsCertificate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createRelationalDatabase

      default CompletableFuture<CreateRelationalDatabaseResponse> createRelationalDatabase(CreateRelationalDatabaseRequest createRelationalDatabaseRequest)

      Creates a new database in Amazon Lightsail.

      The create relational database operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

      Parameters:
      createRelationalDatabaseRequest -
      Returns:
      A Java Future containing the result of the CreateRelationalDatabase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createRelationalDatabase

      default CompletableFuture<CreateRelationalDatabaseResponse> createRelationalDatabase(Consumer<CreateRelationalDatabaseRequest.Builder> createRelationalDatabaseRequest)

      Creates a new database in Amazon Lightsail.

      The create relational database operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.


      This is a convenience which creates an instance of the CreateRelationalDatabaseRequest.Builder avoiding the need to create one manually via CreateRelationalDatabaseRequest.builder()

      Parameters:
      createRelationalDatabaseRequest - A Consumer that will call methods on CreateRelationalDatabaseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateRelationalDatabase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createRelationalDatabaseFromSnapshot

      default CompletableFuture<CreateRelationalDatabaseFromSnapshotResponse> createRelationalDatabaseFromSnapshot(CreateRelationalDatabaseFromSnapshotRequest createRelationalDatabaseFromSnapshotRequest)

      Creates a new database from an existing database snapshot in Amazon Lightsail.

      You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a different plan, such as a high availability or standard plan.

      The create relational database from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by relationalDatabaseSnapshotName. For more information, see the Amazon Lightsail Developer Guide.

      Parameters:
      createRelationalDatabaseFromSnapshotRequest -
      Returns:
      A Java Future containing the result of the CreateRelationalDatabaseFromSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createRelationalDatabaseFromSnapshot

      default CompletableFuture<CreateRelationalDatabaseFromSnapshotResponse> createRelationalDatabaseFromSnapshot(Consumer<CreateRelationalDatabaseFromSnapshotRequest.Builder> createRelationalDatabaseFromSnapshotRequest)

      Creates a new database from an existing database snapshot in Amazon Lightsail.

      You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a different plan, such as a high availability or standard plan.

      The create relational database from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by relationalDatabaseSnapshotName. For more information, see the Amazon Lightsail Developer Guide.


      This is a convenience which creates an instance of the CreateRelationalDatabaseFromSnapshotRequest.Builder avoiding the need to create one manually via CreateRelationalDatabaseFromSnapshotRequest.builder()

      Parameters:
      createRelationalDatabaseFromSnapshotRequest - A Consumer that will call methods on CreateRelationalDatabaseFromSnapshotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateRelationalDatabaseFromSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createRelationalDatabaseSnapshot

      default CompletableFuture<CreateRelationalDatabaseSnapshotResponse> createRelationalDatabaseSnapshot(CreateRelationalDatabaseSnapshotRequest createRelationalDatabaseSnapshotRequest)

      Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database.

      The create relational database snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.

      Parameters:
      createRelationalDatabaseSnapshotRequest -
      Returns:
      A Java Future containing the result of the CreateRelationalDatabaseSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createRelationalDatabaseSnapshot

      default CompletableFuture<CreateRelationalDatabaseSnapshotResponse> createRelationalDatabaseSnapshot(Consumer<CreateRelationalDatabaseSnapshotRequest.Builder> createRelationalDatabaseSnapshotRequest)

      Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database.

      The create relational database snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide.


      This is a convenience which creates an instance of the CreateRelationalDatabaseSnapshotRequest.Builder avoiding the need to create one manually via CreateRelationalDatabaseSnapshotRequest.builder()

      Parameters:
      createRelationalDatabaseSnapshotRequest - A Consumer that will call methods on CreateRelationalDatabaseSnapshotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateRelationalDatabaseSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAlarm

      default CompletableFuture<DeleteAlarmResponse> deleteAlarm(DeleteAlarmRequest deleteAlarmRequest)

      Deletes an alarm.

      An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.

      Parameters:
      deleteAlarmRequest -
      Returns:
      A Java Future containing the result of the DeleteAlarm operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • OperationFailureException Lightsail throws this exception when an operation fails to execute.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAlarm

      default CompletableFuture<DeleteAlarmResponse> deleteAlarm(Consumer<DeleteAlarmRequest.Builder> deleteAlarmRequest)

      Deletes an alarm.

      An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.


      This is a convenience which creates an instance of the DeleteAlarmRequest.Builder avoiding the need to create one manually via DeleteAlarmRequest.builder()

      Parameters:
      deleteAlarmRequest - A Consumer that will call methods on DeleteAlarmRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAlarm operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • OperationFailureException Lightsail throws this exception when an operation fails to execute.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAutoSnapshot

      default CompletableFuture<DeleteAutoSnapshotResponse> deleteAutoSnapshot(DeleteAutoSnapshotRequest deleteAutoSnapshotRequest)

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

      Parameters:
      deleteAutoSnapshotRequest -
      Returns:
      A Java Future containing the result of the DeleteAutoSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAutoSnapshot

      default CompletableFuture<DeleteAutoSnapshotResponse> deleteAutoSnapshot(Consumer<DeleteAutoSnapshotRequest.Builder> deleteAutoSnapshotRequest)

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


      This is a convenience which creates an instance of the DeleteAutoSnapshotRequest.Builder avoiding the need to create one manually via DeleteAutoSnapshotRequest.builder()

      Parameters:
      deleteAutoSnapshotRequest - A Consumer that will call methods on DeleteAutoSnapshotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAutoSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBucket

      default CompletableFuture<DeleteBucketResponse> deleteBucket(DeleteBucketRequest deleteBucketRequest)

      Deletes a Amazon Lightsail bucket.

      When you delete your bucket, the bucket name is released and can be reused for a new bucket in your account or another Amazon Web Services account.

      Parameters:
      deleteBucketRequest -
      Returns:
      A Java Future containing the result of the DeleteBucket operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBucket

      default CompletableFuture<DeleteBucketResponse> deleteBucket(Consumer<DeleteBucketRequest.Builder> deleteBucketRequest)

      Deletes a Amazon Lightsail bucket.

      When you delete your bucket, the bucket name is released and can be reused for a new bucket in your account or another Amazon Web Services account.


      This is a convenience which creates an instance of the DeleteBucketRequest.Builder avoiding the need to create one manually via DeleteBucketRequest.builder()

      Parameters:
      deleteBucketRequest - A Consumer that will call methods on DeleteBucketRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteBucket operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBucketAccessKey

      default CompletableFuture<DeleteBucketAccessKeyResponse> deleteBucketAccessKey(DeleteBucketAccessKeyRequest deleteBucketAccessKeyRequest)

      Deletes an access key for the specified Amazon Lightsail bucket.

      We recommend that you delete an access key if the secret access key is compromised.

      For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.

      Parameters:
      deleteBucketAccessKeyRequest -
      Returns:
      A Java Future containing the result of the DeleteBucketAccessKey operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteBucketAccessKey

      default CompletableFuture<DeleteBucketAccessKeyResponse> deleteBucketAccessKey(Consumer<DeleteBucketAccessKeyRequest.Builder> deleteBucketAccessKeyRequest)

      Deletes an access key for the specified Amazon Lightsail bucket.

      We recommend that you delete an access key if the secret access key is compromised.

      For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.


      This is a convenience which creates an instance of the DeleteBucketAccessKeyRequest.Builder avoiding the need to create one manually via DeleteBucketAccessKeyRequest.builder()

      Parameters:
      deleteBucketAccessKeyRequest - A Consumer that will call methods on DeleteBucketAccessKeyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteBucketAccessKey operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteCertificate

      default CompletableFuture<DeleteCertificateResponse> deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)

      Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.

      Certificates that are currently attached to a distribution cannot be deleted. Use the DetachCertificateFromDistribution action to detach a certificate from a distribution.

      Parameters:
      deleteCertificateRequest -
      Returns:
      A Java Future containing the result of the DeleteCertificate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteCertificate

      default CompletableFuture<DeleteCertificateResponse> deleteCertificate(Consumer<DeleteCertificateRequest.Builder> deleteCertificateRequest)

      Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.

      Certificates that are currently attached to a distribution cannot be deleted. Use the DetachCertificateFromDistribution action to detach a certificate from a distribution.


      This is a convenience which creates an instance of the DeleteCertificateRequest.Builder avoiding the need to create one manually via DeleteCertificateRequest.builder()

      Parameters:
      deleteCertificateRequest - A Consumer that will call methods on DeleteCertificateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteCertificate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteContactMethod

      default CompletableFuture<DeleteContactMethodResponse> deleteContactMethod(DeleteContactMethodRequest deleteContactMethodRequest)

      Deletes a contact method.

      A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

      Parameters:
      deleteContactMethodRequest -
      Returns:
      A Java Future containing the result of the DeleteContactMethod operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • OperationFailureException Lightsail throws this exception when an operation fails to execute.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteContactMethod

      default CompletableFuture<DeleteContactMethodResponse> deleteContactMethod(Consumer<DeleteContactMethodRequest.Builder> deleteContactMethodRequest)

      Deletes a contact method.

      A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.


      This is a convenience which creates an instance of the DeleteContactMethodRequest.Builder avoiding the need to create one manually via DeleteContactMethodRequest.builder()

      Parameters:
      deleteContactMethodRequest - A Consumer that will call methods on DeleteContactMethodRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteContactMethod operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • OperationFailureException Lightsail throws this exception when an operation fails to execute.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteContainerImage

      default CompletableFuture<DeleteContainerImageResponse> deleteContainerImage(DeleteContainerImageRequest deleteContainerImageRequest)

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

      Parameters:
      deleteContainerImageRequest -
      Returns:
      A Java Future containing the result of the DeleteContainerImage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteContainerImage

      default CompletableFuture<DeleteContainerImageResponse> deleteContainerImage(Consumer<DeleteContainerImageRequest.Builder> deleteContainerImageRequest)

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


      This is a convenience which creates an instance of the DeleteContainerImageRequest.Builder avoiding the need to create one manually via DeleteContainerImageRequest.builder()

      Parameters:
      deleteContainerImageRequest - A Consumer that will call methods on DeleteContainerImageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteContainerImage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteContainerService

      default CompletableFuture<DeleteContainerServiceResponse> deleteContainerService(DeleteContainerServiceRequest deleteContainerServiceRequest)

      Deletes your Amazon Lightsail container service.

      Parameters:
      deleteContainerServiceRequest -
      Returns:
      A Java Future containing the result of the DeleteContainerService operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteContainerService

      default CompletableFuture<DeleteContainerServiceResponse> deleteContainerService(Consumer<DeleteContainerServiceRequest.Builder> deleteContainerServiceRequest)

      Deletes your Amazon Lightsail container service.


      This is a convenience which creates an instance of the DeleteContainerServiceRequest.Builder avoiding the need to create one manually via DeleteContainerServiceRequest.builder()

      Parameters:
      deleteContainerServiceRequest - A Consumer that will call methods on DeleteContainerServiceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteContainerService operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDisk

      default CompletableFuture<DeleteDiskResponse> 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.

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

      Parameters:
      deleteDiskRequest -
      Returns:
      A Java Future containing the result of the DeleteDisk operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDisk

      default CompletableFuture<DeleteDiskResponse> deleteDisk(Consumer<DeleteDiskRequest.Builder> 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.

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


      This is a convenience which creates an instance of the DeleteDiskRequest.Builder avoiding the need to create one manually via DeleteDiskRequest.builder()

      Parameters:
      deleteDiskRequest - A Consumer that will call methods on DeleteDiskRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteDisk operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDiskSnapshot

      default CompletableFuture<DeleteDiskSnapshotResponse> 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.

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

      Parameters:
      deleteDiskSnapshotRequest -
      Returns:
      A Java Future containing the result of the DeleteDiskSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDiskSnapshot

      default CompletableFuture<DeleteDiskSnapshotResponse> deleteDiskSnapshot(Consumer<DeleteDiskSnapshotRequest.Builder> 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.

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


      This is a convenience which creates an instance of the DeleteDiskSnapshotRequest.Builder avoiding the need to create one manually via DeleteDiskSnapshotRequest.builder()

      Parameters:
      deleteDiskSnapshotRequest - A Consumer that will call methods on DeleteDiskSnapshotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteDiskSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDistribution

      default CompletableFuture<DeleteDistributionResponse> deleteDistribution(DeleteDistributionRequest deleteDistributionRequest)

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

      Parameters:
      deleteDistributionRequest -
      Returns:
      A Java Future containing the result of the DeleteDistribution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDistribution

      default CompletableFuture<DeleteDistributionResponse> deleteDistribution(Consumer<DeleteDistributionRequest.Builder> deleteDistributionRequest)

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


      This is a convenience which creates an instance of the DeleteDistributionRequest.Builder avoiding the need to create one manually via DeleteDistributionRequest.builder()

      Parameters:
      deleteDistributionRequest - A Consumer that will call methods on DeleteDistributionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteDistribution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDomain

      default CompletableFuture<DeleteDomainResponse> deleteDomain(DeleteDomainRequest deleteDomainRequest)

      Deletes the specified domain recordset and all of its domain records.

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

      Parameters:
      deleteDomainRequest -
      Returns:
      A Java Future containing the result of the DeleteDomain operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDomain

      default CompletableFuture<DeleteDomainResponse> deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest)

      Deletes the specified domain recordset and all of its domain records.

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


      This is a convenience which creates an instance of the DeleteDomainRequest.Builder avoiding the need to create one manually via DeleteDomainRequest.builder()

      Parameters:
      deleteDomainRequest - A Consumer that will call methods on DeleteDomainRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteDomain operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDomainEntry

      default CompletableFuture<DeleteDomainEntryResponse> deleteDomainEntry(DeleteDomainEntryRequest deleteDomainEntryRequest)

      Deletes a specific domain entry.

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

      Parameters:
      deleteDomainEntryRequest -
      Returns:
      A Java Future containing the result of the DeleteDomainEntry operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDomainEntry

      default CompletableFuture<DeleteDomainEntryResponse> deleteDomainEntry(Consumer<DeleteDomainEntryRequest.Builder> deleteDomainEntryRequest)

      Deletes a specific domain entry.

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


      This is a convenience which creates an instance of the DeleteDomainEntryRequest.Builder avoiding the need to create one manually via DeleteDomainEntryRequest.builder()

      Parameters:
      deleteDomainEntryRequest - A Consumer that will call methods on DeleteDomainEntryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteDomainEntry operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteInstance

      default CompletableFuture<DeleteInstanceResponse> deleteInstance(DeleteInstanceRequest deleteInstanceRequest)

      Deletes an Amazon Lightsail instance.

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

      Parameters:
      deleteInstanceRequest -
      Returns:
      A Java Future containing the result of the DeleteInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteInstance

      default CompletableFuture<DeleteInstanceResponse> deleteInstance(Consumer<DeleteInstanceRequest.Builder> deleteInstanceRequest)

      Deletes an Amazon Lightsail instance.

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


      This is a convenience which creates an instance of the DeleteInstanceRequest.Builder avoiding the need to create one manually via DeleteInstanceRequest.builder()

      Parameters:
      deleteInstanceRequest - A Consumer that will call methods on DeleteInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteInstanceSnapshot

      default CompletableFuture<DeleteInstanceSnapshotResponse> deleteInstanceSnapshot(DeleteInstanceSnapshotRequest deleteInstanceSnapshotRequest)

      Deletes a specific snapshot of a virtual private server (or instance).

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

      Parameters:
      deleteInstanceSnapshotRequest -
      Returns:
      A Java Future containing the result of the DeleteInstanceSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteInstanceSnapshot

      default CompletableFuture<DeleteInstanceSnapshotResponse> deleteInstanceSnapshot(Consumer<DeleteInstanceSnapshotRequest.Builder> deleteInstanceSnapshotRequest)

      Deletes a specific snapshot of a virtual private server (or instance).

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


      This is a convenience which creates an instance of the DeleteInstanceSnapshotRequest.Builder avoiding the need to create one manually via DeleteInstanceSnapshotRequest.builder()

      Parameters:
      deleteInstanceSnapshotRequest - A Consumer that will call methods on DeleteInstanceSnapshotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteInstanceSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteKeyPair

      default CompletableFuture<DeleteKeyPairResponse> deleteKeyPair(DeleteKeyPairRequest deleteKeyPairRequest)

      Deletes the specified key pair by removing the public key from Amazon Lightsail.

      You can delete key pairs that were created using the ImportKeyPair and CreateKeyPair actions, as well as the Lightsail default key pair. A new default key pair will not be created unless you launch an instance without specifying a custom key pair, or you call the DownloadDefaultKeyPair API.

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

      Parameters:
      deleteKeyPairRequest -
      Returns:
      A Java Future containing the result of the DeleteKeyPair operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteKeyPair

      default CompletableFuture<DeleteKeyPairResponse> deleteKeyPair(Consumer<DeleteKeyPairRequest.Builder> deleteKeyPairRequest)

      Deletes the specified key pair by removing the public key from Amazon Lightsail.

      You can delete key pairs that were created using the ImportKeyPair and CreateKeyPair actions, as well as the Lightsail default key pair. A new default key pair will not be created unless you launch an instance without specifying a custom key pair, or you call the DownloadDefaultKeyPair API.

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


      This is a convenience which creates an instance of the DeleteKeyPairRequest.Builder avoiding the need to create one manually via DeleteKeyPairRequest.builder()

      Parameters:
      deleteKeyPairRequest - A Consumer that will call methods on DeleteKeyPairRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteKeyPair operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteKnownHostKeys

      default CompletableFuture<DeleteKnownHostKeysResponse> deleteKnownHostKeys(DeleteKnownHostKeysRequest deleteKnownHostKeysRequest)

      Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance. This operation enables the Lightsail browser-based SSH or RDP clients to connect to the instance after a host key mismatch.

      Perform this operation only if you were expecting the host key or certificate mismatch or if you are familiar with the new host key or certificate on the instance. For more information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP client.

      Parameters:
      deleteKnownHostKeysRequest -
      Returns:
      A Java Future containing the result of the DeleteKnownHostKeys operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteKnownHostKeys

      default CompletableFuture<DeleteKnownHostKeysResponse> deleteKnownHostKeys(Consumer<DeleteKnownHostKeysRequest.Builder> deleteKnownHostKeysRequest)

      Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance. This operation enables the Lightsail browser-based SSH or RDP clients to connect to the instance after a host key mismatch.

      Perform this operation only if you were expecting the host key or certificate mismatch or if you are familiar with the new host key or certificate on the instance. For more information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP client.


      This is a convenience which creates an instance of the DeleteKnownHostKeysRequest.Builder avoiding the need to create one manually via DeleteKnownHostKeysRequest.builder()

      Parameters:
      deleteKnownHostKeysRequest - A Consumer that will call methods on DeleteKnownHostKeysRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteKnownHostKeys operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteLoadBalancer

      default CompletableFuture<DeleteLoadBalancerResponse> 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.

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

      Parameters:
      deleteLoadBalancerRequest -
      Returns:
      A Java Future containing the result of the DeleteLoadBalancer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteLoadBalancer

      default CompletableFuture<DeleteLoadBalancerResponse> deleteLoadBalancer(Consumer<DeleteLoadBalancerRequest.Builder> 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.

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


      This is a convenience which creates an instance of the DeleteLoadBalancerRequest.Builder avoiding the need to create one manually via DeleteLoadBalancerRequest.builder()

      Parameters:
      deleteLoadBalancerRequest - A Consumer that will call methods on DeleteLoadBalancerRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteLoadBalancer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteLoadBalancerTlsCertificate

      default CompletableFuture<DeleteLoadBalancerTlsCertificateResponse> deleteLoadBalancerTlsCertificate(DeleteLoadBalancerTlsCertificateRequest deleteLoadBalancerTlsCertificateRequest)

      Deletes an SSL/TLS certificate associated with a Lightsail load balancer.

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

      Parameters:
      deleteLoadBalancerTlsCertificateRequest -
      Returns:
      A Java Future containing the result of the DeleteLoadBalancerTlsCertificate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteLoadBalancerTlsCertificate

      default CompletableFuture<DeleteLoadBalancerTlsCertificateResponse> deleteLoadBalancerTlsCertificate(Consumer<DeleteLoadBalancerTlsCertificateRequest.Builder> deleteLoadBalancerTlsCertificateRequest)

      Deletes an SSL/TLS certificate associated with a Lightsail load balancer.

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


      This is a convenience which creates an instance of the DeleteLoadBalancerTlsCertificateRequest.Builder avoiding the need to create one manually via DeleteLoadBalancerTlsCertificateRequest.builder()

      Parameters:
      deleteLoadBalancerTlsCertificateRequest - A Consumer that will call methods on DeleteLoadBalancerTlsCertificateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteLoadBalancerTlsCertificate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRelationalDatabase

      default CompletableFuture<DeleteRelationalDatabaseResponse> deleteRelationalDatabase(DeleteRelationalDatabaseRequest deleteRelationalDatabaseRequest)

      Deletes a database in Amazon Lightsail.

      The delete relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

      Parameters:
      deleteRelationalDatabaseRequest -
      Returns:
      A Java Future containing the result of the DeleteRelationalDatabase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRelationalDatabase

      default CompletableFuture<DeleteRelationalDatabaseResponse> deleteRelationalDatabase(Consumer<DeleteRelationalDatabaseRequest.Builder> deleteRelationalDatabaseRequest)

      Deletes a database in Amazon Lightsail.

      The delete relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.


      This is a convenience which creates an instance of the DeleteRelationalDatabaseRequest.Builder avoiding the need to create one manually via DeleteRelationalDatabaseRequest.builder()

      Parameters:
      deleteRelationalDatabaseRequest - A Consumer that will call methods on DeleteRelationalDatabaseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteRelationalDatabase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRelationalDatabaseSnapshot

      default CompletableFuture<DeleteRelationalDatabaseSnapshotResponse> deleteRelationalDatabaseSnapshot(DeleteRelationalDatabaseSnapshotRequest deleteRelationalDatabaseSnapshotRequest)

      Deletes a database snapshot in Amazon Lightsail.

      The delete relational database snapshot operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

      Parameters:
      deleteRelationalDatabaseSnapshotRequest -
      Returns:
      A Java Future containing the result of the DeleteRelationalDatabaseSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteRelationalDatabaseSnapshot

      default CompletableFuture<DeleteRelationalDatabaseSnapshotResponse> deleteRelationalDatabaseSnapshot(Consumer<DeleteRelationalDatabaseSnapshotRequest.Builder> deleteRelationalDatabaseSnapshotRequest)

      Deletes a database snapshot in Amazon Lightsail.

      The delete relational database snapshot operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.


      This is a convenience which creates an instance of the DeleteRelationalDatabaseSnapshotRequest.Builder avoiding the need to create one manually via DeleteRelationalDatabaseSnapshotRequest.builder()

      Parameters:
      deleteRelationalDatabaseSnapshotRequest - A Consumer that will call methods on DeleteRelationalDatabaseSnapshotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteRelationalDatabaseSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detachCertificateFromDistribution

      default CompletableFuture<DetachCertificateFromDistributionResponse> detachCertificateFromDistribution(DetachCertificateFromDistributionRequest detachCertificateFromDistributionRequest)

      Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.

      After the certificate is detached, your distribution stops accepting traffic for all of the domains that are associated with the certificate.

      Parameters:
      detachCertificateFromDistributionRequest -
      Returns:
      A Java Future containing the result of the DetachCertificateFromDistribution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detachCertificateFromDistribution

      default CompletableFuture<DetachCertificateFromDistributionResponse> detachCertificateFromDistribution(Consumer<DetachCertificateFromDistributionRequest.Builder> detachCertificateFromDistributionRequest)

      Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.

      After the certificate is detached, your distribution stops accepting traffic for all of the domains that are associated with the certificate.


      This is a convenience which creates an instance of the DetachCertificateFromDistributionRequest.Builder avoiding the need to create one manually via DetachCertificateFromDistributionRequest.builder()

      Parameters:
      detachCertificateFromDistributionRequest - A Consumer that will call methods on DetachCertificateFromDistributionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DetachCertificateFromDistribution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detachDisk

      default CompletableFuture<DetachDiskResponse> 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.

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

      Parameters:
      detachDiskRequest -
      Returns:
      A Java Future containing the result of the DetachDisk operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detachDisk

      default CompletableFuture<DetachDiskResponse> detachDisk(Consumer<DetachDiskRequest.Builder> 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.

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


      This is a convenience which creates an instance of the DetachDiskRequest.Builder avoiding the need to create one manually via DetachDiskRequest.builder()

      Parameters:
      detachDiskRequest - A Consumer that will call methods on DetachDiskRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DetachDisk operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detachInstancesFromLoadBalancer

      default CompletableFuture<DetachInstancesFromLoadBalancerResponse> 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.

      The detach instances from load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide.

      Parameters:
      detachInstancesFromLoadBalancerRequest -
      Returns:
      A Java Future containing the result of the DetachInstancesFromLoadBalancer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detachInstancesFromLoadBalancer

      default CompletableFuture<DetachInstancesFromLoadBalancerResponse> detachInstancesFromLoadBalancer(Consumer<DetachInstancesFromLoadBalancerRequest.Builder> 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.

      The detach instances from load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide.


      This is a convenience which creates an instance of the DetachInstancesFromLoadBalancerRequest.Builder avoiding the need to create one manually via DetachInstancesFromLoadBalancerRequest.builder()

      Parameters:
      detachInstancesFromLoadBalancerRequest - A Consumer that will call methods on DetachInstancesFromLoadBalancerRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DetachInstancesFromLoadBalancer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detachStaticIp

      default CompletableFuture<DetachStaticIpResponse> detachStaticIp(DetachStaticIpRequest detachStaticIpRequest)

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

      Parameters:
      detachStaticIpRequest -
      Returns:
      A Java Future containing the result of the DetachStaticIp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • detachStaticIp

      default CompletableFuture<DetachStaticIpResponse> detachStaticIp(Consumer<DetachStaticIpRequest.Builder> detachStaticIpRequest)

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


      This is a convenience which creates an instance of the DetachStaticIpRequest.Builder avoiding the need to create one manually via DetachStaticIpRequest.builder()

      Parameters:
      detachStaticIpRequest - A Consumer that will call methods on DetachStaticIpRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DetachStaticIp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disableAddOn

      default CompletableFuture<DisableAddOnResponse> disableAddOn(DisableAddOnRequest disableAddOnRequest)

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

      Parameters:
      disableAddOnRequest -
      Returns:
      A Java Future containing the result of the DisableAddOn operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disableAddOn

      default CompletableFuture<DisableAddOnResponse> disableAddOn(Consumer<DisableAddOnRequest.Builder> disableAddOnRequest)

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


      This is a convenience which creates an instance of the DisableAddOnRequest.Builder avoiding the need to create one manually via DisableAddOnRequest.builder()

      Parameters:
      disableAddOnRequest - A Consumer that will call methods on DisableAddOnRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisableAddOn operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • downloadDefaultKeyPair

      default CompletableFuture<DownloadDefaultKeyPairResponse> downloadDefaultKeyPair(DownloadDefaultKeyPairRequest downloadDefaultKeyPairRequest)

      Downloads the regional Amazon Lightsail default key pair.

      This action also creates a Lightsail default key pair if a default key pair does not currently exist in the Amazon Web Services Region.

      Parameters:
      downloadDefaultKeyPairRequest -
      Returns:
      A Java Future containing the result of the DownloadDefaultKeyPair operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • downloadDefaultKeyPair

      default CompletableFuture<DownloadDefaultKeyPairResponse> downloadDefaultKeyPair(Consumer<DownloadDefaultKeyPairRequest.Builder> downloadDefaultKeyPairRequest)

      Downloads the regional Amazon Lightsail default key pair.

      This action also creates a Lightsail default key pair if a default key pair does not currently exist in the Amazon Web Services Region.


      This is a convenience which creates an instance of the DownloadDefaultKeyPairRequest.Builder avoiding the need to create one manually via DownloadDefaultKeyPairRequest.builder()

      Parameters:
      downloadDefaultKeyPairRequest - A Consumer that will call methods on DownloadDefaultKeyPairRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DownloadDefaultKeyPair operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • downloadDefaultKeyPair

      default CompletableFuture<DownloadDefaultKeyPairResponse> downloadDefaultKeyPair()

      Downloads the regional Amazon Lightsail default key pair.

      This action also creates a Lightsail default key pair if a default key pair does not currently exist in the Amazon Web Services Region.

      Returns:
      A Java Future containing the result of the DownloadDefaultKeyPair operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • enableAddOn

      default CompletableFuture<EnableAddOnResponse> enableAddOn(EnableAddOnRequest enableAddOnRequest)

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

      Parameters:
      enableAddOnRequest -
      Returns:
      A Java Future containing the result of the EnableAddOn operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • enableAddOn

      default CompletableFuture<EnableAddOnResponse> enableAddOn(Consumer<EnableAddOnRequest.Builder> enableAddOnRequest)

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


      This is a convenience which creates an instance of the EnableAddOnRequest.Builder avoiding the need to create one manually via EnableAddOnRequest.builder()

      Parameters:
      enableAddOnRequest - A Consumer that will call methods on EnableAddOnRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the EnableAddOn operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • exportSnapshot

      default CompletableFuture<ExportSnapshotResponse> exportSnapshot(ExportSnapshotRequest exportSnapshotRequest)

      Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot record that can be used with the create cloud formation stack operation to create new Amazon EC2 instances.

      Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot.

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

      Use the get instance snapshots or get disk snapshots operations to get a list of snapshots that you can export to Amazon EC2.

      Parameters:
      exportSnapshotRequest -
      Returns:
      A Java Future containing the result of the ExportSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • exportSnapshot

      default CompletableFuture<ExportSnapshotResponse> exportSnapshot(Consumer<ExportSnapshotRequest.Builder> exportSnapshotRequest)

      Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot record that can be used with the create cloud formation stack operation to create new Amazon EC2 instances.

      Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot.

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

      Use the get instance snapshots or get disk snapshots operations to get a list of snapshots that you can export to Amazon EC2.


      This is a convenience which creates an instance of the ExportSnapshotRequest.Builder avoiding the need to create one manually via ExportSnapshotRequest.builder()

      Parameters:
      exportSnapshotRequest - A Consumer that will call methods on ExportSnapshotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ExportSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getActiveNames

      default CompletableFuture<GetActiveNamesResponse> getActiveNames(GetActiveNamesRequest getActiveNamesRequest)

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

      Parameters:
      getActiveNamesRequest -
      Returns:
      A Java Future containing the result of the GetActiveNames operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getActiveNames

      default CompletableFuture<GetActiveNamesResponse> getActiveNames(Consumer<GetActiveNamesRequest.Builder> getActiveNamesRequest)

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


      This is a convenience which creates an instance of the GetActiveNamesRequest.Builder avoiding the need to create one manually via GetActiveNamesRequest.builder()

      Parameters:
      getActiveNamesRequest - A Consumer that will call methods on GetActiveNamesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetActiveNames operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getActiveNames

      default CompletableFuture<GetActiveNamesResponse> getActiveNames()

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

      Returns:
      A Java Future containing the result of the GetActiveNames operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAlarms

      default CompletableFuture<GetAlarmsResponse> getAlarms(GetAlarmsRequest getAlarmsRequest)

      Returns information about the configured alarms. Specify an alarm name in your request to return information about a specific alarm, or specify a monitored resource name to return information about all alarms for a specific resource.

      An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.

      Parameters:
      getAlarmsRequest -
      Returns:
      A Java Future containing the result of the GetAlarms operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • OperationFailureException Lightsail throws this exception when an operation fails to execute.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAlarms

      default CompletableFuture<GetAlarmsResponse> getAlarms(Consumer<GetAlarmsRequest.Builder> getAlarmsRequest)

      Returns information about the configured alarms. Specify an alarm name in your request to return information about a specific alarm, or specify a monitored resource name to return information about all alarms for a specific resource.

      An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.


      This is a convenience which creates an instance of the GetAlarmsRequest.Builder avoiding the need to create one manually via GetAlarmsRequest.builder()

      Parameters:
      getAlarmsRequest - A Consumer that will call methods on GetAlarmsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAlarms operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • OperationFailureException Lightsail throws this exception when an operation fails to execute.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAutoSnapshots

      default CompletableFuture<GetAutoSnapshotsResponse> getAutoSnapshots(GetAutoSnapshotsRequest getAutoSnapshotsRequest)

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

      Parameters:
      getAutoSnapshotsRequest -
      Returns:
      A Java Future containing the result of the GetAutoSnapshots operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAutoSnapshots

      default CompletableFuture<GetAutoSnapshotsResponse> getAutoSnapshots(Consumer<GetAutoSnapshotsRequest.Builder> getAutoSnapshotsRequest)

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


      This is a convenience which creates an instance of the GetAutoSnapshotsRequest.Builder avoiding the need to create one manually via GetAutoSnapshotsRequest.builder()

      Parameters:
      getAutoSnapshotsRequest - A Consumer that will call methods on GetAutoSnapshotsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAutoSnapshots operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBlueprints

      default CompletableFuture<GetBlueprintsResponse> getBlueprints(GetBlueprintsRequest getBlueprintsRequest)

      Returns the list of available instance images, or blueprints. You can use a blueprint to create a new instance already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.

      Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.

      Parameters:
      getBlueprintsRequest -
      Returns:
      A Java Future containing the result of the GetBlueprints operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBlueprints

      default CompletableFuture<GetBlueprintsResponse> getBlueprints(Consumer<GetBlueprintsRequest.Builder> getBlueprintsRequest)

      Returns the list of available instance images, or blueprints. You can use a blueprint to create a new instance already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.

      Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.


      This is a convenience which creates an instance of the GetBlueprintsRequest.Builder avoiding the need to create one manually via GetBlueprintsRequest.builder()

      Parameters:
      getBlueprintsRequest - A Consumer that will call methods on GetBlueprintsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBlueprints operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBlueprints

      default CompletableFuture<GetBlueprintsResponse> getBlueprints()

      Returns the list of available instance images, or blueprints. You can use a blueprint to create a new instance already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.

      Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.

      Returns:
      A Java Future containing the result of the GetBlueprints operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBucketAccessKeys

      default CompletableFuture<GetBucketAccessKeysResponse> getBucketAccessKeys(GetBucketAccessKeysRequest getBucketAccessKeysRequest)

      Returns the existing access key IDs for the specified Amazon Lightsail bucket.

      This action does not return the secret access key value of an access key. You can get a secret access key only when you create it from the response of the CreateBucketAccessKey action. If you lose the secret access key, you must create a new access key.

      Parameters:
      getBucketAccessKeysRequest -
      Returns:
      A Java Future containing the result of the GetBucketAccessKeys operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBucketAccessKeys

      default CompletableFuture<GetBucketAccessKeysResponse> getBucketAccessKeys(Consumer<GetBucketAccessKeysRequest.Builder> getBucketAccessKeysRequest)

      Returns the existing access key IDs for the specified Amazon Lightsail bucket.

      This action does not return the secret access key value of an access key. You can get a secret access key only when you create it from the response of the CreateBucketAccessKey action. If you lose the secret access key, you must create a new access key.


      This is a convenience which creates an instance of the GetBucketAccessKeysRequest.Builder avoiding the need to create one manually via GetBucketAccessKeysRequest.builder()

      Parameters:
      getBucketAccessKeysRequest - A Consumer that will call methods on GetBucketAccessKeysRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBucketAccessKeys operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBucketBundles

      default CompletableFuture<GetBucketBundlesResponse> getBucketBundles(GetBucketBundlesRequest getBucketBundlesRequest)

      Returns the bundles that you can apply to a Amazon Lightsail bucket.

      The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a bucket.

      Use the UpdateBucketBundle action to update the bundle for a bucket.

      Parameters:
      getBucketBundlesRequest -
      Returns:
      A Java Future containing the result of the GetBucketBundles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBucketBundles

      default CompletableFuture<GetBucketBundlesResponse> getBucketBundles(Consumer<GetBucketBundlesRequest.Builder> getBucketBundlesRequest)

      Returns the bundles that you can apply to a Amazon Lightsail bucket.

      The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a bucket.

      Use the UpdateBucketBundle action to update the bundle for a bucket.


      This is a convenience which creates an instance of the GetBucketBundlesRequest.Builder avoiding the need to create one manually via GetBucketBundlesRequest.builder()

      Parameters:
      getBucketBundlesRequest - A Consumer that will call methods on GetBucketBundlesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBucketBundles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBucketMetricData

      default CompletableFuture<GetBucketMetricDataResponse> getBucketMetricData(GetBucketMetricDataRequest getBucketMetricDataRequest)

      Returns the data points of a specific metric for an Amazon Lightsail bucket.

      Metrics report the utilization of a bucket. View and collect metric data regularly to monitor the number of objects stored in a bucket (including object versions) and the storage space used by those objects.

      Parameters:
      getBucketMetricDataRequest -
      Returns:
      A Java Future containing the result of the GetBucketMetricData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBucketMetricData

      default CompletableFuture<GetBucketMetricDataResponse> getBucketMetricData(Consumer<GetBucketMetricDataRequest.Builder> getBucketMetricDataRequest)

      Returns the data points of a specific metric for an Amazon Lightsail bucket.

      Metrics report the utilization of a bucket. View and collect metric data regularly to monitor the number of objects stored in a bucket (including object versions) and the storage space used by those objects.


      This is a convenience which creates an instance of the GetBucketMetricDataRequest.Builder avoiding the need to create one manually via GetBucketMetricDataRequest.builder()

      Parameters:
      getBucketMetricDataRequest - A Consumer that will call methods on GetBucketMetricDataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBucketMetricData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBuckets

      default CompletableFuture<GetBucketsResponse> getBuckets(GetBucketsRequest getBucketsRequest)

      Returns information about one or more Amazon Lightsail buckets. The information returned includes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account-level block public access feature for your Lightsail buckets.

      For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.

      Parameters:
      getBucketsRequest -
      Returns:
      A Java Future containing the result of the GetBuckets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBuckets

      default CompletableFuture<GetBucketsResponse> getBuckets(Consumer<GetBucketsRequest.Builder> getBucketsRequest)

      Returns information about one or more Amazon Lightsail buckets. The information returned includes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account-level block public access feature for your Lightsail buckets.

      For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.


      This is a convenience which creates an instance of the GetBucketsRequest.Builder avoiding the need to create one manually via GetBucketsRequest.builder()

      Parameters:
      getBucketsRequest - A Consumer that will call methods on GetBucketsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBuckets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBundles

      default CompletableFuture<GetBundlesResponse> getBundles(GetBundlesRequest getBundlesRequest)

      Returns the bundles that you can apply to an Amazon Lightsail instance when you create it.

      A bundle describes the specifications of an instance, such as the monthly cost, amount of memory, the number of vCPUs, amount of storage space, and monthly network data transfer quota.

      Bundles are referred to as instance plans in the Lightsail console.

      Parameters:
      getBundlesRequest -
      Returns:
      A Java Future containing the result of the GetBundles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBundles

      default CompletableFuture<GetBundlesResponse> getBundles(Consumer<GetBundlesRequest.Builder> getBundlesRequest)

      Returns the bundles that you can apply to an Amazon Lightsail instance when you create it.

      A bundle describes the specifications of an instance, such as the monthly cost, amount of memory, the number of vCPUs, amount of storage space, and monthly network data transfer quota.

      Bundles are referred to as instance plans in the Lightsail console.


      This is a convenience which creates an instance of the GetBundlesRequest.Builder avoiding the need to create one manually via GetBundlesRequest.builder()

      Parameters:
      getBundlesRequest - A Consumer that will call methods on GetBundlesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetBundles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getBundles

      default CompletableFuture<GetBundlesResponse> getBundles()

      Returns the bundles that you can apply to an Amazon Lightsail instance when you create it.

      A bundle describes the specifications of an instance, such as the monthly cost, amount of memory, the number of vCPUs, amount of storage space, and monthly network data transfer quota.

      Bundles are referred to as instance plans in the Lightsail console.

      Returns:
      A Java Future containing the result of the GetBundles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCertificates

      default CompletableFuture<GetCertificatesResponse> getCertificates(GetCertificatesRequest getCertificatesRequest)

      Returns information about one or more Amazon Lightsail SSL/TLS certificates.

      To get a summary of a certificate, omit includeCertificateDetails from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.

      Parameters:
      getCertificatesRequest -
      Returns:
      A Java Future containing the result of the GetCertificates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCertificates

      default CompletableFuture<GetCertificatesResponse> getCertificates(Consumer<GetCertificatesRequest.Builder> getCertificatesRequest)

      Returns information about one or more Amazon Lightsail SSL/TLS certificates.

      To get a summary of a certificate, omit includeCertificateDetails from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.


      This is a convenience which creates an instance of the GetCertificatesRequest.Builder avoiding the need to create one manually via GetCertificatesRequest.builder()

      Parameters:
      getCertificatesRequest - A Consumer that will call methods on GetCertificatesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetCertificates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCloudFormationStackRecords

      default CompletableFuture<GetCloudFormationStackRecordsResponse> getCloudFormationStackRecords(GetCloudFormationStackRecordsRequest getCloudFormationStackRecordsRequest)

      Returns the CloudFormation stack record created as a result of the create cloud formation stack operation.

      An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail snapshot.

      Parameters:
      getCloudFormationStackRecordsRequest -
      Returns:
      A Java Future containing the result of the GetCloudFormationStackRecords operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCloudFormationStackRecords

      default CompletableFuture<GetCloudFormationStackRecordsResponse> getCloudFormationStackRecords(Consumer<GetCloudFormationStackRecordsRequest.Builder> getCloudFormationStackRecordsRequest)

      Returns the CloudFormation stack record created as a result of the create cloud formation stack operation.

      An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail snapshot.


      This is a convenience which creates an instance of the GetCloudFormationStackRecordsRequest.Builder avoiding the need to create one manually via GetCloudFormationStackRecordsRequest.builder()

      Parameters:
      getCloudFormationStackRecordsRequest - A Consumer that will call methods on GetCloudFormationStackRecordsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetCloudFormationStackRecords operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCloudFormationStackRecords

      default CompletableFuture<GetCloudFormationStackRecordsResponse> getCloudFormationStackRecords()

      Returns the CloudFormation stack record created as a result of the create cloud formation stack operation.

      An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail snapshot.

      Returns:
      A Java Future containing the result of the GetCloudFormationStackRecords operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContactMethods

      default CompletableFuture<GetContactMethodsResponse> getContactMethods(GetContactMethodsRequest getContactMethodsRequest)

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

      A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

      Parameters:
      getContactMethodsRequest -
      Returns:
      A Java Future containing the result of the GetContactMethods operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContactMethods

      default CompletableFuture<GetContactMethodsResponse> getContactMethods(Consumer<GetContactMethodsRequest.Builder> getContactMethodsRequest)

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

      A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.


      This is a convenience which creates an instance of the GetContactMethodsRequest.Builder avoiding the need to create one manually via GetContactMethodsRequest.builder()

      Parameters:
      getContactMethodsRequest - A Consumer that will call methods on GetContactMethodsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetContactMethods operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContainerAPIMetadata

      default CompletableFuture<GetContainerApiMetadataResponse> getContainerAPIMetadata(GetContainerApiMetadataRequest getContainerApiMetadataRequest)

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

      Parameters:
      getContainerApiMetadataRequest -
      Returns:
      A Java Future containing the result of the GetContainerAPIMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException A general service exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContainerAPIMetadata

      default CompletableFuture<GetContainerApiMetadataResponse> getContainerAPIMetadata(Consumer<GetContainerApiMetadataRequest.Builder> getContainerApiMetadataRequest)

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


      This is a convenience which creates an instance of the GetContainerApiMetadataRequest.Builder avoiding the need to create one manually via GetContainerApiMetadataRequest.builder()

      Parameters:
      getContainerApiMetadataRequest - A Consumer that will call methods on GetContainerApiMetadataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetContainerAPIMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException A general service exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContainerImages

      default CompletableFuture<GetContainerImagesResponse> getContainerImages(GetContainerImagesRequest getContainerImagesRequest)

      Returns the container images that are registered to your Amazon Lightsail container service.

      If you created a deployment on your Lightsail container service that uses container images from a public registry like Docker Hub, those images are not returned as part of this action. Those images are not registered to your Lightsail container service.

      Parameters:
      getContainerImagesRequest -
      Returns:
      A Java Future containing the result of the GetContainerImages operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContainerImages

      default CompletableFuture<GetContainerImagesResponse> getContainerImages(Consumer<GetContainerImagesRequest.Builder> getContainerImagesRequest)

      Returns the container images that are registered to your Amazon Lightsail container service.

      If you created a deployment on your Lightsail container service that uses container images from a public registry like Docker Hub, those images are not returned as part of this action. Those images are not registered to your Lightsail container service.


      This is a convenience which creates an instance of the GetContainerImagesRequest.Builder avoiding the need to create one manually via GetContainerImagesRequest.builder()

      Parameters:
      getContainerImagesRequest - A Consumer that will call methods on GetContainerImagesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetContainerImages operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContainerLog

      default CompletableFuture<GetContainerLogResponse> getContainerLog(GetContainerLogRequest getContainerLogRequest)

      Returns the log events of a container of your Amazon Lightsail container service.

      If your container service has more than one node (i.e., a scale greater than 1), then the log events that are returned for the specified container are merged from all nodes on your container service.

      Container logs are retained for a certain amount of time. For more information, see Amazon Lightsail endpoints and quotas in the Amazon Web Services General Reference.

      Parameters:
      getContainerLogRequest -
      Returns:
      A Java Future containing the result of the GetContainerLog operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContainerLog

      default CompletableFuture<GetContainerLogResponse> getContainerLog(Consumer<GetContainerLogRequest.Builder> getContainerLogRequest)

      Returns the log events of a container of your Amazon Lightsail container service.

      If your container service has more than one node (i.e., a scale greater than 1), then the log events that are returned for the specified container are merged from all nodes on your container service.

      Container logs are retained for a certain amount of time. For more information, see Amazon Lightsail endpoints and quotas in the Amazon Web Services General Reference.


      This is a convenience which creates an instance of the GetContainerLogRequest.Builder avoiding the need to create one manually via GetContainerLogRequest.builder()

      Parameters:
      getContainerLogRequest - A Consumer that will call methods on GetContainerLogRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetContainerLog operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContainerServiceDeployments

      default CompletableFuture<GetContainerServiceDeploymentsResponse> getContainerServiceDeployments(GetContainerServiceDeploymentsRequest getContainerServiceDeploymentsRequest)

      Returns the deployments for your Amazon Lightsail container service

      A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.

      The deployments are ordered by version in ascending order. The newest version is listed at the top of the response.

      A set number of deployments are kept before the oldest one is replaced with the newest one. For more information, see Amazon Lightsail endpoints and quotas in the Amazon Web Services General Reference.

      Parameters:
      getContainerServiceDeploymentsRequest -
      Returns:
      A Java Future containing the result of the GetContainerServiceDeployments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContainerServiceDeployments

      default CompletableFuture<GetContainerServiceDeploymentsResponse> getContainerServiceDeployments(Consumer<GetContainerServiceDeploymentsRequest.Builder> getContainerServiceDeploymentsRequest)

      Returns the deployments for your Amazon Lightsail container service

      A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.

      The deployments are ordered by version in ascending order. The newest version is listed at the top of the response.

      A set number of deployments are kept before the oldest one is replaced with the newest one. For more information, see Amazon Lightsail endpoints and quotas in the Amazon Web Services General Reference.


      This is a convenience which creates an instance of the GetContainerServiceDeploymentsRequest.Builder avoiding the need to create one manually via GetContainerServiceDeploymentsRequest.builder()

      Parameters:
      getContainerServiceDeploymentsRequest - A Consumer that will call methods on GetContainerServiceDeploymentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetContainerServiceDeployments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContainerServiceMetricData

      default CompletableFuture<GetContainerServiceMetricDataResponse> getContainerServiceMetricData(GetContainerServiceMetricDataRequest getContainerServiceMetricDataRequest)

      Returns the data points of a specific metric of your Amazon Lightsail container service.

      Metrics report the utilization of your resources. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

      Parameters:
      getContainerServiceMetricDataRequest -
      Returns:
      A Java Future containing the result of the GetContainerServiceMetricData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContainerServiceMetricData

      default CompletableFuture<GetContainerServiceMetricDataResponse> getContainerServiceMetricData(Consumer<GetContainerServiceMetricDataRequest.Builder> getContainerServiceMetricDataRequest)

      Returns the data points of a specific metric of your Amazon Lightsail container service.

      Metrics report the utilization of your resources. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.


      This is a convenience which creates an instance of the GetContainerServiceMetricDataRequest.Builder avoiding the need to create one manually via GetContainerServiceMetricDataRequest.builder()

      Parameters:
      getContainerServiceMetricDataRequest - A Consumer that will call methods on GetContainerServiceMetricDataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetContainerServiceMetricData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContainerServicePowers

      default CompletableFuture<GetContainerServicePowersResponse> getContainerServicePowers(GetContainerServicePowersRequest getContainerServicePowersRequest)

      Returns the list of powers that can be specified for your Amazon Lightsail container services.

      The power specifies the amount of memory, the number of vCPUs, and the base price of the container service.

      Parameters:
      getContainerServicePowersRequest -
      Returns:
      A Java Future containing the result of the GetContainerServicePowers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContainerServicePowers

      default CompletableFuture<GetContainerServicePowersResponse> getContainerServicePowers(Consumer<GetContainerServicePowersRequest.Builder> getContainerServicePowersRequest)

      Returns the list of powers that can be specified for your Amazon Lightsail container services.

      The power specifies the amount of memory, the number of vCPUs, and the base price of the container service.


      This is a convenience which creates an instance of the GetContainerServicePowersRequest.Builder avoiding the need to create one manually via GetContainerServicePowersRequest.builder()

      Parameters:
      getContainerServicePowersRequest - A Consumer that will call methods on GetContainerServicePowersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetContainerServicePowers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContainerServices

      default CompletableFuture<GetContainerServicesResponse> getContainerServices(GetContainerServicesRequest getContainerServicesRequest)

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

      Parameters:
      getContainerServicesRequest -
      Returns:
      A Java Future containing the result of the GetContainerServices operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getContainerServices

      default CompletableFuture<GetContainerServicesResponse> getContainerServices(Consumer<GetContainerServicesRequest.Builder> getContainerServicesRequest)

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


      This is a convenience which creates an instance of the GetContainerServicesRequest.Builder avoiding the need to create one manually via GetContainerServicesRequest.builder()

      Parameters:
      getContainerServicesRequest - A Consumer that will call methods on GetContainerServicesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetContainerServices operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCostEstimate

      default CompletableFuture<GetCostEstimateResponse> getCostEstimate(GetCostEstimateRequest getCostEstimateRequest)

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

      Parameters:
      getCostEstimateRequest -
      Returns:
      A Java Future containing the result of the GetCostEstimate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getCostEstimate

      default CompletableFuture<GetCostEstimateResponse> getCostEstimate(Consumer<GetCostEstimateRequest.Builder> getCostEstimateRequest)

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


      This is a convenience which creates an instance of the GetCostEstimateRequest.Builder avoiding the need to create one manually via GetCostEstimateRequest.builder()

      Parameters:
      getCostEstimateRequest - A Consumer that will call methods on GetCostEstimateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetCostEstimate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDisk

      default CompletableFuture<GetDiskResponse> getDisk(GetDiskRequest getDiskRequest)

      Returns information about a specific block storage disk.

      Parameters:
      getDiskRequest -
      Returns:
      A Java Future containing the result of the GetDisk operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDisk

      default CompletableFuture<GetDiskResponse> getDisk(Consumer<GetDiskRequest.Builder> getDiskRequest)

      Returns information about a specific block storage disk.


      This is a convenience which creates an instance of the GetDiskRequest.Builder avoiding the need to create one manually via GetDiskRequest.builder()

      Parameters:
      getDiskRequest - A Consumer that will call methods on GetDiskRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDisk operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDiskSnapshot

      default CompletableFuture<GetDiskSnapshotResponse> getDiskSnapshot(GetDiskSnapshotRequest getDiskSnapshotRequest)

      Returns information about a specific block storage disk snapshot.

      Parameters:
      getDiskSnapshotRequest -
      Returns:
      A Java Future containing the result of the GetDiskSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDiskSnapshot

      default CompletableFuture<GetDiskSnapshotResponse> getDiskSnapshot(Consumer<GetDiskSnapshotRequest.Builder> getDiskSnapshotRequest)

      Returns information about a specific block storage disk snapshot.


      This is a convenience which creates an instance of the GetDiskSnapshotRequest.Builder avoiding the need to create one manually via GetDiskSnapshotRequest.builder()

      Parameters:
      getDiskSnapshotRequest - A Consumer that will call methods on GetDiskSnapshotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDiskSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDiskSnapshots

      default CompletableFuture<GetDiskSnapshotsResponse> getDiskSnapshots(GetDiskSnapshotsRequest getDiskSnapshotsRequest)

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

      Parameters:
      getDiskSnapshotsRequest -
      Returns:
      A Java Future containing the result of the GetDiskSnapshots operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDiskSnapshots

      default CompletableFuture<GetDiskSnapshotsResponse> getDiskSnapshots(Consumer<GetDiskSnapshotsRequest.Builder> getDiskSnapshotsRequest)

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


      This is a convenience which creates an instance of the GetDiskSnapshotsRequest.Builder avoiding the need to create one manually via GetDiskSnapshotsRequest.builder()

      Parameters:
      getDiskSnapshotsRequest - A Consumer that will call methods on GetDiskSnapshotsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDiskSnapshots operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDiskSnapshots

      default CompletableFuture<GetDiskSnapshotsResponse> getDiskSnapshots()

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

      Returns:
      A Java Future containing the result of the GetDiskSnapshots operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDisks

      default CompletableFuture<GetDisksResponse> getDisks(GetDisksRequest getDisksRequest)

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

      Parameters:
      getDisksRequest -
      Returns:
      A Java Future containing the result of the GetDisks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDisks

      default CompletableFuture<GetDisksResponse> getDisks(Consumer<GetDisksRequest.Builder> getDisksRequest)

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


      This is a convenience which creates an instance of the GetDisksRequest.Builder avoiding the need to create one manually via GetDisksRequest.builder()

      Parameters:
      getDisksRequest - A Consumer that will call methods on GetDisksRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDisks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDisks

      default CompletableFuture<GetDisksResponse> getDisks()

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

      Returns:
      A Java Future containing the result of the GetDisks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDistributionBundles

      default CompletableFuture<GetDistributionBundlesResponse> getDistributionBundles(GetDistributionBundlesRequest getDistributionBundlesRequest)

      Returns the bundles that can be applied to your Amazon Lightsail content delivery network (CDN) distributions.

      A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution.

      Parameters:
      getDistributionBundlesRequest -
      Returns:
      A Java Future containing the result of the GetDistributionBundles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDistributionBundles

      default CompletableFuture<GetDistributionBundlesResponse> getDistributionBundles(Consumer<GetDistributionBundlesRequest.Builder> getDistributionBundlesRequest)

      Returns the bundles that can be applied to your Amazon Lightsail content delivery network (CDN) distributions.

      A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution.


      This is a convenience which creates an instance of the GetDistributionBundlesRequest.Builder avoiding the need to create one manually via GetDistributionBundlesRequest.builder()

      Parameters:
      getDistributionBundlesRequest - A Consumer that will call methods on GetDistributionBundlesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDistributionBundles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDistributionLatestCacheReset

      default CompletableFuture<GetDistributionLatestCacheResetResponse> getDistributionLatestCacheReset(GetDistributionLatestCacheResetRequest getDistributionLatestCacheResetRequest)

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

      Parameters:
      getDistributionLatestCacheResetRequest -
      Returns:
      A Java Future containing the result of the GetDistributionLatestCacheReset operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDistributionLatestCacheReset

      default CompletableFuture<GetDistributionLatestCacheResetResponse> getDistributionLatestCacheReset(Consumer<GetDistributionLatestCacheResetRequest.Builder> getDistributionLatestCacheResetRequest)

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


      This is a convenience which creates an instance of the GetDistributionLatestCacheResetRequest.Builder avoiding the need to create one manually via GetDistributionLatestCacheResetRequest.builder()

      Parameters:
      getDistributionLatestCacheResetRequest - A Consumer that will call methods on GetDistributionLatestCacheResetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDistributionLatestCacheReset operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDistributionMetricData

      default CompletableFuture<GetDistributionMetricDataResponse> getDistributionMetricData(GetDistributionMetricDataRequest getDistributionMetricDataRequest)

      Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.

      Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

      Parameters:
      getDistributionMetricDataRequest -
      Returns:
      A Java Future containing the result of the GetDistributionMetricData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDistributionMetricData

      default CompletableFuture<GetDistributionMetricDataResponse> getDistributionMetricData(Consumer<GetDistributionMetricDataRequest.Builder> getDistributionMetricDataRequest)

      Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.

      Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.


      This is a convenience which creates an instance of the GetDistributionMetricDataRequest.Builder avoiding the need to create one manually via GetDistributionMetricDataRequest.builder()

      Parameters:
      getDistributionMetricDataRequest - A Consumer that will call methods on GetDistributionMetricDataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDistributionMetricData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDistributions

      default CompletableFuture<GetDistributionsResponse> getDistributions(GetDistributionsRequest getDistributionsRequest)

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

      Parameters:
      getDistributionsRequest -
      Returns:
      A Java Future containing the result of the GetDistributions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDistributions

      default CompletableFuture<GetDistributionsResponse> getDistributions(Consumer<GetDistributionsRequest.Builder> getDistributionsRequest)

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


      This is a convenience which creates an instance of the GetDistributionsRequest.Builder avoiding the need to create one manually via GetDistributionsRequest.builder()

      Parameters:
      getDistributionsRequest - A Consumer that will call methods on GetDistributionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDistributions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDomain

      default CompletableFuture<GetDomainResponse> getDomain(GetDomainRequest getDomainRequest)

      Returns information about a specific domain recordset.

      Parameters:
      getDomainRequest -
      Returns:
      A Java Future containing the result of the GetDomain operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDomain

      default CompletableFuture<GetDomainResponse> getDomain(Consumer<GetDomainRequest.Builder> getDomainRequest)

      Returns information about a specific domain recordset.


      This is a convenience which creates an instance of the GetDomainRequest.Builder avoiding the need to create one manually via GetDomainRequest.builder()

      Parameters:
      getDomainRequest - A Consumer that will call methods on GetDomainRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDomain operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDomains

      default CompletableFuture<GetDomainsResponse> getDomains(GetDomainsRequest getDomainsRequest)

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

      Parameters:
      getDomainsRequest -
      Returns:
      A Java Future containing the result of the GetDomains operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDomains

      default CompletableFuture<GetDomainsResponse> getDomains(Consumer<GetDomainsRequest.Builder> getDomainsRequest)

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


      This is a convenience which creates an instance of the GetDomainsRequest.Builder avoiding the need to create one manually via GetDomainsRequest.builder()

      Parameters:
      getDomainsRequest - A Consumer that will call methods on GetDomainsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDomains operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDomains

      default CompletableFuture<GetDomainsResponse> getDomains()

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

      Returns:
      A Java Future containing the result of the GetDomains operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getExportSnapshotRecords

      default CompletableFuture<GetExportSnapshotRecordsResponse> getExportSnapshotRecords(GetExportSnapshotRecordsRequest getExportSnapshotRecordsRequest)

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

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

      Parameters:
      getExportSnapshotRecordsRequest -
      Returns:
      A Java Future containing the result of the GetExportSnapshotRecords operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getExportSnapshotRecords

      default CompletableFuture<GetExportSnapshotRecordsResponse> getExportSnapshotRecords(Consumer<GetExportSnapshotRecordsRequest.Builder> getExportSnapshotRecordsRequest)

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

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


      This is a convenience which creates an instance of the GetExportSnapshotRecordsRequest.Builder avoiding the need to create one manually via GetExportSnapshotRecordsRequest.builder()

      Parameters:
      getExportSnapshotRecordsRequest - A Consumer that will call methods on GetExportSnapshotRecordsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetExportSnapshotRecords operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getExportSnapshotRecords

      default CompletableFuture<GetExportSnapshotRecordsResponse> getExportSnapshotRecords()

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

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

      Returns:
      A Java Future containing the result of the GetExportSnapshotRecords operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInstance

      default CompletableFuture<GetInstanceResponse> getInstance(GetInstanceRequest getInstanceRequest)

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

      Parameters:
      getInstanceRequest -
      Returns:
      A Java Future containing the result of the GetInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInstance

      default CompletableFuture<GetInstanceResponse> getInstance(Consumer<GetInstanceRequest.Builder> getInstanceRequest)

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


      This is a convenience which creates an instance of the GetInstanceRequest.Builder avoiding the need to create one manually via GetInstanceRequest.builder()

      Parameters:
      getInstanceRequest - A Consumer that will call methods on GetInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInstanceAccessDetails

      default CompletableFuture<GetInstanceAccessDetailsResponse> getInstanceAccessDetails(GetInstanceAccessDetailsRequest getInstanceAccessDetailsRequest)

      Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.

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

      Parameters:
      getInstanceAccessDetailsRequest -
      Returns:
      A Java Future containing the result of the GetInstanceAccessDetails operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInstanceAccessDetails

      default CompletableFuture<GetInstanceAccessDetailsResponse> getInstanceAccessDetails(Consumer<GetInstanceAccessDetailsRequest.Builder> getInstanceAccessDetailsRequest)

      Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.

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


      This is a convenience which creates an instance of the GetInstanceAccessDetailsRequest.Builder avoiding the need to create one manually via GetInstanceAccessDetailsRequest.builder()

      Parameters:
      getInstanceAccessDetailsRequest - A Consumer that will call methods on GetInstanceAccessDetailsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetInstanceAccessDetails operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInstanceMetricData

      default CompletableFuture<GetInstanceMetricDataResponse> getInstanceMetricData(GetInstanceMetricDataRequest getInstanceMetricDataRequest)

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

      Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

      Parameters:
      getInstanceMetricDataRequest -
      Returns:
      A Java Future containing the result of the GetInstanceMetricData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInstanceMetricData

      default CompletableFuture<GetInstanceMetricDataResponse> getInstanceMetricData(Consumer<GetInstanceMetricDataRequest.Builder> getInstanceMetricDataRequest)

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

      Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.


      This is a convenience which creates an instance of the GetInstanceMetricDataRequest.Builder avoiding the need to create one manually via GetInstanceMetricDataRequest.builder()

      Parameters:
      getInstanceMetricDataRequest - A Consumer that will call methods on GetInstanceMetricDataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetInstanceMetricData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInstancePortStates

      default CompletableFuture<GetInstancePortStatesResponse> getInstancePortStates(GetInstancePortStatesRequest getInstancePortStatesRequest)

      Returns the firewall port states for a specific Amazon Lightsail instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.

      Parameters:
      getInstancePortStatesRequest -
      Returns:
      A Java Future containing the result of the GetInstancePortStates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInstancePortStates

      default CompletableFuture<GetInstancePortStatesResponse> getInstancePortStates(Consumer<GetInstancePortStatesRequest.Builder> getInstancePortStatesRequest)

      Returns the firewall port states for a specific Amazon Lightsail instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.


      This is a convenience which creates an instance of the GetInstancePortStatesRequest.Builder avoiding the need to create one manually via GetInstancePortStatesRequest.builder()

      Parameters:
      getInstancePortStatesRequest - A Consumer that will call methods on GetInstancePortStatesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetInstancePortStates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInstanceSnapshot

      default CompletableFuture<GetInstanceSnapshotResponse> getInstanceSnapshot(GetInstanceSnapshotRequest getInstanceSnapshotRequest)

      Returns information about a specific instance snapshot.

      Parameters:
      getInstanceSnapshotRequest -
      Returns:
      A Java Future containing the result of the GetInstanceSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInstanceSnapshot

      default CompletableFuture<GetInstanceSnapshotResponse> getInstanceSnapshot(Consumer<GetInstanceSnapshotRequest.Builder> getInstanceSnapshotRequest)

      Returns information about a specific instance snapshot.


      This is a convenience which creates an instance of the GetInstanceSnapshotRequest.Builder avoiding the need to create one manually via GetInstanceSnapshotRequest.builder()

      Parameters:
      getInstanceSnapshotRequest - A Consumer that will call methods on GetInstanceSnapshotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetInstanceSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInstanceSnapshots

      default CompletableFuture<GetInstanceSnapshotsResponse> getInstanceSnapshots(GetInstanceSnapshotsRequest getInstanceSnapshotsRequest)

      Returns all instance snapshots for the user's account.

      Parameters:
      getInstanceSnapshotsRequest -
      Returns:
      A Java Future containing the result of the GetInstanceSnapshots operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInstanceSnapshots

      default CompletableFuture<GetInstanceSnapshotsResponse> getInstanceSnapshots(Consumer<GetInstanceSnapshotsRequest.Builder> getInstanceSnapshotsRequest)

      Returns all instance snapshots for the user's account.


      This is a convenience which creates an instance of the GetInstanceSnapshotsRequest.Builder avoiding the need to create one manually via GetInstanceSnapshotsRequest.builder()

      Parameters:
      getInstanceSnapshotsRequest - A Consumer that will call methods on GetInstanceSnapshotsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetInstanceSnapshots operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInstanceSnapshots

      default CompletableFuture<GetInstanceSnapshotsResponse> getInstanceSnapshots()

      Returns all instance snapshots for the user's account.

      Returns:
      A Java Future containing the result of the GetInstanceSnapshots operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInstanceState

      default CompletableFuture<GetInstanceStateResponse> getInstanceState(GetInstanceStateRequest getInstanceStateRequest)

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

      Parameters:
      getInstanceStateRequest -
      Returns:
      A Java Future containing the result of the GetInstanceState operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInstanceState

      default CompletableFuture<GetInstanceStateResponse> getInstanceState(Consumer<GetInstanceStateRequest.Builder> getInstanceStateRequest)

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


      This is a convenience which creates an instance of the GetInstanceStateRequest.Builder avoiding the need to create one manually via GetInstanceStateRequest.builder()

      Parameters:
      getInstanceStateRequest - A Consumer that will call methods on GetInstanceStateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetInstanceState operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInstances

      default CompletableFuture<GetInstancesResponse> getInstances(GetInstancesRequest getInstancesRequest)

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

      Parameters:
      getInstancesRequest -
      Returns:
      A Java Future containing the result of the GetInstances operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInstances

      default CompletableFuture<GetInstancesResponse> getInstances(Consumer<GetInstancesRequest.Builder> getInstancesRequest)

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


      This is a convenience which creates an instance of the GetInstancesRequest.Builder avoiding the need to create one manually via GetInstancesRequest.builder()

      Parameters:
      getInstancesRequest - A Consumer that will call methods on GetInstancesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetInstances operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInstances

      default CompletableFuture<GetInstancesResponse> getInstances()

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

      Returns:
      A Java Future containing the result of the GetInstances operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getKeyPair

      default CompletableFuture<GetKeyPairResponse> getKeyPair(GetKeyPairRequest getKeyPairRequest)

      Returns information about a specific key pair.

      Parameters:
      getKeyPairRequest -
      Returns:
      A Java Future containing the result of the GetKeyPair operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getKeyPair

      default CompletableFuture<GetKeyPairResponse> getKeyPair(Consumer<GetKeyPairRequest.Builder> getKeyPairRequest)

      Returns information about a specific key pair.


      This is a convenience which creates an instance of the GetKeyPairRequest.Builder avoiding the need to create one manually via GetKeyPairRequest.builder()

      Parameters:
      getKeyPairRequest - A Consumer that will call methods on GetKeyPairRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetKeyPair operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getKeyPairs

      default CompletableFuture<GetKeyPairsResponse> getKeyPairs(GetKeyPairsRequest getKeyPairsRequest)

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

      Parameters:
      getKeyPairsRequest -
      Returns:
      A Java Future containing the result of the GetKeyPairs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getKeyPairs

      default CompletableFuture<GetKeyPairsResponse> getKeyPairs(Consumer<GetKeyPairsRequest.Builder> getKeyPairsRequest)

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


      This is a convenience which creates an instance of the GetKeyPairsRequest.Builder avoiding the need to create one manually via GetKeyPairsRequest.builder()

      Parameters:
      getKeyPairsRequest - A Consumer that will call methods on GetKeyPairsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetKeyPairs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getKeyPairs

      default CompletableFuture<GetKeyPairsResponse> getKeyPairs()

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

      Returns:
      A Java Future containing the result of the GetKeyPairs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getLoadBalancer

      default CompletableFuture<GetLoadBalancerResponse> getLoadBalancer(GetLoadBalancerRequest getLoadBalancerRequest)

      Returns information about the specified Lightsail load balancer.

      Parameters:
      getLoadBalancerRequest -
      Returns:
      A Java Future containing the result of the GetLoadBalancer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getLoadBalancer

      default CompletableFuture<GetLoadBalancerResponse> getLoadBalancer(Consumer<GetLoadBalancerRequest.Builder> getLoadBalancerRequest)

      Returns information about the specified Lightsail load balancer.


      This is a convenience which creates an instance of the GetLoadBalancerRequest.Builder avoiding the need to create one manually via GetLoadBalancerRequest.builder()

      Parameters:
      getLoadBalancerRequest - A Consumer that will call methods on GetLoadBalancerRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetLoadBalancer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getLoadBalancerMetricData

      default CompletableFuture<GetLoadBalancerMetricDataResponse> getLoadBalancerMetricData(GetLoadBalancerMetricDataRequest getLoadBalancerMetricDataRequest)

      Returns information about health metrics for your Lightsail load balancer.

      Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

      Parameters:
      getLoadBalancerMetricDataRequest -
      Returns:
      A Java Future containing the result of the GetLoadBalancerMetricData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getLoadBalancerMetricData

      default CompletableFuture<GetLoadBalancerMetricDataResponse> getLoadBalancerMetricData(Consumer<GetLoadBalancerMetricDataRequest.Builder> getLoadBalancerMetricDataRequest)

      Returns information about health metrics for your Lightsail load balancer.

      Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.


      This is a convenience which creates an instance of the GetLoadBalancerMetricDataRequest.Builder avoiding the need to create one manually via GetLoadBalancerMetricDataRequest.builder()

      Parameters:
      getLoadBalancerMetricDataRequest - A Consumer that will call methods on GetLoadBalancerMetricDataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetLoadBalancerMetricData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getLoadBalancerTlsCertificates

      default CompletableFuture<GetLoadBalancerTlsCertificatesResponse> 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:
      A Java Future containing the result of the GetLoadBalancerTlsCertificates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getLoadBalancerTlsCertificates

      default CompletableFuture<GetLoadBalancerTlsCertificatesResponse> getLoadBalancerTlsCertificates(Consumer<GetLoadBalancerTlsCertificatesRequest.Builder> 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.


      This is a convenience which creates an instance of the GetLoadBalancerTlsCertificatesRequest.Builder avoiding the need to create one manually via GetLoadBalancerTlsCertificatesRequest.builder()

      Parameters:
      getLoadBalancerTlsCertificatesRequest - A Consumer that will call methods on GetLoadBalancerTlsCertificatesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetLoadBalancerTlsCertificates operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getLoadBalancerTlsPolicies

      default CompletableFuture<GetLoadBalancerTlsPoliciesResponse> getLoadBalancerTlsPolicies(GetLoadBalancerTlsPoliciesRequest getLoadBalancerTlsPoliciesRequest)

      Returns a list of TLS security policies that you can apply to Lightsail load balancers.

      For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide.

      Parameters:
      getLoadBalancerTlsPoliciesRequest -
      Returns:
      A Java Future containing the result of the GetLoadBalancerTlsPolicies operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException A general service exception.
      • 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.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getLoadBalancerTlsPolicies

      default CompletableFuture<GetLoadBalancerTlsPoliciesResponse> getLoadBalancerTlsPolicies(Consumer<GetLoadBalancerTlsPoliciesRequest.Builder> getLoadBalancerTlsPoliciesRequest)

      Returns a list of TLS security policies that you can apply to Lightsail load balancers.

      For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide.


      This is a convenience which creates an instance of the GetLoadBalancerTlsPoliciesRequest.Builder avoiding the need to create one manually via GetLoadBalancerTlsPoliciesRequest.builder()

      Parameters:
      getLoadBalancerTlsPoliciesRequest - A Consumer that will call methods on GetLoadBalancerTlsPoliciesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetLoadBalancerTlsPolicies operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServiceException A general service exception.
      • 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.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getLoadBalancers

      default CompletableFuture<GetLoadBalancersResponse> getLoadBalancers(GetLoadBalancersRequest getLoadBalancersRequest)

      Returns information about all load balancers in an account.

      Parameters:
      getLoadBalancersRequest -
      Returns:
      A Java Future containing the result of the GetLoadBalancers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getLoadBalancers

      default CompletableFuture<GetLoadBalancersResponse> getLoadBalancers(Consumer<GetLoadBalancersRequest.Builder> getLoadBalancersRequest)

      Returns information about all load balancers in an account.


      This is a convenience which creates an instance of the GetLoadBalancersRequest.Builder avoiding the need to create one manually via GetLoadBalancersRequest.builder()

      Parameters:
      getLoadBalancersRequest - A Consumer that will call methods on GetLoadBalancersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetLoadBalancers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getLoadBalancers

      default CompletableFuture<GetLoadBalancersResponse> getLoadBalancers()

      Returns information about all load balancers in an account.

      Returns:
      A Java Future containing the result of the GetLoadBalancers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getOperation

      default CompletableFuture<GetOperationResponse> 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:
      A Java Future containing the result of the GetOperation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getOperation

      default CompletableFuture<GetOperationResponse> getOperation(Consumer<GetOperationRequest.Builder> 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.


      This is a convenience which creates an instance of the GetOperationRequest.Builder avoiding the need to create one manually via GetOperationRequest.builder()

      Parameters:
      getOperationRequest - A Consumer that will call methods on GetOperationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetOperation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getOperations

      default CompletableFuture<GetOperationsResponse> 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:
      A Java Future containing the result of the GetOperations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getOperations

      default CompletableFuture<GetOperationsResponse> getOperations(Consumer<GetOperationsRequest.Builder> 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.


      This is a convenience which creates an instance of the GetOperationsRequest.Builder avoiding the need to create one manually via GetOperationsRequest.builder()

      Parameters:
      getOperationsRequest - A Consumer that will call methods on GetOperationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetOperations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getOperations

      default CompletableFuture<GetOperationsResponse> getOperations()

      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.

      Returns:
      A Java Future containing the result of the GetOperations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getOperationsForResource

      default CompletableFuture<GetOperationsForResourceResponse> getOperationsForResource(GetOperationsForResourceRequest getOperationsForResourceRequest)

      Gets operations for a specific resource (an instance or a static IP).

      Parameters:
      getOperationsForResourceRequest -
      Returns:
      A Java Future containing the result of the GetOperationsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getOperationsForResource

      default CompletableFuture<GetOperationsForResourceResponse> getOperationsForResource(Consumer<GetOperationsForResourceRequest.Builder> getOperationsForResourceRequest)

      Gets operations for a specific resource (an instance or a static IP).


      This is a convenience which creates an instance of the GetOperationsForResourceRequest.Builder avoiding the need to create one manually via GetOperationsForResourceRequest.builder()

      Parameters:
      getOperationsForResourceRequest - A Consumer that will call methods on GetOperationsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetOperationsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRegions

      default CompletableFuture<GetRegionsResponse> 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:
      A Java Future containing the result of the GetRegions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRegions

      default CompletableFuture<GetRegionsResponse> getRegions(Consumer<GetRegionsRequest.Builder> 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.


      This is a convenience which creates an instance of the GetRegionsRequest.Builder avoiding the need to create one manually via GetRegionsRequest.builder()

      Parameters:
      getRegionsRequest - A Consumer that will call methods on GetRegionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetRegions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRegions

      default CompletableFuture<GetRegionsResponse> getRegions()

      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.

      Returns:
      A Java Future containing the result of the GetRegions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRelationalDatabase

      default CompletableFuture<GetRelationalDatabaseResponse> getRelationalDatabase(GetRelationalDatabaseRequest getRelationalDatabaseRequest)

      Returns information about a specific database in Amazon Lightsail.

      Parameters:
      getRelationalDatabaseRequest -
      Returns:
      A Java Future containing the result of the GetRelationalDatabase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRelationalDatabase

      default CompletableFuture<GetRelationalDatabaseResponse> getRelationalDatabase(Consumer<GetRelationalDatabaseRequest.Builder> getRelationalDatabaseRequest)

      Returns information about a specific database in Amazon Lightsail.


      This is a convenience which creates an instance of the GetRelationalDatabaseRequest.Builder avoiding the need to create one manually via GetRelationalDatabaseRequest.builder()

      Parameters:
      getRelationalDatabaseRequest - A Consumer that will call methods on GetRelationalDatabaseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetRelationalDatabase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRelationalDatabaseBlueprints

      default CompletableFuture<GetRelationalDatabaseBlueprintsResponse> getRelationalDatabaseBlueprints(GetRelationalDatabaseBlueprintsRequest getRelationalDatabaseBlueprintsRequest)

      Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database.

      You can use a blueprint ID to create a new database that runs a specific database engine.

      Parameters:
      getRelationalDatabaseBlueprintsRequest -
      Returns:
      A Java Future containing the result of the GetRelationalDatabaseBlueprints operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRelationalDatabaseBlueprints

      default CompletableFuture<GetRelationalDatabaseBlueprintsResponse> getRelationalDatabaseBlueprints(Consumer<GetRelationalDatabaseBlueprintsRequest.Builder> getRelationalDatabaseBlueprintsRequest)

      Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database.

      You can use a blueprint ID to create a new database that runs a specific database engine.


      This is a convenience which creates an instance of the GetRelationalDatabaseBlueprintsRequest.Builder avoiding the need to create one manually via GetRelationalDatabaseBlueprintsRequest.builder()

      Parameters:
      getRelationalDatabaseBlueprintsRequest - A Consumer that will call methods on GetRelationalDatabaseBlueprintsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetRelationalDatabaseBlueprints operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRelationalDatabaseBlueprints

      default CompletableFuture<GetRelationalDatabaseBlueprintsResponse> getRelationalDatabaseBlueprints()

      Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database.

      You can use a blueprint ID to create a new database that runs a specific database engine.

      Returns:
      A Java Future containing the result of the GetRelationalDatabaseBlueprints operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRelationalDatabaseBundles

      default CompletableFuture<GetRelationalDatabaseBundlesResponse> getRelationalDatabaseBundles(GetRelationalDatabaseBundlesRequest getRelationalDatabaseBundlesRequest)

      Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database.

      You can use a bundle ID to create a new database with explicit performance specifications.

      Parameters:
      getRelationalDatabaseBundlesRequest -
      Returns:
      A Java Future containing the result of the GetRelationalDatabaseBundles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRelationalDatabaseBundles

      default CompletableFuture<GetRelationalDatabaseBundlesResponse> getRelationalDatabaseBundles(Consumer<GetRelationalDatabaseBundlesRequest.Builder> getRelationalDatabaseBundlesRequest)

      Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database.

      You can use a bundle ID to create a new database with explicit performance specifications.


      This is a convenience which creates an instance of the GetRelationalDatabaseBundlesRequest.Builder avoiding the need to create one manually via GetRelationalDatabaseBundlesRequest.builder()

      Parameters:
      getRelationalDatabaseBundlesRequest - A Consumer that will call methods on GetRelationalDatabaseBundlesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetRelationalDatabaseBundles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRelationalDatabaseBundles

      default CompletableFuture<GetRelationalDatabaseBundlesResponse> getRelationalDatabaseBundles()

      Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database.

      You can use a bundle ID to create a new database with explicit performance specifications.

      Returns:
      A Java Future containing the result of the GetRelationalDatabaseBundles operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRelationalDatabaseEvents

      default CompletableFuture<GetRelationalDatabaseEventsResponse> getRelationalDatabaseEvents(GetRelationalDatabaseEventsRequest getRelationalDatabaseEventsRequest)

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

      Parameters:
      getRelationalDatabaseEventsRequest -
      Returns:
      A Java Future containing the result of the GetRelationalDatabaseEvents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRelationalDatabaseEvents

      default CompletableFuture<GetRelationalDatabaseEventsResponse> getRelationalDatabaseEvents(Consumer<GetRelationalDatabaseEventsRequest.Builder> getRelationalDatabaseEventsRequest)

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


      This is a convenience which creates an instance of the GetRelationalDatabaseEventsRequest.Builder avoiding the need to create one manually via GetRelationalDatabaseEventsRequest.builder()

      Parameters:
      getRelationalDatabaseEventsRequest - A Consumer that will call methods on GetRelationalDatabaseEventsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetRelationalDatabaseEvents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRelationalDatabaseLogEvents

      default CompletableFuture<GetRelationalDatabaseLogEventsResponse> getRelationalDatabaseLogEvents(GetRelationalDatabaseLogEventsRequest getRelationalDatabaseLogEventsRequest)

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

      Parameters:
      getRelationalDatabaseLogEventsRequest -
      Returns:
      A Java Future containing the result of the GetRelationalDatabaseLogEvents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRelationalDatabaseLogEvents

      default CompletableFuture<GetRelationalDatabaseLogEventsResponse> getRelationalDatabaseLogEvents(Consumer<GetRelationalDatabaseLogEventsRequest.Builder> getRelationalDatabaseLogEventsRequest)

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


      This is a convenience which creates an instance of the GetRelationalDatabaseLogEventsRequest.Builder avoiding the need to create one manually via GetRelationalDatabaseLogEventsRequest.builder()

      Parameters:
      getRelationalDatabaseLogEventsRequest - A Consumer that will call methods on GetRelationalDatabaseLogEventsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetRelationalDatabaseLogEvents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRelationalDatabaseLogStreams

      default CompletableFuture<GetRelationalDatabaseLogStreamsResponse> getRelationalDatabaseLogStreams(GetRelationalDatabaseLogStreamsRequest getRelationalDatabaseLogStreamsRequest)

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

      Parameters:
      getRelationalDatabaseLogStreamsRequest -
      Returns:
      A Java Future containing the result of the GetRelationalDatabaseLogStreams operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRelationalDatabaseLogStreams

      default CompletableFuture<GetRelationalDatabaseLogStreamsResponse> getRelationalDatabaseLogStreams(Consumer<GetRelationalDatabaseLogStreamsRequest.Builder> getRelationalDatabaseLogStreamsRequest)

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


      This is a convenience which creates an instance of the GetRelationalDatabaseLogStreamsRequest.Builder avoiding the need to create one manually via GetRelationalDatabaseLogStreamsRequest.builder()

      Parameters:
      getRelationalDatabaseLogStreamsRequest - A Consumer that will call methods on GetRelationalDatabaseLogStreamsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetRelationalDatabaseLogStreams operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRelationalDatabaseMasterUserPassword

      default CompletableFuture<GetRelationalDatabaseMasterUserPasswordResponse> getRelationalDatabaseMasterUserPassword(GetRelationalDatabaseMasterUserPasswordRequest getRelationalDatabaseMasterUserPasswordRequest)

      Returns the current, previous, or pending versions of the master user password for a Lightsail database.

      The GetRelationalDatabaseMasterUserPassword operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName.

      Parameters:
      getRelationalDatabaseMasterUserPasswordRequest -
      Returns:
      A Java Future containing the result of the GetRelationalDatabaseMasterUserPassword operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRelationalDatabaseMasterUserPassword

      default CompletableFuture<GetRelationalDatabaseMasterUserPasswordResponse> getRelationalDatabaseMasterUserPassword(Consumer<GetRelationalDatabaseMasterUserPasswordRequest.Builder> getRelationalDatabaseMasterUserPasswordRequest)

      Returns the current, previous, or pending versions of the master user password for a Lightsail database.

      The GetRelationalDatabaseMasterUserPassword operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName.


      This is a convenience which creates an instance of the GetRelationalDatabaseMasterUserPasswordRequest.Builder avoiding the need to create one manually via GetRelationalDatabaseMasterUserPasswordRequest.builder()

      Parameters:
      getRelationalDatabaseMasterUserPasswordRequest - A Consumer that will call methods on GetRelationalDatabaseMasterUserPasswordRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetRelationalDatabaseMasterUserPassword operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRelationalDatabaseMetricData

      default CompletableFuture<GetRelationalDatabaseMetricDataResponse> getRelationalDatabaseMetricData(GetRelationalDatabaseMetricDataRequest getRelationalDatabaseMetricDataRequest)

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

      Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.

      Parameters:
      getRelationalDatabaseMetricDataRequest -
      Returns:
      A Java Future containing the result of the GetRelationalDatabaseMetricData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRelationalDatabaseMetricData

      default CompletableFuture<GetRelationalDatabaseMetricDataResponse> getRelationalDatabaseMetricData(Consumer<GetRelationalDatabaseMetricDataRequest.Builder> getRelationalDatabaseMetricDataRequest)

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

      Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.


      This is a convenience which creates an instance of the GetRelationalDatabaseMetricDataRequest.Builder avoiding the need to create one manually via GetRelationalDatabaseMetricDataRequest.builder()

      Parameters:
      getRelationalDatabaseMetricDataRequest - A Consumer that will call methods on GetRelationalDatabaseMetricDataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetRelationalDatabaseMetricData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRelationalDatabaseParameters

      default CompletableFuture<GetRelationalDatabaseParametersResponse> getRelationalDatabaseParameters(GetRelationalDatabaseParametersRequest getRelationalDatabaseParametersRequest)

      Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail.

      In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a reboot, whether the parameter is modifiable, the allowed values, and the data types.

      Parameters:
      getRelationalDatabaseParametersRequest -
      Returns:
      A Java Future containing the result of the GetRelationalDatabaseParameters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRelationalDatabaseParameters

      default CompletableFuture<GetRelationalDatabaseParametersResponse> getRelationalDatabaseParameters(Consumer<GetRelationalDatabaseParametersRequest.Builder> getRelationalDatabaseParametersRequest)

      Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail.

      In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a reboot, whether the parameter is modifiable, the allowed values, and the data types.


      This is a convenience which creates an instance of the GetRelationalDatabaseParametersRequest.Builder avoiding the need to create one manually via GetRelationalDatabaseParametersRequest.builder()

      Parameters:
      getRelationalDatabaseParametersRequest - A Consumer that will call methods on GetRelationalDatabaseParametersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetRelationalDatabaseParameters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRelationalDatabaseSnapshot

      default CompletableFuture<GetRelationalDatabaseSnapshotResponse> getRelationalDatabaseSnapshot(GetRelationalDatabaseSnapshotRequest getRelationalDatabaseSnapshotRequest)

      Returns information about a specific database snapshot in Amazon Lightsail.

      Parameters:
      getRelationalDatabaseSnapshotRequest -
      Returns:
      A Java Future containing the result of the GetRelationalDatabaseSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRelationalDatabaseSnapshot

      default CompletableFuture<GetRelationalDatabaseSnapshotResponse> getRelationalDatabaseSnapshot(Consumer<GetRelationalDatabaseSnapshotRequest.Builder> getRelationalDatabaseSnapshotRequest)

      Returns information about a specific database snapshot in Amazon Lightsail.


      This is a convenience which creates an instance of the GetRelationalDatabaseSnapshotRequest.Builder avoiding the need to create one manually via GetRelationalDatabaseSnapshotRequest.builder()

      Parameters:
      getRelationalDatabaseSnapshotRequest - A Consumer that will call methods on GetRelationalDatabaseSnapshotRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetRelationalDatabaseSnapshot operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRelationalDatabaseSnapshots

      default CompletableFuture<GetRelationalDatabaseSnapshotsResponse> getRelationalDatabaseSnapshots(GetRelationalDatabaseSnapshotsRequest getRelationalDatabaseSnapshotsRequest)

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

      Parameters:
      getRelationalDatabaseSnapshotsRequest -
      Returns:
      A Java Future containing the result of the GetRelationalDatabaseSnapshots operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRelationalDatabaseSnapshots

      default CompletableFuture<GetRelationalDatabaseSnapshotsResponse> getRelationalDatabaseSnapshots(Consumer<GetRelationalDatabaseSnapshotsRequest.Builder> getRelationalDatabaseSnapshotsRequest)

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


      This is a convenience which creates an instance of the GetRelationalDatabaseSnapshotsRequest.Builder avoiding the need to create one manually via GetRelationalDatabaseSnapshotsRequest.builder()

      Parameters:
      getRelationalDatabaseSnapshotsRequest - A Consumer that will call methods on GetRelationalDatabaseSnapshotsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetRelationalDatabaseSnapshots operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRelationalDatabaseSnapshots

      default CompletableFuture<GetRelationalDatabaseSnapshotsResponse> getRelationalDatabaseSnapshots()

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

      Returns:
      A Java Future containing the result of the GetRelationalDatabaseSnapshots operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRelationalDatabases

      default CompletableFuture<GetRelationalDatabasesResponse> getRelationalDatabases(GetRelationalDatabasesRequest getRelationalDatabasesRequest)

      Returns information about all of your databases in Amazon Lightsail.

      Parameters:
      getRelationalDatabasesRequest -
      Returns:
      A Java Future containing the result of the GetRelationalDatabases operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRelationalDatabases

      default CompletableFuture<GetRelationalDatabasesResponse> getRelationalDatabases(Consumer<GetRelationalDatabasesRequest.Builder> getRelationalDatabasesRequest)

      Returns information about all of your databases in Amazon Lightsail.


      This is a convenience which creates an instance of the GetRelationalDatabasesRequest.Builder avoiding the need to create one manually via GetRelationalDatabasesRequest.builder()

      Parameters:
      getRelationalDatabasesRequest - A Consumer that will call methods on GetRelationalDatabasesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetRelationalDatabases operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRelationalDatabases

      default CompletableFuture<GetRelationalDatabasesResponse> getRelationalDatabases()

      Returns information about all of your databases in Amazon Lightsail.

      Returns:
      A Java Future containing the result of the GetRelationalDatabases operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSetupHistory

      default CompletableFuture<GetSetupHistoryResponse> getSetupHistory(GetSetupHistoryRequest getSetupHistoryRequest)

      Returns detailed information for five of the most recent SetupInstanceHttps requests that were ran on the target instance.

      Parameters:
      getSetupHistoryRequest -
      Returns:
      A Java Future containing the result of the GetSetupHistory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSetupHistory

      default CompletableFuture<GetSetupHistoryResponse> getSetupHistory(Consumer<GetSetupHistoryRequest.Builder> getSetupHistoryRequest)

      Returns detailed information for five of the most recent SetupInstanceHttps requests that were ran on the target instance.


      This is a convenience which creates an instance of the GetSetupHistoryRequest.Builder avoiding the need to create one manually via GetSetupHistoryRequest.builder()

      Parameters:
      getSetupHistoryRequest - A Consumer that will call methods on GetSetupHistoryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSetupHistory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getStaticIp

      default CompletableFuture<GetStaticIpResponse> getStaticIp(GetStaticIpRequest getStaticIpRequest)

      Returns information about an Amazon Lightsail static IP.

      Parameters:
      getStaticIpRequest -
      Returns:
      A Java Future containing the result of the GetStaticIp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getStaticIp

      default CompletableFuture<GetStaticIpResponse> getStaticIp(Consumer<GetStaticIpRequest.Builder> getStaticIpRequest)

      Returns information about an Amazon Lightsail static IP.


      This is a convenience which creates an instance of the GetStaticIpRequest.Builder avoiding the need to create one manually via GetStaticIpRequest.builder()

      Parameters:
      getStaticIpRequest - A Consumer that will call methods on GetStaticIpRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetStaticIp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getStaticIps

      default CompletableFuture<GetStaticIpsResponse> getStaticIps(GetStaticIpsRequest getStaticIpsRequest)

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

      Parameters:
      getStaticIpsRequest -
      Returns:
      A Java Future containing the result of the GetStaticIps operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getStaticIps

      default CompletableFuture<GetStaticIpsResponse> getStaticIps(Consumer<GetStaticIpsRequest.Builder> getStaticIpsRequest)

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


      This is a convenience which creates an instance of the GetStaticIpsRequest.Builder avoiding the need to create one manually via GetStaticIpsRequest.builder()

      Parameters:
      getStaticIpsRequest - A Consumer that will call methods on GetStaticIpsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetStaticIps operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getStaticIps

      default CompletableFuture<GetStaticIpsResponse> getStaticIps()

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

      Returns:
      A Java Future containing the result of the GetStaticIps operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • importKeyPair

      default CompletableFuture<ImportKeyPairResponse> importKeyPair(ImportKeyPairRequest importKeyPairRequest)

      Imports a public SSH key from a specific key pair.

      Parameters:
      importKeyPairRequest -
      Returns:
      A Java Future containing the result of the ImportKeyPair operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • importKeyPair

      default CompletableFuture<ImportKeyPairResponse> importKeyPair(Consumer<ImportKeyPairRequest.Builder> importKeyPairRequest)

      Imports a public SSH key from a specific key pair.


      This is a convenience which creates an instance of the ImportKeyPairRequest.Builder avoiding the need to create one manually via ImportKeyPairRequest.builder()

      Parameters:
      importKeyPairRequest - A Consumer that will call methods on ImportKeyPairRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ImportKeyPair operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • isVpcPeered

      default CompletableFuture<IsVpcPeeredResponse> isVpcPeered(IsVpcPeeredRequest isVpcPeeredRequest)

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

      Parameters:
      isVpcPeeredRequest -
      Returns:
      A Java Future containing the result of the IsVpcPeered operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • isVpcPeered

      default CompletableFuture<IsVpcPeeredResponse> isVpcPeered(Consumer<IsVpcPeeredRequest.Builder> isVpcPeeredRequest)

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


      This is a convenience which creates an instance of the IsVpcPeeredRequest.Builder avoiding the need to create one manually via IsVpcPeeredRequest.builder()

      Parameters:
      isVpcPeeredRequest - A Consumer that will call methods on IsVpcPeeredRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the IsVpcPeered operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • isVpcPeered

      default CompletableFuture<IsVpcPeeredResponse> isVpcPeered()

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

      Returns:
      A Java Future containing the result of the IsVpcPeered operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • openInstancePublicPorts

      default CompletableFuture<OpenInstancePublicPortsResponse> openInstancePublicPorts(OpenInstancePublicPortsRequest openInstancePublicPortsRequest)

      Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol.

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

      Parameters:
      openInstancePublicPortsRequest -
      Returns:
      A Java Future containing the result of the OpenInstancePublicPorts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • openInstancePublicPorts

      default CompletableFuture<OpenInstancePublicPortsResponse> openInstancePublicPorts(Consumer<OpenInstancePublicPortsRequest.Builder> openInstancePublicPortsRequest)

      Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol.

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


      This is a convenience which creates an instance of the OpenInstancePublicPortsRequest.Builder avoiding the need to create one manually via OpenInstancePublicPortsRequest.builder()

      Parameters:
      openInstancePublicPortsRequest - A Consumer that will call methods on OpenInstancePublicPortsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the OpenInstancePublicPorts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • peerVpc

      default CompletableFuture<PeerVpcResponse> peerVpc(PeerVpcRequest peerVpcRequest)

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

      Parameters:
      peerVpcRequest -
      Returns:
      A Java Future containing the result of the PeerVpc operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • peerVpc

      default CompletableFuture<PeerVpcResponse> peerVpc(Consumer<PeerVpcRequest.Builder> peerVpcRequest)

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


      This is a convenience which creates an instance of the PeerVpcRequest.Builder avoiding the need to create one manually via PeerVpcRequest.builder()

      Parameters:
      peerVpcRequest - A Consumer that will call methods on PeerVpcRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PeerVpc operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • peerVpc

      default CompletableFuture<PeerVpcResponse> peerVpc()

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

      Returns:
      A Java Future containing the result of the PeerVpc operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putAlarm

      default CompletableFuture<PutAlarmResponse> putAlarm(PutAlarmRequest putAlarmRequest)

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

      An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.

      When this action creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.

      When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. The alarm is then evaluated with the updated configuration.

      Parameters:
      putAlarmRequest -
      Returns:
      A Java Future containing the result of the PutAlarm operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putAlarm

      default CompletableFuture<PutAlarmResponse> putAlarm(Consumer<PutAlarmRequest.Builder> putAlarmRequest)

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

      An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.

      When this action creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.

      When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. The alarm is then evaluated with the updated configuration.


      This is a convenience which creates an instance of the PutAlarmRequest.Builder avoiding the need to create one manually via PutAlarmRequest.builder()

      Parameters:
      putAlarmRequest - A Consumer that will call methods on PutAlarmRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutAlarm operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putInstancePublicPorts

      default CompletableFuture<PutInstancePublicPortsResponse> putInstancePublicPorts(PutInstancePublicPortsRequest putInstancePublicPortsRequest)

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

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

      Parameters:
      putInstancePublicPortsRequest -
      Returns:
      A Java Future containing the result of the PutInstancePublicPorts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putInstancePublicPorts

      default CompletableFuture<PutInstancePublicPortsResponse> putInstancePublicPorts(Consumer<PutInstancePublicPortsRequest.Builder> putInstancePublicPortsRequest)

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

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


      This is a convenience which creates an instance of the PutInstancePublicPortsRequest.Builder avoiding the need to create one manually via PutInstancePublicPortsRequest.builder()

      Parameters:
      putInstancePublicPortsRequest - A Consumer that will call methods on PutInstancePublicPortsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutInstancePublicPorts operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • rebootInstance

      default CompletableFuture<RebootInstanceResponse> rebootInstance(RebootInstanceRequest rebootInstanceRequest)

      Restarts a specific instance.

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

      Parameters:
      rebootInstanceRequest -
      Returns:
      A Java Future containing the result of the RebootInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • rebootInstance

      default CompletableFuture<RebootInstanceResponse> rebootInstance(Consumer<RebootInstanceRequest.Builder> rebootInstanceRequest)

      Restarts a specific instance.

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


      This is a convenience which creates an instance of the RebootInstanceRequest.Builder avoiding the need to create one manually via RebootInstanceRequest.builder()

      Parameters:
      rebootInstanceRequest - A Consumer that will call methods on RebootInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RebootInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • rebootRelationalDatabase

      default CompletableFuture<RebootRelationalDatabaseResponse> rebootRelationalDatabase(RebootRelationalDatabaseRequest rebootRelationalDatabaseRequest)

      Restarts a specific database in Amazon Lightsail.

      The reboot relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

      Parameters:
      rebootRelationalDatabaseRequest -
      Returns:
      A Java Future containing the result of the RebootRelationalDatabase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • rebootRelationalDatabase

      default CompletableFuture<RebootRelationalDatabaseResponse> rebootRelationalDatabase(Consumer<RebootRelationalDatabaseRequest.Builder> rebootRelationalDatabaseRequest)

      Restarts a specific database in Amazon Lightsail.

      The reboot relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.


      This is a convenience which creates an instance of the RebootRelationalDatabaseRequest.Builder avoiding the need to create one manually via RebootRelationalDatabaseRequest.builder()

      Parameters:
      rebootRelationalDatabaseRequest - A Consumer that will call methods on RebootRelationalDatabaseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RebootRelationalDatabase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • registerContainerImage

      default CompletableFuture<RegisterContainerImageResponse> registerContainerImage(RegisterContainerImageRequest registerContainerImageRequest)

      Registers a container image to your Amazon Lightsail container service.

      This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.

      Parameters:
      registerContainerImageRequest -
      Returns:
      A Java Future containing the result of the RegisterContainerImage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • registerContainerImage

      default CompletableFuture<RegisterContainerImageResponse> registerContainerImage(Consumer<RegisterContainerImageRequest.Builder> registerContainerImageRequest)

      Registers a container image to your Amazon Lightsail container service.

      This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.


      This is a convenience which creates an instance of the RegisterContainerImageRequest.Builder avoiding the need to create one manually via RegisterContainerImageRequest.builder()

      Parameters:
      registerContainerImageRequest - A Consumer that will call methods on RegisterContainerImageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RegisterContainerImage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • releaseStaticIp

      default CompletableFuture<ReleaseStaticIpResponse> releaseStaticIp(ReleaseStaticIpRequest releaseStaticIpRequest)

      Deletes a specific static IP from your account.

      Parameters:
      releaseStaticIpRequest -
      Returns:
      A Java Future containing the result of the ReleaseStaticIp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • releaseStaticIp

      default CompletableFuture<ReleaseStaticIpResponse> releaseStaticIp(Consumer<ReleaseStaticIpRequest.Builder> releaseStaticIpRequest)

      Deletes a specific static IP from your account.


      This is a convenience which creates an instance of the ReleaseStaticIpRequest.Builder avoiding the need to create one manually via ReleaseStaticIpRequest.builder()

      Parameters:
      releaseStaticIpRequest - A Consumer that will call methods on ReleaseStaticIpRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ReleaseStaticIp operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • resetDistributionCache

      default CompletableFuture<ResetDistributionCacheResponse> resetDistributionCache(ResetDistributionCacheRequest resetDistributionCacheRequest)

      Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution.

      After resetting the cache, the next time a content request is made, your distribution pulls, serves, and caches it from the origin.

      Parameters:
      resetDistributionCacheRequest -
      Returns:
      A Java Future containing the result of the ResetDistributionCache operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • resetDistributionCache

      default CompletableFuture<ResetDistributionCacheResponse> resetDistributionCache(Consumer<ResetDistributionCacheRequest.Builder> resetDistributionCacheRequest)

      Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution.

      After resetting the cache, the next time a content request is made, your distribution pulls, serves, and caches it from the origin.


      This is a convenience which creates an instance of the ResetDistributionCacheRequest.Builder avoiding the need to create one manually via ResetDistributionCacheRequest.builder()

      Parameters:
      resetDistributionCacheRequest - A Consumer that will call methods on ResetDistributionCacheRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ResetDistributionCache operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendContactMethodVerification

      default CompletableFuture<SendContactMethodVerificationResponse> sendContactMethodVerification(SendContactMethodVerificationRequest sendContactMethodVerificationRequest)

      Sends a verification request to an email contact method to ensure it's owned by the requester. SMS contact methods don't need to be verified.

      A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

      A verification request is sent to the contact method when you initially create it. Use this action to send another verification request if a previous verification request was deleted, or has expired.

      Notifications are not sent to an email contact method until after it is verified, and confirmed as valid.

      Parameters:
      sendContactMethodVerificationRequest -
      Returns:
      A Java Future containing the result of the SendContactMethodVerification operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • OperationFailureException Lightsail throws this exception when an operation fails to execute.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • sendContactMethodVerification

      default CompletableFuture<SendContactMethodVerificationResponse> sendContactMethodVerification(Consumer<SendContactMethodVerificationRequest.Builder> sendContactMethodVerificationRequest)

      Sends a verification request to an email contact method to ensure it's owned by the requester. SMS contact methods don't need to be verified.

      A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.

      A verification request is sent to the contact method when you initially create it. Use this action to send another verification request if a previous verification request was deleted, or has expired.

      Notifications are not sent to an email contact method until after it is verified, and confirmed as valid.


      This is a convenience which creates an instance of the SendContactMethodVerificationRequest.Builder avoiding the need to create one manually via SendContactMethodVerificationRequest.builder()

      Parameters:
      sendContactMethodVerificationRequest - A Consumer that will call methods on SendContactMethodVerificationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SendContactMethodVerification operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • OperationFailureException Lightsail throws this exception when an operation fails to execute.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • setIpAddressType

      default CompletableFuture<SetIpAddressTypeResponse> setIpAddressType(SetIpAddressTypeRequest setIpAddressTypeRequest)

      Sets the IP address type for an Amazon Lightsail resource.

      Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the specified resource. Alternately, you can use this action to disable dual-stack, and enable IPv4 only.

      Parameters:
      setIpAddressTypeRequest -
      Returns:
      A Java Future containing the result of the SetIpAddressType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • setIpAddressType

      default CompletableFuture<SetIpAddressTypeResponse> setIpAddressType(Consumer<SetIpAddressTypeRequest.Builder> setIpAddressTypeRequest)

      Sets the IP address type for an Amazon Lightsail resource.

      Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the specified resource. Alternately, you can use this action to disable dual-stack, and enable IPv4 only.


      This is a convenience which creates an instance of the SetIpAddressTypeRequest.Builder avoiding the need to create one manually via SetIpAddressTypeRequest.builder()

      Parameters:
      setIpAddressTypeRequest - A Consumer that will call methods on SetIpAddressTypeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SetIpAddressType operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • setResourceAccessForBucket

      default CompletableFuture<SetResourceAccessForBucketResponse> setResourceAccessForBucket(SetResourceAccessForBucketRequest setResourceAccessForBucketRequest)

      Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.

      Lightsail buckets currently support setting access for Lightsail instances in the same Amazon Web Services Region.

      Parameters:
      setResourceAccessForBucketRequest -
      Returns:
      A Java Future containing the result of the SetResourceAccessForBucket operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • setResourceAccessForBucket

      default CompletableFuture<SetResourceAccessForBucketResponse> setResourceAccessForBucket(Consumer<SetResourceAccessForBucketRequest.Builder> setResourceAccessForBucketRequest)

      Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.

      Lightsail buckets currently support setting access for Lightsail instances in the same Amazon Web Services Region.


      This is a convenience which creates an instance of the SetResourceAccessForBucketRequest.Builder avoiding the need to create one manually via SetResourceAccessForBucketRequest.builder()

      Parameters:
      setResourceAccessForBucketRequest - A Consumer that will call methods on SetResourceAccessForBucketRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SetResourceAccessForBucket operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • setupInstanceHttps

      default CompletableFuture<SetupInstanceHttpsResponse> setupInstanceHttps(SetupInstanceHttpsRequest setupInstanceHttpsRequest)

      Creates an SSL/TLS certificate that secures traffic for your website. After the certificate is created, it is installed on the specified Lightsail instance.

      If you provide more than one domain name in the request, at least one name must be less than or equal to 63 characters in length.

      Parameters:
      setupInstanceHttpsRequest -
      Returns:
      A Java Future containing the result of the SetupInstanceHttps operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • setupInstanceHttps

      default CompletableFuture<SetupInstanceHttpsResponse> setupInstanceHttps(Consumer<SetupInstanceHttpsRequest.Builder> setupInstanceHttpsRequest)

      Creates an SSL/TLS certificate that secures traffic for your website. After the certificate is created, it is installed on the specified Lightsail instance.

      If you provide more than one domain name in the request, at least one name must be less than or equal to 63 characters in length.


      This is a convenience which creates an instance of the SetupInstanceHttpsRequest.Builder avoiding the need to create one manually via SetupInstanceHttpsRequest.builder()

      Parameters:
      setupInstanceHttpsRequest - A Consumer that will call methods on SetupInstanceHttpsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SetupInstanceHttps operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startGUISession

      default CompletableFuture<StartGuiSessionResponse> startGUISession(StartGuiSessionRequest startGuiSessionRequest)

      Initiates a graphical user interface (GUI) session that’s used to access a virtual computer’s operating system and application. The session will be active for 1 hour. Use this action to resume the session after it expires.

      Parameters:
      startGuiSessionRequest -
      Returns:
      A Java Future containing the result of the StartGUISession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startGUISession

      default CompletableFuture<StartGuiSessionResponse> startGUISession(Consumer<StartGuiSessionRequest.Builder> startGuiSessionRequest)

      Initiates a graphical user interface (GUI) session that’s used to access a virtual computer’s operating system and application. The session will be active for 1 hour. Use this action to resume the session after it expires.


      This is a convenience which creates an instance of the StartGuiSessionRequest.Builder avoiding the need to create one manually via StartGuiSessionRequest.builder()

      Parameters:
      startGuiSessionRequest - A Consumer that will call methods on StartGuiSessionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartGUISession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startInstance

      default CompletableFuture<StartInstanceResponse> startInstance(StartInstanceRequest startInstanceRequest)

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

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

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

      Parameters:
      startInstanceRequest -
      Returns:
      A Java Future containing the result of the StartInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startInstance

      default CompletableFuture<StartInstanceResponse> startInstance(Consumer<StartInstanceRequest.Builder> startInstanceRequest)

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

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

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


      This is a convenience which creates an instance of the StartInstanceRequest.Builder avoiding the need to create one manually via StartInstanceRequest.builder()

      Parameters:
      startInstanceRequest - A Consumer that will call methods on StartInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startRelationalDatabase

      default CompletableFuture<StartRelationalDatabaseResponse> startRelationalDatabase(StartRelationalDatabaseRequest startRelationalDatabaseRequest)

      Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the reboot relational database operation.

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

      Parameters:
      startRelationalDatabaseRequest -
      Returns:
      A Java Future containing the result of the StartRelationalDatabase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startRelationalDatabase

      default CompletableFuture<StartRelationalDatabaseResponse> startRelationalDatabase(Consumer<StartRelationalDatabaseRequest.Builder> startRelationalDatabaseRequest)

      Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the reboot relational database operation.

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


      This is a convenience which creates an instance of the StartRelationalDatabaseRequest.Builder avoiding the need to create one manually via StartRelationalDatabaseRequest.builder()

      Parameters:
      startRelationalDatabaseRequest - A Consumer that will call methods on StartRelationalDatabaseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartRelationalDatabase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopGUISession

      default CompletableFuture<StopGuiSessionResponse> stopGUISession(StopGuiSessionRequest stopGuiSessionRequest)

      Terminates a web-based NICE DCV session that’s used to access a virtual computer’s operating system or application. The session will close and any unsaved data will be lost.

      Parameters:
      stopGuiSessionRequest -
      Returns:
      A Java Future containing the result of the StopGUISession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopGUISession

      default CompletableFuture<StopGuiSessionResponse> stopGUISession(Consumer<StopGuiSessionRequest.Builder> stopGuiSessionRequest)

      Terminates a web-based NICE DCV session that’s used to access a virtual computer’s operating system or application. The session will close and any unsaved data will be lost.


      This is a convenience which creates an instance of the StopGuiSessionRequest.Builder avoiding the need to create one manually via StopGuiSessionRequest.builder()

      Parameters:
      stopGuiSessionRequest - A Consumer that will call methods on StopGuiSessionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopGUISession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopInstance

      default CompletableFuture<StopInstanceResponse> stopInstance(StopInstanceRequest stopInstanceRequest)

      Stops a specific Amazon Lightsail instance that is currently running.

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

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

      Parameters:
      stopInstanceRequest -
      Returns:
      A Java Future containing the result of the StopInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopInstance

      default CompletableFuture<StopInstanceResponse> stopInstance(Consumer<StopInstanceRequest.Builder> stopInstanceRequest)

      Stops a specific Amazon Lightsail instance that is currently running.

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

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


      This is a convenience which creates an instance of the StopInstanceRequest.Builder avoiding the need to create one manually via StopInstanceRequest.builder()

      Parameters:
      stopInstanceRequest - A Consumer that will call methods on StopInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopRelationalDatabase

      default CompletableFuture<StopRelationalDatabaseResponse> stopRelationalDatabase(StopRelationalDatabaseRequest stopRelationalDatabaseRequest)

      Stops a specific database that is currently running in Amazon Lightsail.

      The stop relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

      Parameters:
      stopRelationalDatabaseRequest -
      Returns:
      A Java Future containing the result of the StopRelationalDatabase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopRelationalDatabase

      default CompletableFuture<StopRelationalDatabaseResponse> stopRelationalDatabase(Consumer<StopRelationalDatabaseRequest.Builder> stopRelationalDatabaseRequest)

      Stops a specific database that is currently running in Amazon Lightsail.

      The stop relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.


      This is a convenience which creates an instance of the StopRelationalDatabaseRequest.Builder avoiding the need to create one manually via StopRelationalDatabaseRequest.builder()

      Parameters:
      stopRelationalDatabaseRequest - A Consumer that will call methods on StopRelationalDatabaseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopRelationalDatabase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

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

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

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

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

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


      This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • testAlarm

      default CompletableFuture<TestAlarmResponse> testAlarm(TestAlarmRequest testAlarmRequest)

      Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification trigger is configured for the specified alarm, the test also sends a notification to the notification protocol (Email and/or SMS) configured for the alarm.

      An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.

      Parameters:
      testAlarmRequest -
      Returns:
      A Java Future containing the result of the TestAlarm operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • OperationFailureException Lightsail throws this exception when an operation fails to execute.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • testAlarm

      default CompletableFuture<TestAlarmResponse> testAlarm(Consumer<TestAlarmRequest.Builder> testAlarmRequest)

      Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification trigger is configured for the specified alarm, the test also sends a notification to the notification protocol (Email and/or SMS) configured for the alarm.

      An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.


      This is a convenience which creates an instance of the TestAlarmRequest.Builder avoiding the need to create one manually via TestAlarmRequest.builder()

      Parameters:
      testAlarmRequest - A Consumer that will call methods on TestAlarmRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TestAlarm operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • OperationFailureException Lightsail throws this exception when an operation fails to execute.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • unpeerVpc

      default CompletableFuture<UnpeerVpcResponse> unpeerVpc(UnpeerVpcRequest unpeerVpcRequest)

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

      Parameters:
      unpeerVpcRequest -
      Returns:
      A Java Future containing the result of the UnpeerVpc operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • unpeerVpc

      default CompletableFuture<UnpeerVpcResponse> unpeerVpc(Consumer<UnpeerVpcRequest.Builder> unpeerVpcRequest)

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


      This is a convenience which creates an instance of the UnpeerVpcRequest.Builder avoiding the need to create one manually via UnpeerVpcRequest.builder()

      Parameters:
      unpeerVpcRequest - A Consumer that will call methods on UnpeerVpcRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UnpeerVpc operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • unpeerVpc

      default CompletableFuture<UnpeerVpcResponse> unpeerVpc()

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

      Returns:
      A Java Future containing the result of the UnpeerVpc operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.

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

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.

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


      This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateBucket

      default CompletableFuture<UpdateBucketResponse> updateBucket(UpdateBucketRequest updateBucketRequest)

      Updates an existing Amazon Lightsail bucket.

      Use this action to update the configuration of an existing bucket, such as versioning, public accessibility, and the Amazon Web Services accounts that can access the bucket.

      Parameters:
      updateBucketRequest -
      Returns:
      A Java Future containing the result of the UpdateBucket operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateBucket

      default CompletableFuture<UpdateBucketResponse> updateBucket(Consumer<UpdateBucketRequest.Builder> updateBucketRequest)

      Updates an existing Amazon Lightsail bucket.

      Use this action to update the configuration of an existing bucket, such as versioning, public accessibility, and the Amazon Web Services accounts that can access the bucket.


      This is a convenience which creates an instance of the UpdateBucketRequest.Builder avoiding the need to create one manually via UpdateBucketRequest.builder()

      Parameters:
      updateBucketRequest - A Consumer that will call methods on UpdateBucketRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateBucket operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateBucketBundle

      default CompletableFuture<UpdateBucketBundleResponse> updateBucketBundle(UpdateBucketBundleRequest updateBucketBundleRequest)

      Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.

      A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. You can update a bucket's bundle only one time within a monthly Amazon Web Services billing cycle. To determine if you can update a bucket's bundle, use the GetBuckets action. The ableToUpdateBundle parameter in the response will indicate whether you can currently update a bucket's bundle.

      Update a bucket's bundle if it's consistently going over its storage space or data transfer quota, or if a bucket's usage is consistently in the lower range of its storage space or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might experience, we strongly recommend that you update a bucket's bundle only as a long-term strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle that will provide the bucket with ample storage space and data transfer for a long time to come.

      Parameters:
      updateBucketBundleRequest -
      Returns:
      A Java Future containing the result of the UpdateBucketBundle operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateBucketBundle

      default CompletableFuture<UpdateBucketBundleResponse> updateBucketBundle(Consumer<UpdateBucketBundleRequest.Builder> updateBucketBundleRequest)

      Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.

      A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. You can update a bucket's bundle only one time within a monthly Amazon Web Services billing cycle. To determine if you can update a bucket's bundle, use the GetBuckets action. The ableToUpdateBundle parameter in the response will indicate whether you can currently update a bucket's bundle.

      Update a bucket's bundle if it's consistently going over its storage space or data transfer quota, or if a bucket's usage is consistently in the lower range of its storage space or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might experience, we strongly recommend that you update a bucket's bundle only as a long-term strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle that will provide the bucket with ample storage space and data transfer for a long time to come.


      This is a convenience which creates an instance of the UpdateBucketBundleRequest.Builder avoiding the need to create one manually via UpdateBucketBundleRequest.builder()

      Parameters:
      updateBucketBundleRequest - A Consumer that will call methods on UpdateBucketBundleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateBucketBundle operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input field.

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

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • ServiceException A general service exception.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContainerService

      default CompletableFuture<UpdateContainerServiceResponse> updateContainerService(UpdateContainerServiceRequest updateContainerServiceRequest)

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

      Parameters:
      updateContainerServiceRequest -
      Returns:
      A Java Future containing the result of the UpdateContainerService operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateContainerService

      default CompletableFuture<UpdateContainerServiceResponse> updateContainerService(Consumer<UpdateContainerServiceRequest.Builder> updateContainerServiceRequest)

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


      This is a convenience which creates an instance of the UpdateContainerServiceRequest.Builder avoiding the need to create one manually via UpdateContainerServiceRequest.builder()

      Parameters:
      updateContainerServiceRequest - A Consumer that will call methods on UpdateContainerServiceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateContainerService operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • NotFoundException Lightsail throws this exception when it cannot find a resource.
      • AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDistribution

      default CompletableFuture<UpdateDistributionResponse> updateDistribution(UpdateDistributionRequest updateDistributionRequest)

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

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

      Parameters:
      updateDistributionRequest -
      Returns:
      A Java Future containing the result of the UpdateDistribution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDistribution

      default CompletableFuture<UpdateDistributionResponse> updateDistribution(Consumer<UpdateDistributionRequest.Builder> updateDistributionRequest)

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

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


      This is a convenience which creates an instance of the UpdateDistributionRequest.Builder avoiding the need to create one manually via UpdateDistributionRequest.builder()

      Parameters:
      updateDistributionRequest - A Consumer that will call methods on UpdateDistributionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateDistribution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDistributionBundle

      default CompletableFuture<UpdateDistributionBundleResponse> updateDistributionBundle(UpdateDistributionBundleRequest updateDistributionBundleRequest)

      Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.

      A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution.

      Update your distribution's bundle if your distribution is going over its monthly network transfer quota and is incurring an overage fee.

      You can update your distribution's bundle only one time within your monthly Amazon Web Services billing cycle. To determine if you can update your distribution's bundle, use the GetDistributions action. The ableToUpdateBundle parameter in the result will indicate whether you can currently update your distribution's bundle.

      Parameters:
      updateDistributionBundleRequest -
      Returns:
      A Java Future containing the result of the UpdateDistributionBundle operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDistributionBundle

      default CompletableFuture<UpdateDistributionBundleResponse> updateDistributionBundle(Consumer<UpdateDistributionBundleRequest.Builder> updateDistributionBundleRequest)

      Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.

      A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution.

      Update your distribution's bundle if your distribution is going over its monthly network transfer quota and is incurring an overage fee.

      You can update your distribution's bundle only one time within your monthly Amazon Web Services billing cycle. To determine if you can update your distribution's bundle, use the GetDistributions action. The ableToUpdateBundle parameter in the result will indicate whether you can currently update your distribution's bundle.


      This is a convenience which creates an instance of the UpdateDistributionBundleRequest.Builder avoiding the need to create one manually via UpdateDistributionBundleRequest.builder()

      Parameters:
      updateDistributionBundleRequest - A Consumer that will call methods on UpdateDistributionBundleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateDistributionBundle operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • UnauthenticatedException Lightsail throws this exception when the user has not been authenticated.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDomainEntry

      default CompletableFuture<UpdateDomainEntryResponse> updateDomainEntry(UpdateDomainEntryRequest updateDomainEntryRequest)

      Updates a domain recordset after it is created.

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

      Parameters:
      updateDomainEntryRequest -
      Returns:
      A Java Future containing the result of the UpdateDomainEntry operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDomainEntry

      default CompletableFuture<UpdateDomainEntryResponse> updateDomainEntry(Consumer<UpdateDomainEntryRequest.Builder> updateDomainEntryRequest)

      Updates a domain recordset after it is created.

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


      This is a convenience which creates an instance of the UpdateDomainEntryRequest.Builder avoiding the need to create one manually via UpdateDomainEntryRequest.builder()

      Parameters:
      updateDomainEntryRequest - A Consumer that will call methods on UpdateDomainEntryRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateDomainEntry operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateInstanceMetadataOptions

      default CompletableFuture<UpdateInstanceMetadataOptionsResponse> updateInstanceMetadataOptions(UpdateInstanceMetadataOptionsRequest updateInstanceMetadataOptionsRequest)

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

      Parameters:
      updateInstanceMetadataOptionsRequest -
      Returns:
      A Java Future containing the result of the UpdateInstanceMetadataOptions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateInstanceMetadataOptions

      default CompletableFuture<UpdateInstanceMetadataOptionsResponse> updateInstanceMetadataOptions(Consumer<UpdateInstanceMetadataOptionsRequest.Builder> updateInstanceMetadataOptionsRequest)

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


      This is a convenience which creates an instance of the UpdateInstanceMetadataOptionsRequest.Builder avoiding the need to create one manually via UpdateInstanceMetadataOptionsRequest.builder()

      Parameters:
      updateInstanceMetadataOptionsRequest - A Consumer that will call methods on UpdateInstanceMetadataOptionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateInstanceMetadataOptions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateLoadBalancerAttribute

      default CompletableFuture<UpdateLoadBalancerAttributeResponse> updateLoadBalancerAttribute(UpdateLoadBalancerAttributeRequest updateLoadBalancerAttributeRequest)

      Updates the specified attribute for a load balancer. You can only update one attribute at a time.

      The update load balancer attribute operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide.

      Parameters:
      updateLoadBalancerAttributeRequest -
      Returns:
      A Java Future containing the result of the UpdateLoadBalancerAttribute operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateLoadBalancerAttribute

      default CompletableFuture<UpdateLoadBalancerAttributeResponse> updateLoadBalancerAttribute(Consumer<UpdateLoadBalancerAttributeRequest.Builder> updateLoadBalancerAttributeRequest)

      Updates the specified attribute for a load balancer. You can only update one attribute at a time.

      The update load balancer attribute operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Amazon Lightsail Developer Guide.


      This is a convenience which creates an instance of the UpdateLoadBalancerAttributeRequest.Builder avoiding the need to create one manually via UpdateLoadBalancerAttributeRequest.builder()

      Parameters:
      updateLoadBalancerAttributeRequest - A Consumer that will call methods on UpdateLoadBalancerAttributeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateLoadBalancerAttribute operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRelationalDatabase

      default CompletableFuture<UpdateRelationalDatabaseResponse> updateRelationalDatabase(UpdateRelationalDatabaseRequest updateRelationalDatabaseRequest)

      Allows the update of one or more attributes of a database in Amazon Lightsail.

      Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database's predefined maintenance window.

      The update relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

      Parameters:
      updateRelationalDatabaseRequest -
      Returns:
      A Java Future containing the result of the UpdateRelationalDatabase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRelationalDatabase

      default CompletableFuture<UpdateRelationalDatabaseResponse> updateRelationalDatabase(Consumer<UpdateRelationalDatabaseRequest.Builder> updateRelationalDatabaseRequest)

      Allows the update of one or more attributes of a database in Amazon Lightsail.

      Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database's predefined maintenance window.

      The update relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.


      This is a convenience which creates an instance of the UpdateRelationalDatabaseRequest.Builder avoiding the need to create one manually via UpdateRelationalDatabaseRequest.builder()

      Parameters:
      updateRelationalDatabaseRequest - A Consumer that will call methods on UpdateRelationalDatabaseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateRelationalDatabase operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRelationalDatabaseParameters

      default CompletableFuture<UpdateRelationalDatabaseParametersResponse> updateRelationalDatabaseParameters(UpdateRelationalDatabaseParametersRequest updateRelationalDatabaseParametersRequest)

      Allows the update of one or more parameters of a database in Amazon Lightsail.

      Parameter updates don't cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which parameter updates are applied: dynamic or pending-reboot. Parameters marked with a dynamic apply type are applied immediately. Parameters marked with a pending-reboot apply type are applied only after the database is rebooted using the reboot relational database operation.

      The update relational database parameters operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.

      Parameters:
      updateRelationalDatabaseParametersRequest -
      Returns:
      A Java Future containing the result of the UpdateRelationalDatabaseParameters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateRelationalDatabaseParameters

      default CompletableFuture<UpdateRelationalDatabaseParametersResponse> updateRelationalDatabaseParameters(Consumer<UpdateRelationalDatabaseParametersRequest.Builder> updateRelationalDatabaseParametersRequest)

      Allows the update of one or more parameters of a database in Amazon Lightsail.

      Parameter updates don't cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which parameter updates are applied: dynamic or pending-reboot. Parameters marked with a dynamic apply type are applied immediately. Parameters marked with a pending-reboot apply type are applied only after the database is rebooted using the reboot relational database operation.

      The update relational database parameters operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.


      This is a convenience which creates an instance of the UpdateRelationalDatabaseParametersRequest.Builder avoiding the need to create one manually via UpdateRelationalDatabaseParametersRequest.builder()

      Parameters:
      updateRelationalDatabaseParametersRequest - A Consumer that will call methods on UpdateRelationalDatabaseParametersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateRelationalDatabaseParameters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.

      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • LightsailException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default LightsailServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static LightsailAsyncClient create()
      Create a LightsailAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static LightsailAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a LightsailAsyncClient.