AutoCloseable
@Generated("software.amazon.awssdk:codegen") public interface LightsailClient extends AutoCloseable
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 | Description |
---|---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method | Description |
---|---|---|
default AllocateStaticIpResponse |
allocateStaticIp(AllocateStaticIpRequest allocateStaticIpRequest) |
Allocates a static IP address.
|
default AttachStaticIpResponse |
attachStaticIp(AttachStaticIpRequest 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.
|
static LightsailClient |
create() |
Create a
LightsailClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateDomainResponse |
createDomain(CreateDomainRequest createDomainRequest) |
Creates a domain resource for the specified domain (e.g., example.com).
|
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(CreateInstancesRequest createInstancesRequest) |
Creates one or more Amazon Lightsail virtual private servers, or instances.
|
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(CreateInstanceSnapshotRequest createInstanceSnapshotRequest) |
Creates a snapshot of a specific virtual private server, or instance.
|
default CreateKeyPairResponse |
createKeyPair(CreateKeyPairRequest createKeyPairRequest) |
Creates sn SSH key pair.
|
default DeleteDomainResponse |
deleteDomain(DeleteDomainRequest deleteDomainRequest) |
Deletes the specified domain recordset and all of its domain records.
|
default DeleteDomainEntryResponse |
deleteDomainEntry(DeleteDomainEntryRequest deleteDomainEntryRequest) |
Deletes a specific domain entry.
|
default DeleteInstanceResponse |
deleteInstance(DeleteInstanceRequest deleteInstanceRequest) |
Deletes a specific Amazon Lightsail virtual private server, or instance.
|
default DeleteInstanceSnapshotResponse |
deleteInstanceSnapshot(DeleteInstanceSnapshotRequest deleteInstanceSnapshotRequest) |
Deletes a specific snapshot of a virtual private server (or instance).
|
default DeleteKeyPairResponse |
deleteKeyPair(DeleteKeyPairRequest deleteKeyPairRequest) |
Deletes a specific SSH key pair.
|
default DetachStaticIpResponse |
detachStaticIp(DetachStaticIpRequest detachStaticIpRequest) |
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
|
default DownloadDefaultKeyPairResponse |
downloadDefaultKeyPair(DownloadDefaultKeyPairRequest downloadDefaultKeyPairRequest) |
Downloads the default SSH key pair from the user's account.
|
default GetActiveNamesResponse |
getActiveNames(GetActiveNamesRequest getActiveNamesRequest) |
Returns the names of all active (not deleted) resources.
|
default GetBlueprintsResponse |
getBlueprints(GetBlueprintsRequest getBlueprintsRequest) |
Returns the list of available instance images, or blueprints.
|
default GetBundlesResponse |
getBundles(GetBundlesRequest getBundlesRequest) |
Returns the list of bundles that are available for purchase.
|
default GetDomainResponse |
getDomain(GetDomainRequest getDomainRequest) |
Returns information about a specific domain recordset.
|
default GetDomainsResponse |
getDomains(GetDomainsRequest getDomainsRequest) |
Returns a list of all domains in the user's account.
|
default GetInstanceResponse |
getInstance(GetInstanceRequest getInstanceRequest) |
Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
|
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(GetInstanceMetricDataRequest getInstanceMetricDataRequest) |
Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
|
default GetInstancePortStatesResponse |
getInstancePortStates(GetInstancePortStatesRequest getInstancePortStatesRequest) |
Returns the port states for a specific virtual private server, or instance.
|
default GetInstancesResponse |
getInstances(GetInstancesRequest getInstancesRequest) |
Returns information about all Amazon Lightsail virtual private servers, or instances.
|
default GetInstanceSnapshotResponse |
getInstanceSnapshot(GetInstanceSnapshotRequest getInstanceSnapshotRequest) |
Returns information about a specific instance snapshot.
|
default GetInstanceSnapshotsResponse |
getInstanceSnapshots(GetInstanceSnapshotsRequest getInstanceSnapshotsRequest) |
Returns all instance snapshots for the user's account.
|
default GetInstanceStateResponse |
getInstanceState(GetInstanceStateRequest getInstanceStateRequest) |
Returns the state of a specific instance.
|
default GetKeyPairResponse |
getKeyPair(GetKeyPairRequest getKeyPairRequest) |
Returns information about a specific key pair.
|
default GetKeyPairsResponse |
getKeyPairs(GetKeyPairsRequest getKeyPairsRequest) |
Returns information about all key pairs in the user's account.
|
default GetOperationResponse |
getOperation(GetOperationRequest getOperationRequest) |
Returns information about a specific operation.
|
default GetOperationsResponse |
getOperations(GetOperationsRequest getOperationsRequest) |
Returns information about all operations.
|
default GetOperationsForResourceResponse |
getOperationsForResource(GetOperationsForResourceRequest getOperationsForResourceRequest) |
Gets operations for a specific resource (e.g., an instance or a static IP).
|
default GetRegionsResponse |
getRegions(GetRegionsRequest getRegionsRequest) |
Returns a list of all valid regions for Amazon Lightsail.
|
default GetStaticIpResponse |
getStaticIp(GetStaticIpRequest getStaticIpRequest) |
Returns information about a specific static IP.
|
default GetStaticIpsResponse |
getStaticIps(GetStaticIpsRequest getStaticIpsRequest) |
Returns information about all static IPs in the user's account.
|
default ImportKeyPairResponse |
importKeyPair(ImportKeyPairRequest importKeyPairRequest) |
Imports a public SSH key from a specific key pair.
|
default IsVpcPeeredResponse |
isVpcPeered(IsVpcPeeredRequest isVpcPeeredRequest) |
Returns a Boolean value indicating whether your Lightsail VPC is peered.
|
default OpenInstancePublicPortsResponse |
openInstancePublicPorts(OpenInstancePublicPortsRequest openInstancePublicPortsRequest) |
Adds public ports to an Amazon Lightsail instance.
|
default PeerVpcResponse |
peerVpc(PeerVpcRequest peerVpcRequest) |
Tries to peer the Lightsail VPC with the user's default VPC.
|
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(RebootInstanceRequest rebootInstanceRequest) |
Restarts a specific instance.
|
default ReleaseStaticIpResponse |
releaseStaticIp(ReleaseStaticIpRequest releaseStaticIpRequest) |
Deletes a specific static IP from your account.
|
static ServiceMetadata |
serviceMetadata() |
|
default StartInstanceResponse |
startInstance(StartInstanceRequest startInstanceRequest) |
Starts a specific Amazon Lightsail instance from a stopped state.
|
default StopInstanceResponse |
stopInstance(StopInstanceRequest stopInstanceRequest) |
Stops a specific Amazon Lightsail instance that is currently running.
|
default UnpeerVpcResponse |
unpeerVpc(UnpeerVpcRequest unpeerVpcRequest) |
Attempts to unpeer the Lightsail VPC from the user's default VPC.
|
default UpdateDomainEntryResponse |
updateDomainEntry(UpdateDomainEntryRequest updateDomainEntryRequest) |
Updates a domain recordset after it is created.
|
close
static 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, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault AttachStaticIpResponse attachStaticIp(AttachStaticIpRequest attachStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CloseInstancePublicPortsResponse closeInstancePublicPorts(CloseInstancePublicPortsRequest closeInstancePublicPortsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateDomainResponse createDomain(CreateDomainRequest createDomainRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateDomainEntryResponse createDomainEntry(CreateDomainEntryRequest createDomainEntryRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateInstanceSnapshotResponse createInstanceSnapshot(CreateInstanceSnapshotRequest createInstanceSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateInstancesResponse createInstances(CreateInstancesRequest createInstancesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateInstancesFromSnapshotResponse createInstancesFromSnapshot(CreateInstancesFromSnapshotRequest createInstancesFromSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateKeyPairResponse createKeyPair(CreateKeyPairRequest createKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteDomainResponse deleteDomain(DeleteDomainRequest deleteDomainRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteDomainEntryResponse deleteDomainEntry(DeleteDomainEntryRequest deleteDomainEntryRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteInstanceResponse deleteInstance(DeleteInstanceRequest deleteInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteInstanceSnapshotResponse deleteInstanceSnapshot(DeleteInstanceSnapshotRequest deleteInstanceSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteKeyPairResponse deleteKeyPair(DeleteKeyPairRequest deleteKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DetachStaticIpResponse detachStaticIp(DetachStaticIpRequest detachStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DownloadDefaultKeyPairResponse downloadDefaultKeyPair(DownloadDefaultKeyPairRequest downloadDefaultKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetActiveNamesResponse getActiveNames(GetActiveNamesRequest getActiveNamesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetBlueprintsResponse getBlueprints(GetBlueprintsRequest getBlueprintsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetBundlesResponse getBundles(GetBundlesRequest getBundlesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetDomainResponse getDomain(GetDomainRequest getDomainRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetDomainsResponse getDomains(GetDomainsRequest getDomainsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetInstanceResponse getInstance(GetInstanceRequest getInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetInstanceAccessDetailsResponse getInstanceAccessDetails(GetInstanceAccessDetailsRequest getInstanceAccessDetailsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetInstanceMetricDataResponse getInstanceMetricData(GetInstanceMetricDataRequest getInstanceMetricDataRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetInstancePortStatesResponse getInstancePortStates(GetInstancePortStatesRequest getInstancePortStatesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetInstanceSnapshotResponse getInstanceSnapshot(GetInstanceSnapshotRequest getInstanceSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetInstanceSnapshotsResponse getInstanceSnapshots(GetInstanceSnapshotsRequest getInstanceSnapshotsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetInstanceStateResponse getInstanceState(GetInstanceStateRequest getInstanceStateRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetInstancesResponse getInstances(GetInstancesRequest getInstancesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetKeyPairResponse getKeyPair(GetKeyPairRequest getKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetKeyPairsResponse getKeyPairs(GetKeyPairsRequest getKeyPairsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetOperationResponse getOperation(GetOperationRequest getOperationRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetOperationsResponse getOperations(GetOperationsRequest getOperationsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetOperationsForResourceResponse getOperationsForResource(GetOperationsForResourceRequest getOperationsForResourceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetRegionsResponse getRegions(GetRegionsRequest getRegionsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetStaticIpResponse getStaticIp(GetStaticIpRequest getStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetStaticIpsResponse getStaticIps(GetStaticIpsRequest getStaticIpsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ImportKeyPairResponse importKeyPair(ImportKeyPairRequest importKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault IsVpcPeeredResponse isVpcPeered(IsVpcPeeredRequest isVpcPeeredRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault OpenInstancePublicPortsResponse openInstancePublicPorts(OpenInstancePublicPortsRequest openInstancePublicPortsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault PeerVpcResponse peerVpc(PeerVpcRequest peerVpcRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault PutInstancePublicPortsResponse putInstancePublicPorts(PutInstancePublicPortsRequest putInstancePublicPortsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RebootInstanceResponse rebootInstance(RebootInstanceRequest rebootInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ReleaseStaticIpResponse releaseStaticIp(ReleaseStaticIpRequest releaseStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault StartInstanceResponse startInstance(StartInstanceRequest startInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault StopInstanceResponse stopInstance(StopInstanceRequest stopInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UnpeerVpcResponse unpeerVpc(UnpeerVpcRequest unpeerVpcRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateDomainEntryResponse updateDomainEntry(UpdateDomainEntryRequest updateDomainEntryRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, SdkBaseException, 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)LightsailException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typestatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.