@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonLightsail
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonLightsail instead.
Amazon Lightsail is the easiest way to get started with AWS for developers who just need virtual private servers. Lightsail includes everything you need to launch your project quickly - a virtual machine, SSD-based storage, data transfer, DNS management, and a static IP - for a low, predictable price. You manage those Lightsail servers through the Lightsail console or by using the API or command-line interface (CLI).
For more information about Lightsail concepts and tasks, see the Lightsail Dev Guide.
To use the Lightsail API or the CLI, you will need to use AWS Identity and Access Management (IAM) to generate access keys. For details about how to set this up, see the Lightsail Dev Guide.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
AllocateStaticIpResult |
allocateStaticIp(AllocateStaticIpRequest allocateStaticIpRequest)
Allocates a static IP address.
|
AttachStaticIpResult |
attachStaticIp(AttachStaticIpRequest attachStaticIpRequest)
Attaches a static IP address to a specific Amazon Lightsail instance.
|
CloseInstancePublicPortsResult |
closeInstancePublicPorts(CloseInstancePublicPortsRequest closeInstancePublicPortsRequest)
Closes the public ports on a specific Amazon Lightsail instance.
|
CreateDomainResult |
createDomain(CreateDomainRequest createDomainRequest)
Creates a domain resource for the specified domain (e.g., example.com).
|
CreateDomainEntryResult |
createDomainEntry(CreateDomainEntryRequest createDomainEntryRequest)
Creates one of the following entry records associated with the domain: A record, CNAME record, TXT record, or MX
record.
|
CreateInstancesResult |
createInstances(CreateInstancesRequest createInstancesRequest)
Creates one or more Amazon Lightsail virtual private servers, or instances.
|
CreateInstancesFromSnapshotResult |
createInstancesFromSnapshot(CreateInstancesFromSnapshotRequest createInstancesFromSnapshotRequest)
Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical
configuration.
|
CreateInstanceSnapshotResult |
createInstanceSnapshot(CreateInstanceSnapshotRequest createInstanceSnapshotRequest)
Creates a snapshot of a specific virtual private server, or instance.
|
CreateKeyPairResult |
createKeyPair(CreateKeyPairRequest createKeyPairRequest)
Creates sn SSH key pair.
|
DeleteDomainResult |
deleteDomain(DeleteDomainRequest deleteDomainRequest)
Deletes the specified domain recordset and all of its domain records.
|
DeleteDomainEntryResult |
deleteDomainEntry(DeleteDomainEntryRequest deleteDomainEntryRequest)
Deletes a specific domain entry.
|
DeleteInstanceResult |
deleteInstance(DeleteInstanceRequest deleteInstanceRequest)
Deletes a specific Amazon Lightsail virtual private server, or instance.
|
DeleteInstanceSnapshotResult |
deleteInstanceSnapshot(DeleteInstanceSnapshotRequest deleteInstanceSnapshotRequest)
Deletes a specific snapshot of a virtual private server (or instance).
|
DeleteKeyPairResult |
deleteKeyPair(DeleteKeyPairRequest deleteKeyPairRequest)
Deletes a specific SSH key pair.
|
DetachStaticIpResult |
detachStaticIp(DetachStaticIpRequest detachStaticIpRequest)
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
|
DownloadDefaultKeyPairResult |
downloadDefaultKeyPair(DownloadDefaultKeyPairRequest downloadDefaultKeyPairRequest)
Downloads the default SSH key pair from the user's account.
|
GetActiveNamesResult |
getActiveNames(GetActiveNamesRequest getActiveNamesRequest)
Returns the names of all active (not deleted) resources.
|
GetBlueprintsResult |
getBlueprints(GetBlueprintsRequest getBlueprintsRequest)
Returns the list of available instance images, or blueprints.
|
GetBundlesResult |
getBundles(GetBundlesRequest getBundlesRequest)
Returns the list of bundles that are available for purchase.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetDomainResult |
getDomain(GetDomainRequest getDomainRequest)
Returns information about a specific domain recordset.
|
GetDomainsResult |
getDomains(GetDomainsRequest getDomainsRequest)
Returns a list of all domains in the user's account.
|
GetInstanceResult |
getInstance(GetInstanceRequest getInstanceRequest)
Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
|
GetInstanceAccessDetailsResult |
getInstanceAccessDetails(GetInstanceAccessDetailsRequest getInstanceAccessDetailsRequest)
Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
|
GetInstanceMetricDataResult |
getInstanceMetricData(GetInstanceMetricDataRequest getInstanceMetricDataRequest)
Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
|
GetInstancePortStatesResult |
getInstancePortStates(GetInstancePortStatesRequest getInstancePortStatesRequest)
Returns the port states for a specific virtual private server, or instance.
|
GetInstancesResult |
getInstances(GetInstancesRequest getInstancesRequest)
Returns information about all Amazon Lightsail virtual private servers, or instances.
|
GetInstanceSnapshotResult |
getInstanceSnapshot(GetInstanceSnapshotRequest getInstanceSnapshotRequest)
Returns information about a specific instance snapshot.
|
GetInstanceSnapshotsResult |
getInstanceSnapshots(GetInstanceSnapshotsRequest getInstanceSnapshotsRequest)
Returns all instance snapshots for the user's account.
|
GetInstanceStateResult |
getInstanceState(GetInstanceStateRequest getInstanceStateRequest)
Returns the state of a specific instance.
|
GetKeyPairResult |
getKeyPair(GetKeyPairRequest getKeyPairRequest)
Returns information about a specific key pair.
|
GetKeyPairsResult |
getKeyPairs(GetKeyPairsRequest getKeyPairsRequest)
Returns information about all key pairs in the user's account.
|
GetOperationResult |
getOperation(GetOperationRequest getOperationRequest)
Returns information about a specific operation.
|
GetOperationsResult |
getOperations(GetOperationsRequest getOperationsRequest)
Returns information about all operations.
|
GetOperationsForResourceResult |
getOperationsForResource(GetOperationsForResourceRequest getOperationsForResourceRequest)
Gets operations for a specific resource (e.g., an instance or a static IP).
|
GetRegionsResult |
getRegions(GetRegionsRequest getRegionsRequest)
Returns a list of all valid regions for Amazon Lightsail.
|
GetStaticIpResult |
getStaticIp(GetStaticIpRequest getStaticIpRequest)
Returns information about a specific static IP.
|
GetStaticIpsResult |
getStaticIps(GetStaticIpsRequest getStaticIpsRequest)
Returns information about all static IPs in the user's account.
|
ImportKeyPairResult |
importKeyPair(ImportKeyPairRequest importKeyPairRequest)
Imports a public SSH key from a specific key pair.
|
IsVpcPeeredResult |
isVpcPeered(IsVpcPeeredRequest isVpcPeeredRequest)
Returns a Boolean value indicating whether your Lightsail VPC is peered.
|
OpenInstancePublicPortsResult |
openInstancePublicPorts(OpenInstancePublicPortsRequest openInstancePublicPortsRequest)
Adds public ports to an Amazon Lightsail instance.
|
PeerVpcResult |
peerVpc(PeerVpcRequest peerVpcRequest)
Tries to peer the Lightsail VPC with the user's default VPC.
|
PutInstancePublicPortsResult |
putInstancePublicPorts(PutInstancePublicPortsRequest putInstancePublicPortsRequest)
Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not
included in the current request.
|
RebootInstanceResult |
rebootInstance(RebootInstanceRequest rebootInstanceRequest)
Restarts a specific instance.
|
ReleaseStaticIpResult |
releaseStaticIp(ReleaseStaticIpRequest releaseStaticIpRequest)
Deletes a specific static IP from your account.
|
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartInstanceResult |
startInstance(StartInstanceRequest startInstanceRequest)
Starts a specific Amazon Lightsail instance from a stopped state.
|
StopInstanceResult |
stopInstance(StopInstanceRequest stopInstanceRequest)
Stops a specific Amazon Lightsail instance that is currently running.
|
UnpeerVpcResult |
unpeerVpc(UnpeerVpcRequest unpeerVpcRequest)
Attempts to unpeer the Lightsail VPC from the user's default VPC.
|
UpdateDomainEntryResult |
updateDomainEntry(UpdateDomainEntryRequest updateDomainEntryRequest)
Updates a domain recordset after it is created.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
Callers can pass in just the endpoint (ex: "lightsail.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "lightsail.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol
from this client's ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint - The endpoint (ex: "lightsail.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"lightsail.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
with.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)setEndpoint(String), sets the regional endpoint for this client's
service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region - The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions) for accessing a given
region. Must not be null and must be a region where the service is available.Region#getRegion(com.amazonaws.regions.Regions),
Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)AllocateStaticIpResult allocateStaticIp(AllocateStaticIpRequest allocateStaticIpRequest)
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.AttachStaticIpResult attachStaticIp(AttachStaticIpRequest attachStaticIpRequest)
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.CloseInstancePublicPortsResult closeInstancePublicPorts(CloseInstancePublicPortsRequest closeInstancePublicPortsRequest)
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.CreateDomainResult createDomain(CreateDomainRequest createDomainRequest)
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.CreateDomainEntryResult createDomainEntry(CreateDomainEntryRequest createDomainEntryRequest)
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.CreateInstanceSnapshotResult createInstanceSnapshot(CreateInstanceSnapshotRequest createInstanceSnapshotRequest)
Creates a snapshot of a specific virtual private server, or instance. You can use a snapshot to create a new instance that is based on that snapshot.
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.CreateInstancesResult createInstances(CreateInstancesRequest createInstancesRequest)
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.CreateInstancesFromSnapshotResult createInstancesFromSnapshot(CreateInstancesFromSnapshotRequest createInstancesFromSnapshotRequest)
Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical configuration.
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.CreateKeyPairResult createKeyPair(CreateKeyPairRequest createKeyPairRequest)
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.DeleteDomainResult deleteDomain(DeleteDomainRequest deleteDomainRequest)
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.DeleteDomainEntryResult deleteDomainEntry(DeleteDomainEntryRequest deleteDomainEntryRequest)
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.DeleteInstanceResult deleteInstance(DeleteInstanceRequest deleteInstanceRequest)
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.DeleteInstanceSnapshotResult deleteInstanceSnapshot(DeleteInstanceSnapshotRequest deleteInstanceSnapshotRequest)
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.DeleteKeyPairResult deleteKeyPair(DeleteKeyPairRequest deleteKeyPairRequest)
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.DetachStaticIpResult detachStaticIp(DetachStaticIpRequest detachStaticIpRequest)
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.DownloadDefaultKeyPairResult downloadDefaultKeyPair(DownloadDefaultKeyPairRequest downloadDefaultKeyPairRequest)
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.GetActiveNamesResult getActiveNames(GetActiveNamesRequest getActiveNamesRequest)
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.GetBlueprintsResult getBlueprints(GetBlueprintsRequest getBlueprintsRequest)
Returns the list of available instance images, or blueprints. You can use a blueprint to create a new virtual private server already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.
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.GetBundlesResult getBundles(GetBundlesRequest getBundlesRequest)
Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance).
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.GetDomainResult getDomain(GetDomainRequest getDomainRequest)
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.GetDomainsResult getDomains(GetDomainsRequest getDomainsRequest)
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.GetInstanceResult getInstance(GetInstanceRequest getInstanceRequest)
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.GetInstanceAccessDetailsResult getInstanceAccessDetails(GetInstanceAccessDetailsRequest getInstanceAccessDetailsRequest)
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.GetInstanceMetricDataResult getInstanceMetricData(GetInstanceMetricDataRequest getInstanceMetricDataRequest)
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.GetInstancePortStatesResult getInstancePortStates(GetInstancePortStatesRequest getInstancePortStatesRequest)
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.GetInstanceSnapshotResult getInstanceSnapshot(GetInstanceSnapshotRequest getInstanceSnapshotRequest)
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.GetInstanceSnapshotsResult getInstanceSnapshots(GetInstanceSnapshotsRequest getInstanceSnapshotsRequest)
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.GetInstanceStateResult getInstanceState(GetInstanceStateRequest getInstanceStateRequest)
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.GetInstancesResult getInstances(GetInstancesRequest getInstancesRequest)
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.GetKeyPairResult getKeyPair(GetKeyPairRequest getKeyPairRequest)
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.GetKeyPairsResult getKeyPairs(GetKeyPairsRequest getKeyPairsRequest)
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.GetOperationResult getOperation(GetOperationRequest getOperationRequest)
Returns information about a specific operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on.
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.GetOperationsResult getOperations(GetOperationsRequest getOperationsRequest)
Returns information about all operations.
Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each
subsequent call to GetOperations use the maximum (last) statusChangedAt value from the
previous request.
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.GetOperationsForResourceResult getOperationsForResource(GetOperationsForResourceRequest getOperationsForResourceRequest)
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.GetRegionsResult getRegions(GetRegionsRequest getRegionsRequest)
Returns a list of all valid regions for Amazon Lightsail. Use the include availability zones
parameter to also return the availability zones in a region.
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.GetStaticIpResult getStaticIp(GetStaticIpRequest getStaticIpRequest)
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.GetStaticIpsResult getStaticIps(GetStaticIpsRequest getStaticIpsRequest)
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.ImportKeyPairResult importKeyPair(ImportKeyPairRequest importKeyPairRequest)
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.IsVpcPeeredResult isVpcPeered(IsVpcPeeredRequest isVpcPeeredRequest)
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.OpenInstancePublicPortsResult openInstancePublicPorts(OpenInstancePublicPortsRequest openInstancePublicPortsRequest)
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.PeerVpcResult peerVpc(PeerVpcRequest peerVpcRequest)
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.PutInstancePublicPortsResult putInstancePublicPorts(PutInstancePublicPortsRequest putInstancePublicPortsRequest)
Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not included in the current request.
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.RebootInstanceResult rebootInstance(RebootInstanceRequest rebootInstanceRequest)
Restarts a specific instance. When your Amazon Lightsail instance is finished rebooting, Lightsail assigns a new public IP address. To use the same IP address after restarting, create a static IP address and attach it to the instance.
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.ReleaseStaticIpResult releaseStaticIp(ReleaseStaticIpRequest releaseStaticIpRequest)
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.StartInstanceResult startInstance(StartInstanceRequest startInstanceRequest)
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.StopInstanceResult stopInstance(StopInstanceRequest stopInstanceRequest)
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.UnpeerVpcResult unpeerVpc(UnpeerVpcRequest unpeerVpcRequest)
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.UpdateDomainEntryResult updateDomainEntry(UpdateDomainEntryRequest updateDomainEntryRequest)
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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.