@Generated(value="software.amazon.awssdk:codegen") public interface LightsailClient extends SdkClient, SdkAutoCloseable
builder() method.
Amazon Lightsail is the easiest way to get started with AWS for developers who just need virtual private servers. Lightsail includes everything you need to launch your project quickly - a virtual machine, SSD-based storage, data transfer, DNS management, and a static IP - for a low, predictable price. You manage those Lightsail servers through the Lightsail console or by using the API or command-line interface (CLI).
For more information about Lightsail concepts and tasks, see the Lightsail Dev Guide.
To use the Lightsail API or the CLI, you will need to use AWS Identity and Access Management (IAM) to generate access keys. For details about how to set this up, see the Lightsail Dev Guide.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AllocateStaticIpResponse |
allocateStaticIp(AllocateStaticIpRequest allocateStaticIpRequest)
Allocates a static IP address.
|
default AllocateStaticIpResponse |
allocateStaticIp(Consumer<AllocateStaticIpRequest.Builder> allocateStaticIpRequest)
Allocates a static IP address.
|
default 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.
|
default 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.
|
default AttachStaticIpResponse |
attachStaticIp(AttachStaticIpRequest attachStaticIpRequest)
Attaches a static IP address to a specific Amazon Lightsail instance.
|
default AttachStaticIpResponse |
attachStaticIp(Consumer<AttachStaticIpRequest.Builder> attachStaticIpRequest)
Attaches a static IP address to a specific Amazon Lightsail instance.
|
static LightsailClientBuilder |
builder()
Create a builder that can be used to configure and create a
LightsailClient. |
default CloseInstancePublicPortsResponse |
closeInstancePublicPorts(CloseInstancePublicPortsRequest closeInstancePublicPortsRequest)
Closes the public ports on a specific Amazon Lightsail instance.
|
default CloseInstancePublicPortsResponse |
closeInstancePublicPorts(Consumer<CloseInstancePublicPortsRequest.Builder> closeInstancePublicPortsRequest)
Closes the public ports on a specific Amazon Lightsail instance.
|
static LightsailClient |
create()
Create a
LightsailClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateDiskResponse |
createDisk(Consumer<CreateDiskRequest.Builder> createDiskRequest)
Creates a block storage disk that can be attached to a Lightsail instance in the same Availability Zone (e.g.,
us-east-2a). |
default CreateDiskResponse |
createDisk(CreateDiskRequest createDiskRequest)
Creates a block storage disk that can be attached to a Lightsail instance in the same Availability Zone (e.g.,
us-east-2a). |
default CreateDiskFromSnapshotResponse |
createDiskFromSnapshot(Consumer<CreateDiskFromSnapshotRequest.Builder> createDiskFromSnapshotRequest)
Creates a block storage disk from a disk snapshot that can be attached to a Lightsail instance in the same
Availability Zone (e.g.,
us-east-2a). |
default CreateDiskFromSnapshotResponse |
createDiskFromSnapshot(CreateDiskFromSnapshotRequest createDiskFromSnapshotRequest)
Creates a block storage disk from a disk snapshot that can be attached to a Lightsail instance in the same
Availability Zone (e.g.,
us-east-2a). |
default CreateDiskSnapshotResponse |
createDiskSnapshot(Consumer<CreateDiskSnapshotRequest.Builder> createDiskSnapshotRequest)
Creates a snapshot of a block storage disk.
|
default CreateDiskSnapshotResponse |
createDiskSnapshot(CreateDiskSnapshotRequest createDiskSnapshotRequest)
Creates a snapshot of a block storage disk.
|
default CreateDomainResponse |
createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest)
Creates a domain resource for the specified domain (e.g., example.com).
|
default CreateDomainResponse |
createDomain(CreateDomainRequest createDomainRequest)
Creates a domain resource for the specified domain (e.g., example.com).
|
default CreateDomainEntryResponse |
createDomainEntry(Consumer<CreateDomainEntryRequest.Builder> createDomainEntryRequest)
Creates one of the following entry records associated with the domain: A record, CNAME record, TXT record, or MX
record.
|
default CreateDomainEntryResponse |
createDomainEntry(CreateDomainEntryRequest createDomainEntryRequest)
Creates one of the following entry records associated with the domain: A record, CNAME record, TXT record, or MX
record.
|
default CreateInstancesResponse |
createInstances(Consumer<CreateInstancesRequest.Builder> createInstancesRequest)
Creates one or more Amazon Lightsail virtual private servers, or instances.
|
default CreateInstancesResponse |
createInstances(CreateInstancesRequest createInstancesRequest)
Creates one or more Amazon Lightsail virtual private servers, or instances.
|
default CreateInstancesFromSnapshotResponse |
createInstancesFromSnapshot(Consumer<CreateInstancesFromSnapshotRequest.Builder> createInstancesFromSnapshotRequest)
Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical
configuration.
|
default CreateInstancesFromSnapshotResponse |
createInstancesFromSnapshot(CreateInstancesFromSnapshotRequest createInstancesFromSnapshotRequest)
Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical
configuration.
|
default CreateInstanceSnapshotResponse |
createInstanceSnapshot(Consumer<CreateInstanceSnapshotRequest.Builder> createInstanceSnapshotRequest)
Creates a snapshot of a specific virtual private server, or instance.
|
default CreateInstanceSnapshotResponse |
createInstanceSnapshot(CreateInstanceSnapshotRequest createInstanceSnapshotRequest)
Creates a snapshot of a specific virtual private server, or instance.
|
default CreateKeyPairResponse |
createKeyPair(Consumer<CreateKeyPairRequest.Builder> createKeyPairRequest)
Creates sn SSH key pair.
|
default CreateKeyPairResponse |
createKeyPair(CreateKeyPairRequest createKeyPairRequest)
Creates sn SSH key pair.
|
default DeleteDiskResponse |
deleteDisk(Consumer<DeleteDiskRequest.Builder> deleteDiskRequest)
Deletes the specified block storage disk.
|
default DeleteDiskResponse |
deleteDisk(DeleteDiskRequest deleteDiskRequest)
Deletes the specified block storage disk.
|
default DeleteDiskSnapshotResponse |
deleteDiskSnapshot(Consumer<DeleteDiskSnapshotRequest.Builder> deleteDiskSnapshotRequest)
Deletes the specified disk snapshot.
|
default DeleteDiskSnapshotResponse |
deleteDiskSnapshot(DeleteDiskSnapshotRequest deleteDiskSnapshotRequest)
Deletes the specified disk snapshot.
|
default DeleteDomainResponse |
deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest)
Deletes the specified domain recordset and all of its domain records.
|
default DeleteDomainResponse |
deleteDomain(DeleteDomainRequest deleteDomainRequest)
Deletes the specified domain recordset and all of its domain records.
|
default DeleteDomainEntryResponse |
deleteDomainEntry(Consumer<DeleteDomainEntryRequest.Builder> deleteDomainEntryRequest)
Deletes a specific domain entry.
|
default DeleteDomainEntryResponse |
deleteDomainEntry(DeleteDomainEntryRequest deleteDomainEntryRequest)
Deletes a specific domain entry.
|
default DeleteInstanceResponse |
deleteInstance(Consumer<DeleteInstanceRequest.Builder> deleteInstanceRequest)
Deletes a specific Amazon Lightsail virtual private server, or instance.
|
default DeleteInstanceResponse |
deleteInstance(DeleteInstanceRequest deleteInstanceRequest)
Deletes a specific Amazon Lightsail virtual private server, or instance.
|
default DeleteInstanceSnapshotResponse |
deleteInstanceSnapshot(Consumer<DeleteInstanceSnapshotRequest.Builder> deleteInstanceSnapshotRequest)
Deletes a specific snapshot of a virtual private server (or instance).
|
default DeleteInstanceSnapshotResponse |
deleteInstanceSnapshot(DeleteInstanceSnapshotRequest deleteInstanceSnapshotRequest)
Deletes a specific snapshot of a virtual private server (or instance).
|
default DeleteKeyPairResponse |
deleteKeyPair(Consumer<DeleteKeyPairRequest.Builder> deleteKeyPairRequest)
Deletes a specific SSH key pair.
|
default DeleteKeyPairResponse |
deleteKeyPair(DeleteKeyPairRequest deleteKeyPairRequest)
Deletes a specific SSH key pair.
|
default DetachDiskResponse |
detachDisk(Consumer<DetachDiskRequest.Builder> detachDiskRequest)
Detaches a stopped block storage disk from a Lightsail instance.
|
default DetachDiskResponse |
detachDisk(DetachDiskRequest detachDiskRequest)
Detaches a stopped block storage disk from a Lightsail instance.
|
default DetachStaticIpResponse |
detachStaticIp(Consumer<DetachStaticIpRequest.Builder> detachStaticIpRequest)
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
|
default DetachStaticIpResponse |
detachStaticIp(DetachStaticIpRequest detachStaticIpRequest)
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
|
default DownloadDefaultKeyPairResponse |
downloadDefaultKeyPair()
Downloads the default SSH key pair from the user's account.
|
default DownloadDefaultKeyPairResponse |
downloadDefaultKeyPair(Consumer<DownloadDefaultKeyPairRequest.Builder> downloadDefaultKeyPairRequest)
Downloads the default SSH key pair from the user's account.
|
default DownloadDefaultKeyPairResponse |
downloadDefaultKeyPair(DownloadDefaultKeyPairRequest downloadDefaultKeyPairRequest)
Downloads the default SSH key pair from the user's account.
|
default GetActiveNamesResponse |
getActiveNames()
Returns the names of all active (not deleted) resources.
|
default GetActiveNamesResponse |
getActiveNames(Consumer<GetActiveNamesRequest.Builder> getActiveNamesRequest)
Returns the names of all active (not deleted) resources.
|
default GetActiveNamesResponse |
getActiveNames(GetActiveNamesRequest getActiveNamesRequest)
Returns the names of all active (not deleted) resources.
|
default GetBlueprintsResponse |
getBlueprints()
Returns the list of available instance images, or blueprints.
|
default GetBlueprintsResponse |
getBlueprints(Consumer<GetBlueprintsRequest.Builder> getBlueprintsRequest)
Returns the list of available instance images, or blueprints.
|
default GetBlueprintsResponse |
getBlueprints(GetBlueprintsRequest getBlueprintsRequest)
Returns the list of available instance images, or blueprints.
|
default GetBundlesResponse |
getBundles()
Returns the list of bundles that are available for purchase.
|
default GetBundlesResponse |
getBundles(Consumer<GetBundlesRequest.Builder> getBundlesRequest)
Returns the list of bundles that are available for purchase.
|
default GetBundlesResponse |
getBundles(GetBundlesRequest getBundlesRequest)
Returns the list of bundles that are available for purchase.
|
default GetDiskResponse |
getDisk(Consumer<GetDiskRequest.Builder> getDiskRequest)
Returns information about a specific block storage disk.
|
default GetDiskResponse |
getDisk(GetDiskRequest getDiskRequest)
Returns information about a specific block storage disk.
|
default GetDisksResponse |
getDisks()
Returns information about all block storage disks in your AWS account and region.
|
default GetDisksResponse |
getDisks(Consumer<GetDisksRequest.Builder> getDisksRequest)
Returns information about all block storage disks in your AWS account and region.
|
default GetDisksResponse |
getDisks(GetDisksRequest getDisksRequest)
Returns information about all block storage disks in your AWS account and region.
|
default GetDiskSnapshotResponse |
getDiskSnapshot(Consumer<GetDiskSnapshotRequest.Builder> getDiskSnapshotRequest)
Returns information about a specific block storage disk snapshot.
|
default GetDiskSnapshotResponse |
getDiskSnapshot(GetDiskSnapshotRequest getDiskSnapshotRequest)
Returns information about a specific block storage disk snapshot.
|
default GetDiskSnapshotsResponse |
getDiskSnapshots()
Returns information about all block storage disk snapshots in your AWS account and region.
|
default GetDiskSnapshotsResponse |
getDiskSnapshots(Consumer<GetDiskSnapshotsRequest.Builder> getDiskSnapshotsRequest)
Returns information about all block storage disk snapshots in your AWS account and region.
|
default GetDiskSnapshotsResponse |
getDiskSnapshots(GetDiskSnapshotsRequest getDiskSnapshotsRequest)
Returns information about all block storage disk snapshots in your AWS account and region.
|
default GetDomainResponse |
getDomain(Consumer<GetDomainRequest.Builder> getDomainRequest)
Returns information about a specific domain recordset.
|
default GetDomainResponse |
getDomain(GetDomainRequest getDomainRequest)
Returns information about a specific domain recordset.
|
default GetDomainsResponse |
getDomains()
Returns a list of all domains in the user's account.
|
default GetDomainsResponse |
getDomains(Consumer<GetDomainsRequest.Builder> getDomainsRequest)
Returns a list of all domains in the user's account.
|
default GetDomainsResponse |
getDomains(GetDomainsRequest getDomainsRequest)
Returns a list of all domains in the user's account.
|
default GetInstanceResponse |
getInstance(Consumer<GetInstanceRequest.Builder> getInstanceRequest)
Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
|
default GetInstanceResponse |
getInstance(GetInstanceRequest getInstanceRequest)
Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
|
default GetInstanceAccessDetailsResponse |
getInstanceAccessDetails(Consumer<GetInstanceAccessDetailsRequest.Builder> getInstanceAccessDetailsRequest)
Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
|
default GetInstanceAccessDetailsResponse |
getInstanceAccessDetails(GetInstanceAccessDetailsRequest getInstanceAccessDetailsRequest)
Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
|
default GetInstanceMetricDataResponse |
getInstanceMetricData(Consumer<GetInstanceMetricDataRequest.Builder> getInstanceMetricDataRequest)
Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
|
default GetInstanceMetricDataResponse |
getInstanceMetricData(GetInstanceMetricDataRequest getInstanceMetricDataRequest)
Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
|
default GetInstancePortStatesResponse |
getInstancePortStates(Consumer<GetInstancePortStatesRequest.Builder> getInstancePortStatesRequest)
Returns the port states for a specific virtual private server, or instance.
|
default GetInstancePortStatesResponse |
getInstancePortStates(GetInstancePortStatesRequest getInstancePortStatesRequest)
Returns the port states for a specific virtual private server, or instance.
|
default GetInstancesResponse |
getInstances()
Returns information about all Amazon Lightsail virtual private servers, or instances.
|
default GetInstancesResponse |
getInstances(Consumer<GetInstancesRequest.Builder> getInstancesRequest)
Returns information about all Amazon Lightsail virtual private servers, or instances.
|
default GetInstancesResponse |
getInstances(GetInstancesRequest getInstancesRequest)
Returns information about all Amazon Lightsail virtual private servers, or instances.
|
default GetInstanceSnapshotResponse |
getInstanceSnapshot(Consumer<GetInstanceSnapshotRequest.Builder> getInstanceSnapshotRequest)
Returns information about a specific instance snapshot.
|
default GetInstanceSnapshotResponse |
getInstanceSnapshot(GetInstanceSnapshotRequest getInstanceSnapshotRequest)
Returns information about a specific instance snapshot.
|
default GetInstanceSnapshotsResponse |
getInstanceSnapshots()
Returns all instance snapshots for the user's account.
|
default GetInstanceSnapshotsResponse |
getInstanceSnapshots(Consumer<GetInstanceSnapshotsRequest.Builder> getInstanceSnapshotsRequest)
Returns all instance snapshots for the user's account.
|
default GetInstanceSnapshotsResponse |
getInstanceSnapshots(GetInstanceSnapshotsRequest getInstanceSnapshotsRequest)
Returns all instance snapshots for the user's account.
|
default GetInstanceStateResponse |
getInstanceState(Consumer<GetInstanceStateRequest.Builder> getInstanceStateRequest)
Returns the state of a specific instance.
|
default GetInstanceStateResponse |
getInstanceState(GetInstanceStateRequest getInstanceStateRequest)
Returns the state of a specific instance.
|
default GetKeyPairResponse |
getKeyPair(Consumer<GetKeyPairRequest.Builder> getKeyPairRequest)
Returns information about a specific key pair.
|
default GetKeyPairResponse |
getKeyPair(GetKeyPairRequest getKeyPairRequest)
Returns information about a specific key pair.
|
default GetKeyPairsResponse |
getKeyPairs()
Returns information about all key pairs in the user's account.
|
default GetKeyPairsResponse |
getKeyPairs(Consumer<GetKeyPairsRequest.Builder> getKeyPairsRequest)
Returns information about all key pairs in the user's account.
|
default GetKeyPairsResponse |
getKeyPairs(GetKeyPairsRequest getKeyPairsRequest)
Returns information about all key pairs in the user's account.
|
default GetOperationResponse |
getOperation(Consumer<GetOperationRequest.Builder> getOperationRequest)
Returns information about a specific operation.
|
default GetOperationResponse |
getOperation(GetOperationRequest getOperationRequest)
Returns information about a specific operation.
|
default GetOperationsResponse |
getOperations()
Returns information about all operations.
|
default GetOperationsResponse |
getOperations(Consumer<GetOperationsRequest.Builder> getOperationsRequest)
Returns information about all operations.
|
default GetOperationsResponse |
getOperations(GetOperationsRequest getOperationsRequest)
Returns information about all operations.
|
default GetOperationsForResourceResponse |
getOperationsForResource(Consumer<GetOperationsForResourceRequest.Builder> getOperationsForResourceRequest)
Gets operations for a specific resource (e.g., an instance or a static IP).
|
default GetOperationsForResourceResponse |
getOperationsForResource(GetOperationsForResourceRequest getOperationsForResourceRequest)
Gets operations for a specific resource (e.g., an instance or a static IP).
|
default GetRegionsResponse |
getRegions()
Returns a list of all valid regions for Amazon Lightsail.
|
default GetRegionsResponse |
getRegions(Consumer<GetRegionsRequest.Builder> getRegionsRequest)
Returns a list of all valid regions for Amazon Lightsail.
|
default GetRegionsResponse |
getRegions(GetRegionsRequest getRegionsRequest)
Returns a list of all valid regions for Amazon Lightsail.
|
default GetStaticIpResponse |
getStaticIp(Consumer<GetStaticIpRequest.Builder> getStaticIpRequest)
Returns information about a specific static IP.
|
default GetStaticIpResponse |
getStaticIp(GetStaticIpRequest getStaticIpRequest)
Returns information about a specific static IP.
|
default GetStaticIpsResponse |
getStaticIps()
Returns information about all static IPs in the user's account.
|
default GetStaticIpsResponse |
getStaticIps(Consumer<GetStaticIpsRequest.Builder> getStaticIpsRequest)
Returns information about all static IPs in the user's account.
|
default GetStaticIpsResponse |
getStaticIps(GetStaticIpsRequest getStaticIpsRequest)
Returns information about all static IPs in the user's account.
|
default ImportKeyPairResponse |
importKeyPair(Consumer<ImportKeyPairRequest.Builder> importKeyPairRequest)
Imports a public SSH key from a specific key pair.
|
default ImportKeyPairResponse |
importKeyPair(ImportKeyPairRequest importKeyPairRequest)
Imports a public SSH key from a specific key pair.
|
default IsVpcPeeredResponse |
isVpcPeered()
Returns a Boolean value indicating whether your Lightsail VPC is peered.
|
default IsVpcPeeredResponse |
isVpcPeered(Consumer<IsVpcPeeredRequest.Builder> isVpcPeeredRequest)
Returns a Boolean value indicating whether your Lightsail VPC is peered.
|
default IsVpcPeeredResponse |
isVpcPeered(IsVpcPeeredRequest isVpcPeeredRequest)
Returns a Boolean value indicating whether your Lightsail VPC is peered.
|
default OpenInstancePublicPortsResponse |
openInstancePublicPorts(Consumer<OpenInstancePublicPortsRequest.Builder> openInstancePublicPortsRequest)
Adds public ports to an Amazon Lightsail instance.
|
default OpenInstancePublicPortsResponse |
openInstancePublicPorts(OpenInstancePublicPortsRequest openInstancePublicPortsRequest)
Adds public ports to an Amazon Lightsail instance.
|
default PeerVpcResponse |
peerVpc()
Tries to peer the Lightsail VPC with the user's default VPC.
|
default PeerVpcResponse |
peerVpc(Consumer<PeerVpcRequest.Builder> peerVpcRequest)
Tries to peer the Lightsail VPC with the user's default VPC.
|
default PeerVpcResponse |
peerVpc(PeerVpcRequest peerVpcRequest)
Tries to peer the Lightsail VPC with the user's default VPC.
|
default PutInstancePublicPortsResponse |
putInstancePublicPorts(Consumer<PutInstancePublicPortsRequest.Builder> putInstancePublicPortsRequest)
Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not
included in the current request.
|
default PutInstancePublicPortsResponse |
putInstancePublicPorts(PutInstancePublicPortsRequest putInstancePublicPortsRequest)
Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not
included in the current request.
|
default RebootInstanceResponse |
rebootInstance(Consumer<RebootInstanceRequest.Builder> rebootInstanceRequest)
Restarts a specific instance.
|
default RebootInstanceResponse |
rebootInstance(RebootInstanceRequest rebootInstanceRequest)
Restarts a specific instance.
|
default ReleaseStaticIpResponse |
releaseStaticIp(Consumer<ReleaseStaticIpRequest.Builder> releaseStaticIpRequest)
Deletes a specific static IP from your account.
|
default ReleaseStaticIpResponse |
releaseStaticIp(ReleaseStaticIpRequest releaseStaticIpRequest)
Deletes a specific static IP from your account.
|
static ServiceMetadata |
serviceMetadata() |
default StartInstanceResponse |
startInstance(Consumer<StartInstanceRequest.Builder> startInstanceRequest)
Starts a specific Amazon Lightsail instance from a stopped state.
|
default StartInstanceResponse |
startInstance(StartInstanceRequest startInstanceRequest)
Starts a specific Amazon Lightsail instance from a stopped state.
|
default StopInstanceResponse |
stopInstance(Consumer<StopInstanceRequest.Builder> stopInstanceRequest)
Stops a specific Amazon Lightsail instance that is currently running.
|
default StopInstanceResponse |
stopInstance(StopInstanceRequest stopInstanceRequest)
Stops a specific Amazon Lightsail instance that is currently running.
|
default UnpeerVpcResponse |
unpeerVpc()
Attempts to unpeer the Lightsail VPC from the user's default VPC.
|
default UnpeerVpcResponse |
unpeerVpc(Consumer<UnpeerVpcRequest.Builder> unpeerVpcRequest)
Attempts to unpeer the Lightsail VPC from the user's default VPC.
|
default UnpeerVpcResponse |
unpeerVpc(UnpeerVpcRequest unpeerVpcRequest)
Attempts to unpeer the Lightsail VPC from the user's default VPC.
|
default UpdateDomainEntryResponse |
updateDomainEntry(Consumer<UpdateDomainEntryRequest.Builder> updateDomainEntryRequest)
Updates a domain recordset after it is created.
|
default UpdateDomainEntryResponse |
updateDomainEntry(UpdateDomainEntryRequest updateDomainEntryRequest)
Updates a domain recordset after it is created.
|
serviceNameclosestatic final String SERVICE_NAME
static LightsailClient create()
LightsailClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static LightsailClientBuilder builder()
LightsailClient.default AllocateStaticIpResponse allocateStaticIp(AllocateStaticIpRequest allocateStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Allocates a static IP address.
allocateStaticIpRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault AllocateStaticIpResponse allocateStaticIp(Consumer<AllocateStaticIpRequest.Builder> allocateStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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()
allocateStaticIpRequest - A Consumer that will call methods on AllocateStaticIpRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault AttachDiskResponse attachDisk(AttachDiskRequest attachDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.
attachDiskRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault AttachDiskResponse attachDisk(Consumer<AttachDiskRequest.Builder> attachDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.
This is a convenience which creates an instance of the AttachDiskRequest.Builder avoiding the need to
create one manually via AttachDiskRequest.builder()
attachDiskRequest - A Consumer that will call methods on AttachDiskRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault AttachStaticIpResponse attachStaticIp(AttachStaticIpRequest attachStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Attaches a static IP address to a specific Amazon Lightsail instance.
attachStaticIpRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault AttachStaticIpResponse attachStaticIp(Consumer<AttachStaticIpRequest.Builder> attachStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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()
attachStaticIpRequest - A Consumer that will call methods on AttachStaticIpRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault CloseInstancePublicPortsResponse closeInstancePublicPorts(CloseInstancePublicPortsRequest closeInstancePublicPortsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Closes the public ports on a specific Amazon Lightsail instance.
closeInstancePublicPortsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault CloseInstancePublicPortsResponse closeInstancePublicPorts(Consumer<CloseInstancePublicPortsRequest.Builder> closeInstancePublicPortsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Closes the public ports on a specific Amazon Lightsail instance.
This is a convenience which creates an instance of the CloseInstancePublicPortsRequest.Builder avoiding
the need to create one manually via CloseInstancePublicPortsRequest.builder()
closeInstancePublicPortsRequest - A Consumer that will call methods on CloseInstancePublicPortsRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault CreateDiskResponse createDisk(CreateDiskRequest createDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates a block storage disk that can be attached to a Lightsail instance in the same Availability Zone (e.g.,
us-east-2a). The disk is created in the regional endpoint that you send the HTTP request to. For
more information, see Regions and Availability Zones in Lightsail.
createDiskRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault CreateDiskResponse createDisk(Consumer<CreateDiskRequest.Builder> createDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates a block storage disk that can be attached to a Lightsail instance in the same Availability Zone (e.g.,
us-east-2a). The disk is created in the regional endpoint that you send the HTTP request to. For
more information, see Regions and Availability Zones in Lightsail.
This is a convenience which creates an instance of the CreateDiskRequest.Builder avoiding the need to
create one manually via CreateDiskRequest.builder()
createDiskRequest - A Consumer that will call methods on CreateDiskRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault CreateDiskFromSnapshotResponse createDiskFromSnapshot(CreateDiskFromSnapshotRequest createDiskFromSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates a block storage disk from a disk snapshot that can be attached to a Lightsail instance in the same
Availability Zone (e.g., us-east-2a). The disk is created in the regional endpoint that you send the
HTTP request to. For more information, see Regions and Availability Zones in Lightsail.
createDiskFromSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault CreateDiskFromSnapshotResponse createDiskFromSnapshot(Consumer<CreateDiskFromSnapshotRequest.Builder> createDiskFromSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates a block storage disk from a disk snapshot that can be attached to a Lightsail instance in the same
Availability Zone (e.g., us-east-2a). The disk is created in the regional endpoint that you send the
HTTP request to. For more information, see Regions and Availability Zones in Lightsail.
This is a convenience which creates an instance of the CreateDiskFromSnapshotRequest.Builder avoiding the
need to create one manually via CreateDiskFromSnapshotRequest.builder()
createDiskFromSnapshotRequest - A Consumer that will call methods on CreateDiskFromSnapshotRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault CreateDiskSnapshotResponse createDiskSnapshot(CreateDiskSnapshotRequest createDiskSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
createDiskSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault CreateDiskSnapshotResponse createDiskSnapshot(Consumer<CreateDiskSnapshotRequest.Builder> createDiskSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
This is a convenience which creates an instance of the CreateDiskSnapshotRequest.Builder avoiding the
need to create one manually via CreateDiskSnapshotRequest.builder()
createDiskSnapshotRequest - A Consumer that will call methods on CreateDiskSnapshotRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault CreateDomainResponse createDomain(CreateDomainRequest createDomainRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates a domain resource for the specified domain (e.g., example.com).
createDomainRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault CreateDomainResponse createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates a domain resource for the specified domain (e.g., example.com).
This is a convenience which creates an instance of the CreateDomainRequest.Builder avoiding the need to
create one manually via CreateDomainRequest.builder()
createDomainRequest - A Consumer that will call methods on CreateDomainRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault CreateDomainEntryResponse createDomainEntry(CreateDomainEntryRequest createDomainEntryRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates one of the following entry records associated with the domain: A record, CNAME record, TXT record, or MX record.
createDomainEntryRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault CreateDomainEntryResponse createDomainEntry(Consumer<CreateDomainEntryRequest.Builder> createDomainEntryRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates one of the following entry records associated with the domain: A record, CNAME record, TXT record, or MX record.
This is a convenience which creates an instance of the CreateDomainEntryRequest.Builder avoiding the need
to create one manually via CreateDomainEntryRequest.builder()
createDomainEntryRequest - A Consumer that will call methods on CreateDomainEntryRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault CreateInstanceSnapshotResponse createInstanceSnapshot(CreateInstanceSnapshotRequest createInstanceSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
createInstanceSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault CreateInstanceSnapshotResponse createInstanceSnapshot(Consumer<CreateInstanceSnapshotRequest.Builder> createInstanceSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
This is a convenience which creates an instance of the CreateInstanceSnapshotRequest.Builder avoiding the
need to create one manually via CreateInstanceSnapshotRequest.builder()
createInstanceSnapshotRequest - A Consumer that will call methods on CreateInstanceSnapshotRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault CreateInstancesResponse createInstances(CreateInstancesRequest createInstancesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates one or more Amazon Lightsail virtual private servers, or instances.
createInstancesRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault CreateInstancesResponse createInstances(Consumer<CreateInstancesRequest.Builder> createInstancesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates one or more Amazon Lightsail virtual private servers, or instances.
This is a convenience which creates an instance of the CreateInstancesRequest.Builder avoiding the need
to create one manually via CreateInstancesRequest.builder()
createInstancesRequest - A Consumer that will call methods on CreateInstancesRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault CreateInstancesFromSnapshotResponse createInstancesFromSnapshot(CreateInstancesFromSnapshotRequest createInstancesFromSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical configuration.
createInstancesFromSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault CreateInstancesFromSnapshotResponse createInstancesFromSnapshot(Consumer<CreateInstancesFromSnapshotRequest.Builder> createInstancesFromSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical configuration.
This is a convenience which creates an instance of the CreateInstancesFromSnapshotRequest.Builder
avoiding the need to create one manually via CreateInstancesFromSnapshotRequest.builder()
createInstancesFromSnapshotRequest - A Consumer that will call methods on CreateInstancesFromSnapshotRequest.Builder to create
a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault CreateKeyPairResponse createKeyPair(CreateKeyPairRequest createKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates sn SSH key pair.
createKeyPairRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault CreateKeyPairResponse createKeyPair(Consumer<CreateKeyPairRequest.Builder> createKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates sn SSH key pair.
This is a convenience which creates an instance of the CreateKeyPairRequest.Builder avoiding the need to
create one manually via CreateKeyPairRequest.builder()
createKeyPairRequest - A Consumer that will call methods on CreateKeyPairRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault DeleteDiskResponse deleteDisk(DeleteDiskRequest deleteDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
deleteDiskRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault DeleteDiskResponse deleteDisk(Consumer<DeleteDiskRequest.Builder> deleteDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
This is a convenience which creates an instance of the DeleteDiskRequest.Builder avoiding the need to
create one manually via DeleteDiskRequest.builder()
deleteDiskRequest - A Consumer that will call methods on DeleteDiskRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault DeleteDiskSnapshotResponse deleteDiskSnapshot(DeleteDiskSnapshotRequest deleteDiskSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
deleteDiskSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault DeleteDiskSnapshotResponse deleteDiskSnapshot(Consumer<DeleteDiskSnapshotRequest.Builder> deleteDiskSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
This is a convenience which creates an instance of the DeleteDiskSnapshotRequest.Builder avoiding the
need to create one manually via DeleteDiskSnapshotRequest.builder()
deleteDiskSnapshotRequest - A Consumer that will call methods on DeleteDiskSnapshotRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault DeleteDomainResponse deleteDomain(DeleteDomainRequest deleteDomainRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes the specified domain recordset and all of its domain records.
deleteDomainRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault DeleteDomainResponse deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes the specified domain recordset and all of its domain records.
This is a convenience which creates an instance of the DeleteDomainRequest.Builder avoiding the need to
create one manually via DeleteDomainRequest.builder()
deleteDomainRequest - A Consumer that will call methods on DeleteDomainRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault DeleteDomainEntryResponse deleteDomainEntry(DeleteDomainEntryRequest deleteDomainEntryRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes a specific domain entry.
deleteDomainEntryRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault DeleteDomainEntryResponse deleteDomainEntry(Consumer<DeleteDomainEntryRequest.Builder> deleteDomainEntryRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes a specific domain entry.
This is a convenience which creates an instance of the DeleteDomainEntryRequest.Builder avoiding the need
to create one manually via DeleteDomainEntryRequest.builder()
deleteDomainEntryRequest - A Consumer that will call methods on DeleteDomainEntryRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault DeleteInstanceResponse deleteInstance(DeleteInstanceRequest deleteInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes a specific Amazon Lightsail virtual private server, or instance.
deleteInstanceRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault DeleteInstanceResponse deleteInstance(Consumer<DeleteInstanceRequest.Builder> deleteInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes a specific Amazon Lightsail virtual private server, or instance.
This is a convenience which creates an instance of the DeleteInstanceRequest.Builder avoiding the need to
create one manually via DeleteInstanceRequest.builder()
deleteInstanceRequest - A Consumer that will call methods on DeleteInstanceRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault DeleteInstanceSnapshotResponse deleteInstanceSnapshot(DeleteInstanceSnapshotRequest deleteInstanceSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes a specific snapshot of a virtual private server (or instance).
deleteInstanceSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault DeleteInstanceSnapshotResponse deleteInstanceSnapshot(Consumer<DeleteInstanceSnapshotRequest.Builder> deleteInstanceSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes a specific snapshot of a virtual private server (or instance).
This is a convenience which creates an instance of the DeleteInstanceSnapshotRequest.Builder avoiding the
need to create one manually via DeleteInstanceSnapshotRequest.builder()
deleteInstanceSnapshotRequest - A Consumer that will call methods on DeleteInstanceSnapshotRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault DeleteKeyPairResponse deleteKeyPair(DeleteKeyPairRequest deleteKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes a specific SSH key pair.
deleteKeyPairRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault DeleteKeyPairResponse deleteKeyPair(Consumer<DeleteKeyPairRequest.Builder> deleteKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes a specific SSH key pair.
This is a convenience which creates an instance of the DeleteKeyPairRequest.Builder avoiding the need to
create one manually via DeleteKeyPairRequest.builder()
deleteKeyPairRequest - A Consumer that will call methods on DeleteKeyPairRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault DetachDiskResponse detachDisk(DetachDiskRequest detachDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
detachDiskRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault DetachDiskResponse detachDisk(Consumer<DetachDiskRequest.Builder> detachDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
This is a convenience which creates an instance of the DetachDiskRequest.Builder avoiding the need to
create one manually via DetachDiskRequest.builder()
detachDiskRequest - A Consumer that will call methods on DetachDiskRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault DetachStaticIpResponse detachStaticIp(DetachStaticIpRequest detachStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
detachStaticIpRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault DetachStaticIpResponse detachStaticIp(Consumer<DetachStaticIpRequest.Builder> detachStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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()
detachStaticIpRequest - A Consumer that will call methods on DetachStaticIpRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault DownloadDefaultKeyPairResponse downloadDefaultKeyPair() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Downloads the default SSH key pair from the user's account.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondownloadDefaultKeyPair(DownloadDefaultKeyPairRequest),
AWS API Documentationdefault DownloadDefaultKeyPairResponse downloadDefaultKeyPair(DownloadDefaultKeyPairRequest downloadDefaultKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Downloads the default SSH key pair from the user's account.
downloadDefaultKeyPairRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault DownloadDefaultKeyPairResponse downloadDefaultKeyPair(Consumer<DownloadDefaultKeyPairRequest.Builder> downloadDefaultKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Downloads the default SSH key pair from the user's account.
This is a convenience which creates an instance of the DownloadDefaultKeyPairRequest.Builder avoiding the
need to create one manually via DownloadDefaultKeyPairRequest.builder()
downloadDefaultKeyPairRequest - A Consumer that will call methods on DownloadDefaultKeyPairRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetActiveNamesResponse getActiveNames() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the names of all active (not deleted) resources.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiongetActiveNames(GetActiveNamesRequest),
AWS API
Documentationdefault GetActiveNamesResponse getActiveNames(GetActiveNamesRequest getActiveNamesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the names of all active (not deleted) resources.
getActiveNamesRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetActiveNamesResponse getActiveNames(Consumer<GetActiveNamesRequest.Builder> getActiveNamesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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()
getActiveNamesRequest - A Consumer that will call methods on GetActiveNamesRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetBlueprintsResponse getBlueprints() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the list of available instance images, or blueprints. You can use a blueprint to create a new virtual private server already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiongetBlueprints(GetBlueprintsRequest),
AWS API
Documentationdefault GetBlueprintsResponse getBlueprints(GetBlueprintsRequest getBlueprintsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the list of available instance images, or blueprints. You can use a blueprint to create a new virtual private server already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.
getBlueprintsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetBlueprintsResponse getBlueprints(Consumer<GetBlueprintsRequest.Builder> getBlueprintsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the list of available instance images, or blueprints. You can use a blueprint to create a new virtual private server already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.
This is a convenience which creates an instance of the GetBlueprintsRequest.Builder avoiding the need to
create one manually via GetBlueprintsRequest.builder()
getBlueprintsRequest - A Consumer that will call methods on GetBlueprintsRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetBundlesResponse getBundles() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance).
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiongetBundles(GetBundlesRequest),
AWS API
Documentationdefault GetBundlesResponse getBundles(GetBundlesRequest getBundlesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance).
getBundlesRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetBundlesResponse getBundles(Consumer<GetBundlesRequest.Builder> getBundlesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance).
This is a convenience which creates an instance of the GetBundlesRequest.Builder avoiding the need to
create one manually via GetBundlesRequest.builder()
getBundlesRequest - A Consumer that will call methods on GetBundlesRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetDiskResponse getDisk(GetDiskRequest getDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about a specific block storage disk.
getDiskRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetDiskResponse getDisk(Consumer<GetDiskRequest.Builder> getDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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()
getDiskRequest - A Consumer that will call methods on GetDiskRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetDiskSnapshotResponse getDiskSnapshot(GetDiskSnapshotRequest getDiskSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about a specific block storage disk snapshot.
getDiskSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetDiskSnapshotResponse getDiskSnapshot(Consumer<GetDiskSnapshotRequest.Builder> getDiskSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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()
getDiskSnapshotRequest - A Consumer that will call methods on GetDiskSnapshotRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetDiskSnapshotsResponse getDiskSnapshots() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all block storage disk snapshots in your AWS account and region.
If you are describing a long list of disk snapshots, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiongetDiskSnapshots(GetDiskSnapshotsRequest),
AWS API
Documentationdefault GetDiskSnapshotsResponse getDiskSnapshots(GetDiskSnapshotsRequest getDiskSnapshotsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all block storage disk snapshots in your AWS account and region.
If you are describing a long list of disk snapshots, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
getDiskSnapshotsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetDiskSnapshotsResponse getDiskSnapshots(Consumer<GetDiskSnapshotsRequest.Builder> getDiskSnapshotsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all block storage disk snapshots in your AWS account and region.
If you are describing a long list of disk snapshots, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
This is a convenience which creates an instance of the GetDiskSnapshotsRequest.Builder avoiding the need
to create one manually via GetDiskSnapshotsRequest.builder()
getDiskSnapshotsRequest - A Consumer that will call methods on GetDiskSnapshotsRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetDisksResponse getDisks() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all block storage disks in your AWS account and region.
If you are describing a long list of disks, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiongetDisks(GetDisksRequest),
AWS API
Documentationdefault GetDisksResponse getDisks(GetDisksRequest getDisksRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all block storage disks in your AWS account and region.
If you are describing a long list of disks, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
getDisksRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetDisksResponse getDisks(Consumer<GetDisksRequest.Builder> getDisksRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all block storage disks in your AWS account and region.
If you are describing a long list of disks, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
This is a convenience which creates an instance of the GetDisksRequest.Builder avoiding the need to
create one manually via GetDisksRequest.builder()
getDisksRequest - A Consumer that will call methods on GetDisksRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetDomainResponse getDomain(GetDomainRequest getDomainRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about a specific domain recordset.
getDomainRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetDomainResponse getDomain(Consumer<GetDomainRequest.Builder> getDomainRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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()
getDomainRequest - A Consumer that will call methods on GetDomainRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetDomainsResponse getDomains() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns a list of all domains in the user's account.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiongetDomains(GetDomainsRequest),
AWS API
Documentationdefault GetDomainsResponse getDomains(GetDomainsRequest getDomainsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns a list of all domains in the user's account.
getDomainsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetDomainsResponse getDomains(Consumer<GetDomainsRequest.Builder> getDomainsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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()
getDomainsRequest - A Consumer that will call methods on GetDomainsRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetInstanceResponse getInstance(GetInstanceRequest getInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
getInstanceRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetInstanceResponse getInstance(Consumer<GetInstanceRequest.Builder> getInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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()
getInstanceRequest - A Consumer that will call methods on GetInstanceRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetInstanceAccessDetailsResponse getInstanceAccessDetails(GetInstanceAccessDetailsRequest getInstanceAccessDetailsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
getInstanceAccessDetailsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetInstanceAccessDetailsResponse getInstanceAccessDetails(Consumer<GetInstanceAccessDetailsRequest.Builder> getInstanceAccessDetailsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
This is a convenience which creates an instance of the GetInstanceAccessDetailsRequest.Builder avoiding
the need to create one manually via GetInstanceAccessDetailsRequest.builder()
getInstanceAccessDetailsRequest - A Consumer that will call methods on GetInstanceAccessDetailsRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetInstanceMetricDataResponse getInstanceMetricData(GetInstanceMetricDataRequest getInstanceMetricDataRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
getInstanceMetricDataRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetInstanceMetricDataResponse getInstanceMetricData(Consumer<GetInstanceMetricDataRequest.Builder> getInstanceMetricDataRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
This is a convenience which creates an instance of the GetInstanceMetricDataRequest.Builder avoiding the
need to create one manually via GetInstanceMetricDataRequest.builder()
getInstanceMetricDataRequest - A Consumer that will call methods on GetInstanceMetricDataRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetInstancePortStatesResponse getInstancePortStates(GetInstancePortStatesRequest getInstancePortStatesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the port states for a specific virtual private server, or instance.
getInstancePortStatesRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetInstancePortStatesResponse getInstancePortStates(Consumer<GetInstancePortStatesRequest.Builder> getInstancePortStatesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the port states for a specific virtual private server, or instance.
This is a convenience which creates an instance of the GetInstancePortStatesRequest.Builder avoiding the
need to create one manually via GetInstancePortStatesRequest.builder()
getInstancePortStatesRequest - A Consumer that will call methods on GetInstancePortStatesRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetInstanceSnapshotResponse getInstanceSnapshot(GetInstanceSnapshotRequest getInstanceSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about a specific instance snapshot.
getInstanceSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetInstanceSnapshotResponse getInstanceSnapshot(Consumer<GetInstanceSnapshotRequest.Builder> getInstanceSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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()
getInstanceSnapshotRequest - A Consumer that will call methods on GetInstanceSnapshotRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetInstanceSnapshotsResponse getInstanceSnapshots() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns all instance snapshots for the user's account.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiongetInstanceSnapshots(GetInstanceSnapshotsRequest),
AWS
API Documentationdefault GetInstanceSnapshotsResponse getInstanceSnapshots(GetInstanceSnapshotsRequest getInstanceSnapshotsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns all instance snapshots for the user's account.
getInstanceSnapshotsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetInstanceSnapshotsResponse getInstanceSnapshots(Consumer<GetInstanceSnapshotsRequest.Builder> getInstanceSnapshotsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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()
getInstanceSnapshotsRequest - A Consumer that will call methods on GetInstanceSnapshotsRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetInstanceStateResponse getInstanceState(GetInstanceStateRequest getInstanceStateRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the state of a specific instance. Works on one instance at a time.
getInstanceStateRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetInstanceStateResponse getInstanceState(Consumer<GetInstanceStateRequest.Builder> getInstanceStateRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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()
getInstanceStateRequest - A Consumer that will call methods on GetInstanceStateRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetInstancesResponse getInstances() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all Amazon Lightsail virtual private servers, or instances.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiongetInstances(GetInstancesRequest),
AWS API
Documentationdefault GetInstancesResponse getInstances(GetInstancesRequest getInstancesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all Amazon Lightsail virtual private servers, or instances.
getInstancesRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetInstancesResponse getInstances(Consumer<GetInstancesRequest.Builder> getInstancesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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()
getInstancesRequest - A Consumer that will call methods on GetInstancesRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetKeyPairResponse getKeyPair(GetKeyPairRequest getKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about a specific key pair.
getKeyPairRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetKeyPairResponse getKeyPair(Consumer<GetKeyPairRequest.Builder> getKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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()
getKeyPairRequest - A Consumer that will call methods on GetKeyPairRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetKeyPairsResponse getKeyPairs() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all key pairs in the user's account.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiongetKeyPairs(GetKeyPairsRequest),
AWS API
Documentationdefault GetKeyPairsResponse getKeyPairs(GetKeyPairsRequest getKeyPairsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all key pairs in the user's account.
getKeyPairsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetKeyPairsResponse getKeyPairs(Consumer<GetKeyPairsRequest.Builder> getKeyPairsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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()
getKeyPairsRequest - A Consumer that will call methods on GetKeyPairsRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetOperationResponse getOperation(GetOperationRequest getOperationRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
getOperationRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetOperationResponse getOperation(Consumer<GetOperationRequest.Builder> getOperationRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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()
getOperationRequest - A Consumer that will call methods on GetOperationRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetOperationsResponse getOperations() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiongetOperations(GetOperationsRequest),
AWS API
Documentationdefault GetOperationsResponse getOperations(GetOperationsRequest getOperationsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
getOperationsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetOperationsResponse getOperations(Consumer<GetOperationsRequest.Builder> getOperationsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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()
getOperationsRequest - A Consumer that will call methods on GetOperationsRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetOperationsForResourceResponse getOperationsForResource(GetOperationsForResourceRequest getOperationsForResourceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Gets operations for a specific resource (e.g., an instance or a static IP).
getOperationsForResourceRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetOperationsForResourceResponse getOperationsForResource(Consumer<GetOperationsForResourceRequest.Builder> getOperationsForResourceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Gets operations for a specific resource (e.g., 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()
getOperationsForResourceRequest - A Consumer that will call methods on GetOperationsForResourceRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetRegionsResponse getRegions() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiongetRegions(GetRegionsRequest),
AWS API
Documentationdefault GetRegionsResponse getRegions(GetRegionsRequest getRegionsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
getRegionsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetRegionsResponse getRegions(Consumer<GetRegionsRequest.Builder> getRegionsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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()
getRegionsRequest - A Consumer that will call methods on GetRegionsRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetStaticIpResponse getStaticIp(GetStaticIpRequest getStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about a specific static IP.
getStaticIpRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetStaticIpResponse getStaticIp(Consumer<GetStaticIpRequest.Builder> getStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about a specific static IP.
This is a convenience which creates an instance of the GetStaticIpRequest.Builder avoiding the need to
create one manually via GetStaticIpRequest.builder()
getStaticIpRequest - A Consumer that will call methods on GetStaticIpRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetStaticIpsResponse getStaticIps() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all static IPs in the user's account.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiongetStaticIps(GetStaticIpsRequest),
AWS API
Documentationdefault GetStaticIpsResponse getStaticIps(GetStaticIpsRequest getStaticIpsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all static IPs in the user's account.
getStaticIpsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault GetStaticIpsResponse getStaticIps(Consumer<GetStaticIpsRequest.Builder> getStaticIpsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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()
getStaticIpsRequest - A Consumer that will call methods on GetStaticIpsRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault ImportKeyPairResponse importKeyPair(ImportKeyPairRequest importKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Imports a public SSH key from a specific key pair.
importKeyPairRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault ImportKeyPairResponse importKeyPair(Consumer<ImportKeyPairRequest.Builder> importKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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()
importKeyPairRequest - A Consumer that will call methods on ImportKeyPairRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault IsVpcPeeredResponse isVpcPeered() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns a Boolean value indicating whether your Lightsail VPC is peered.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptionisVpcPeered(IsVpcPeeredRequest),
AWS API
Documentationdefault IsVpcPeeredResponse isVpcPeered(IsVpcPeeredRequest isVpcPeeredRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns a Boolean value indicating whether your Lightsail VPC is peered.
isVpcPeeredRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault IsVpcPeeredResponse isVpcPeered(Consumer<IsVpcPeeredRequest.Builder> isVpcPeeredRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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()
isVpcPeeredRequest - A Consumer that will call methods on IsVpcPeeredRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault OpenInstancePublicPortsResponse openInstancePublicPorts(OpenInstancePublicPortsRequest openInstancePublicPortsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Adds public ports to an Amazon Lightsail instance.
openInstancePublicPortsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault OpenInstancePublicPortsResponse openInstancePublicPorts(Consumer<OpenInstancePublicPortsRequest.Builder> openInstancePublicPortsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Adds public ports to an Amazon Lightsail instance.
This is a convenience which creates an instance of the OpenInstancePublicPortsRequest.Builder avoiding
the need to create one manually via OpenInstancePublicPortsRequest.builder()
openInstancePublicPortsRequest - A Consumer that will call methods on OpenInstancePublicPortsRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault PeerVpcResponse peerVpc() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Tries to peer the Lightsail VPC with the user's default VPC.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptionpeerVpc(PeerVpcRequest),
AWS API
Documentationdefault PeerVpcResponse peerVpc(PeerVpcRequest peerVpcRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Tries to peer the Lightsail VPC with the user's default VPC.
peerVpcRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault PeerVpcResponse peerVpc(Consumer<PeerVpcRequest.Builder> peerVpcRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Tries to peer 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()
peerVpcRequest - A Consumer that will call methods on PeerVpcRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault PutInstancePublicPortsResponse putInstancePublicPorts(PutInstancePublicPortsRequest putInstancePublicPortsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not included in the current request.
putInstancePublicPortsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault PutInstancePublicPortsResponse putInstancePublicPorts(Consumer<PutInstancePublicPortsRequest.Builder> putInstancePublicPortsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not included in the current request.
This is a convenience which creates an instance of the PutInstancePublicPortsRequest.Builder avoiding the
need to create one manually via PutInstancePublicPortsRequest.builder()
putInstancePublicPortsRequest - A Consumer that will call methods on PutInstancePublicPortsRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault RebootInstanceResponse rebootInstance(RebootInstanceRequest rebootInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Restarts a specific instance. When your Amazon Lightsail instance is finished rebooting, Lightsail assigns a new public IP address. To use the same IP address after restarting, create a static IP address and attach it to the instance.
rebootInstanceRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault RebootInstanceResponse rebootInstance(Consumer<RebootInstanceRequest.Builder> rebootInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Restarts a specific instance. When your Amazon Lightsail instance is finished rebooting, Lightsail assigns a new public IP address. To use the same IP address after restarting, create a static IP address and attach it to the instance.
This is a convenience which creates an instance of the RebootInstanceRequest.Builder avoiding the need to
create one manually via RebootInstanceRequest.builder()
rebootInstanceRequest - A Consumer that will call methods on RebootInstanceRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault ReleaseStaticIpResponse releaseStaticIp(ReleaseStaticIpRequest releaseStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes a specific static IP from your account.
releaseStaticIpRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault ReleaseStaticIpResponse releaseStaticIp(Consumer<ReleaseStaticIpRequest.Builder> releaseStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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()
releaseStaticIpRequest - A Consumer that will call methods on ReleaseStaticIpRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault StartInstanceResponse startInstance(StartInstanceRequest startInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation.
startInstanceRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault StartInstanceResponse startInstance(Consumer<StartInstanceRequest.Builder> startInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation.
This is a convenience which creates an instance of the StartInstanceRequest.Builder avoiding the need to
create one manually via StartInstanceRequest.builder()
startInstanceRequest - A Consumer that will call methods on StartInstanceRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault StopInstanceResponse stopInstance(StopInstanceRequest stopInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Stops a specific Amazon Lightsail instance that is currently running.
stopInstanceRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault StopInstanceResponse stopInstance(Consumer<StopInstanceRequest.Builder> stopInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Stops a specific Amazon Lightsail instance that is currently running.
This is a convenience which creates an instance of the StopInstanceRequest.Builder avoiding the need to
create one manually via StopInstanceRequest.builder()
stopInstanceRequest - A Consumer that will call methods on StopInstanceRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault UnpeerVpcResponse unpeerVpc() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Attempts to unpeer the Lightsail VPC from the user's default VPC.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptionunpeerVpc(UnpeerVpcRequest),
AWS API
Documentationdefault UnpeerVpcResponse unpeerVpc(UnpeerVpcRequest unpeerVpcRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Attempts to unpeer the Lightsail VPC from the user's default VPC.
unpeerVpcRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault UnpeerVpcResponse unpeerVpc(Consumer<UnpeerVpcRequest.Builder> unpeerVpcRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Attempts to unpeer 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()
unpeerVpcRequest - A Consumer that will call methods on UnpeerVpcRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault UpdateDomainEntryResponse updateDomainEntry(UpdateDomainEntryRequest updateDomainEntryRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Updates a domain recordset after it is created.
updateDomainEntryRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptiondefault UpdateDomainEntryResponse updateDomainEntry(Consumer<UpdateDomainEntryRequest.Builder> updateDomainEntryRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Updates a domain recordset after it is created.
This is a convenience which creates an instance of the UpdateDomainEntryRequest.Builder avoiding the need
to create one manually via UpdateDomainEntryRequest.builder()
updateDomainEntryRequest - A Consumer that will call methods on UpdateDomainEntryRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.