@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonLightsailClient extends AmazonWebServiceClient implements AmazonLightsail
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Constructor and Description |
---|
AmazonLightsailClient()
Deprecated.
|
AmazonLightsailClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonLightsailClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AmazonLightsailClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AmazonLightsailClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonLightsailClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonLightsailClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AmazonLightsailClient(ClientConfiguration clientConfiguration)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
AllocateStaticIpResult |
allocateStaticIp(AllocateStaticIpRequest request)
Allocates a static IP address.
|
AttachDiskResult |
attachDisk(AttachDiskRequest request)
Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the
specified disk name.
|
AttachInstancesToLoadBalancerResult |
attachInstancesToLoadBalancer(AttachInstancesToLoadBalancerRequest request)
Attaches one or more Lightsail instances to a load balancer.
|
AttachLoadBalancerTlsCertificateResult |
attachLoadBalancerTlsCertificate(AttachLoadBalancerTlsCertificateRequest request)
Attaches a Transport Layer Security (TLS) certificate to your load balancer.
|
AttachStaticIpResult |
attachStaticIp(AttachStaticIpRequest request)
Attaches a static IP address to a specific Amazon Lightsail instance.
|
static AmazonLightsailClientBuilder |
builder() |
CloseInstancePublicPortsResult |
closeInstancePublicPorts(CloseInstancePublicPortsRequest request)
Closes the public ports on a specific Amazon Lightsail instance.
|
CreateDiskResult |
createDisk(CreateDiskRequest request)
Creates a block storage disk that can be attached to a Lightsail instance in the same Availability Zone (e.g.,
us-east-2a ). |
CreateDiskFromSnapshotResult |
createDiskFromSnapshot(CreateDiskFromSnapshotRequest request)
Creates a block storage disk from a disk snapshot that can be attached to a Lightsail instance in the same
Availability Zone (e.g.,
us-east-2a ). |
CreateDiskSnapshotResult |
createDiskSnapshot(CreateDiskSnapshotRequest request)
Creates a snapshot of a block storage disk.
|
CreateDomainResult |
createDomain(CreateDomainRequest request)
Creates a domain resource for the specified domain (e.g., example.com).
|
CreateDomainEntryResult |
createDomainEntry(CreateDomainEntryRequest request)
Creates one of the following entry records associated with the domain: A record, CNAME record, TXT record, or MX
record.
|
CreateInstancesResult |
createInstances(CreateInstancesRequest request)
Creates one or more Amazon Lightsail virtual private servers, or instances.
|
CreateInstancesFromSnapshotResult |
createInstancesFromSnapshot(CreateInstancesFromSnapshotRequest request)
Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical
configuration.
|
CreateInstanceSnapshotResult |
createInstanceSnapshot(CreateInstanceSnapshotRequest request)
Creates a snapshot of a specific virtual private server, or instance.
|
CreateKeyPairResult |
createKeyPair(CreateKeyPairRequest request)
Creates sn SSH key pair.
|
CreateLoadBalancerResult |
createLoadBalancer(CreateLoadBalancerRequest request)
Creates a Lightsail load balancer.
|
CreateLoadBalancerTlsCertificateResult |
createLoadBalancerTlsCertificate(CreateLoadBalancerTlsCertificateRequest request)
Creates a Lightsail load balancer TLS certificate.
|
DeleteDiskResult |
deleteDisk(DeleteDiskRequest request)
Deletes the specified block storage disk.
|
DeleteDiskSnapshotResult |
deleteDiskSnapshot(DeleteDiskSnapshotRequest request)
Deletes the specified disk snapshot.
|
DeleteDomainResult |
deleteDomain(DeleteDomainRequest request)
Deletes the specified domain recordset and all of its domain records.
|
DeleteDomainEntryResult |
deleteDomainEntry(DeleteDomainEntryRequest request)
Deletes a specific domain entry.
|
DeleteInstanceResult |
deleteInstance(DeleteInstanceRequest request)
Deletes a specific Amazon Lightsail virtual private server, or instance.
|
DeleteInstanceSnapshotResult |
deleteInstanceSnapshot(DeleteInstanceSnapshotRequest request)
Deletes a specific snapshot of a virtual private server (or instance).
|
DeleteKeyPairResult |
deleteKeyPair(DeleteKeyPairRequest request)
Deletes a specific SSH key pair.
|
DeleteLoadBalancerResult |
deleteLoadBalancer(DeleteLoadBalancerRequest request)
Deletes a Lightsail load balancer.
|
DeleteLoadBalancerTlsCertificateResult |
deleteLoadBalancerTlsCertificate(DeleteLoadBalancerTlsCertificateRequest request)
Deletes a TLS/SSL certificate associated with a Lightsail load balancer.
|
DetachDiskResult |
detachDisk(DetachDiskRequest request)
Detaches a stopped block storage disk from a Lightsail instance.
|
DetachInstancesFromLoadBalancerResult |
detachInstancesFromLoadBalancer(DetachInstancesFromLoadBalancerRequest request)
Detaches the specified instances from a Lightsail load balancer.
|
DetachStaticIpResult |
detachStaticIp(DetachStaticIpRequest request)
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
|
DownloadDefaultKeyPairResult |
downloadDefaultKeyPair(DownloadDefaultKeyPairRequest request)
Downloads the default SSH key pair from the user's account.
|
GetActiveNamesResult |
getActiveNames(GetActiveNamesRequest request)
Returns the names of all active (not deleted) resources.
|
GetBlueprintsResult |
getBlueprints(GetBlueprintsRequest request)
Returns the list of available instance images, or blueprints.
|
GetBundlesResult |
getBundles(GetBundlesRequest request)
Returns the list of bundles that are available for purchase.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetDiskResult |
getDisk(GetDiskRequest request)
Returns information about a specific block storage disk.
|
GetDisksResult |
getDisks(GetDisksRequest request)
Returns information about all block storage disks in your AWS account and region.
|
GetDiskSnapshotResult |
getDiskSnapshot(GetDiskSnapshotRequest request)
Returns information about a specific block storage disk snapshot.
|
GetDiskSnapshotsResult |
getDiskSnapshots(GetDiskSnapshotsRequest request)
Returns information about all block storage disk snapshots in your AWS account and region.
|
GetDomainResult |
getDomain(GetDomainRequest request)
Returns information about a specific domain recordset.
|
GetDomainsResult |
getDomains(GetDomainsRequest request)
Returns a list of all domains in the user's account.
|
GetInstanceResult |
getInstance(GetInstanceRequest request)
Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
|
GetInstanceAccessDetailsResult |
getInstanceAccessDetails(GetInstanceAccessDetailsRequest request)
Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
|
GetInstanceMetricDataResult |
getInstanceMetricData(GetInstanceMetricDataRequest request)
Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
|
GetInstancePortStatesResult |
getInstancePortStates(GetInstancePortStatesRequest request)
Returns the port states for a specific virtual private server, or instance.
|
GetInstancesResult |
getInstances(GetInstancesRequest request)
Returns information about all Amazon Lightsail virtual private servers, or instances.
|
GetInstanceSnapshotResult |
getInstanceSnapshot(GetInstanceSnapshotRequest request)
Returns information about a specific instance snapshot.
|
GetInstanceSnapshotsResult |
getInstanceSnapshots(GetInstanceSnapshotsRequest request)
Returns all instance snapshots for the user's account.
|
GetInstanceStateResult |
getInstanceState(GetInstanceStateRequest request)
Returns the state of a specific instance.
|
GetKeyPairResult |
getKeyPair(GetKeyPairRequest request)
Returns information about a specific key pair.
|
GetKeyPairsResult |
getKeyPairs(GetKeyPairsRequest request)
Returns information about all key pairs in the user's account.
|
GetLoadBalancerResult |
getLoadBalancer(GetLoadBalancerRequest request)
Returns information about the specified Lightsail load balancer.
|
GetLoadBalancerMetricDataResult |
getLoadBalancerMetricData(GetLoadBalancerMetricDataRequest request)
Returns information about health metrics for your Lightsail load balancer.
|
GetLoadBalancersResult |
getLoadBalancers(GetLoadBalancersRequest request)
Returns information about all load balancers in an account.
|
GetLoadBalancerTlsCertificatesResult |
getLoadBalancerTlsCertificates(GetLoadBalancerTlsCertificatesRequest request)
Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.
|
GetOperationResult |
getOperation(GetOperationRequest request)
Returns information about a specific operation.
|
GetOperationsResult |
getOperations(GetOperationsRequest request)
Returns information about all operations.
|
GetOperationsForResourceResult |
getOperationsForResource(GetOperationsForResourceRequest request)
Gets operations for a specific resource (e.g., an instance or a static IP).
|
GetRegionsResult |
getRegions(GetRegionsRequest request)
Returns a list of all valid regions for Amazon Lightsail.
|
GetStaticIpResult |
getStaticIp(GetStaticIpRequest request)
Returns information about a specific static IP.
|
GetStaticIpsResult |
getStaticIps(GetStaticIpsRequest request)
Returns information about all static IPs in the user's account.
|
ImportKeyPairResult |
importKeyPair(ImportKeyPairRequest request)
Imports a public SSH key from a specific key pair.
|
IsVpcPeeredResult |
isVpcPeered(IsVpcPeeredRequest request)
Returns a Boolean value indicating whether your Lightsail VPC is peered.
|
OpenInstancePublicPortsResult |
openInstancePublicPorts(OpenInstancePublicPortsRequest request)
Adds public ports to an Amazon Lightsail instance.
|
PeerVpcResult |
peerVpc(PeerVpcRequest request)
Tries to peer the Lightsail VPC with the user's default VPC.
|
PutInstancePublicPortsResult |
putInstancePublicPorts(PutInstancePublicPortsRequest request)
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 request)
Restarts a specific instance.
|
ReleaseStaticIpResult |
releaseStaticIp(ReleaseStaticIpRequest request)
Deletes a specific static IP from your account.
|
StartInstanceResult |
startInstance(StartInstanceRequest request)
Starts a specific Amazon Lightsail instance from a stopped state.
|
StopInstanceResult |
stopInstance(StopInstanceRequest request)
Stops a specific Amazon Lightsail instance that is currently running.
|
UnpeerVpcResult |
unpeerVpc(UnpeerVpcRequest request)
Attempts to unpeer the Lightsail VPC from the user's default VPC.
|
UpdateDomainEntryResult |
updateDomainEntry(UpdateDomainEntryRequest request)
Updates a domain recordset after it is created.
|
UpdateLoadBalancerAttributeResult |
updateLoadBalancerAttribute(UpdateLoadBalancerAttributeRequest request)
Updates the specified attribute for a load balancer.
|
addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
@Deprecated public AmazonLightsailClient()
AmazonLightsailClientBuilder.defaultClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
@Deprecated public AmazonLightsailClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client connects to Amazon Lightsail (ex: proxy
settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
@Deprecated public AmazonLightsailClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
for example:
AmazonLightsailClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AmazonLightsailClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon Lightsail (ex: proxy
settings, retry counts, etc.).@Deprecated public AmazonLightsailClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AmazonLightsailClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon Lightsail (ex: proxy
settings, retry counts, etc.).@Deprecated public AmazonLightsailClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon Lightsail (ex: proxy
settings, retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic static AmazonLightsailClientBuilder builder()
public AllocateStaticIpResult allocateStaticIp(AllocateStaticIpRequest request)
Allocates a static IP address.
allocateStaticIp
in interface AmazonLightsail
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.public AttachDiskResult attachDisk(AttachDiskRequest request)
Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.
attachDisk
in interface AmazonLightsail
attachDiskRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public AttachInstancesToLoadBalancerResult attachInstancesToLoadBalancer(AttachInstancesToLoadBalancerRequest request)
Attaches one or more Lightsail instances to a load balancer.
attachInstancesToLoadBalancer
in interface AmazonLightsail
attachInstancesToLoadBalancerRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to 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.public AttachLoadBalancerTlsCertificateResult attachLoadBalancerTlsCertificate(AttachLoadBalancerTlsCertificateRequest request)
Attaches a Transport Layer Security (TLS) certificate to your load balancer.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
attachLoadBalancerTlsCertificate
in interface AmazonLightsail
attachLoadBalancerTlsCertificateRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to 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.public AttachStaticIpResult attachStaticIp(AttachStaticIpRequest request)
Attaches a static IP address to a specific Amazon Lightsail instance.
attachStaticIp
in interface AmazonLightsail
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.public CloseInstancePublicPortsResult closeInstancePublicPorts(CloseInstancePublicPortsRequest request)
Closes the public ports on a specific Amazon Lightsail instance.
closeInstancePublicPorts
in interface AmazonLightsail
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.public CreateDiskResult createDisk(CreateDiskRequest request)
Creates a block storage disk that can be attached to a Lightsail instance in the same Availability Zone (e.g.,
us-east-2a
). The disk is created in the regional endpoint that you send the HTTP request to. For
more information, see Regions and Availability Zones in Lightsail.
createDisk
in interface AmazonLightsail
createDiskRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public CreateDiskFromSnapshotResult createDiskFromSnapshot(CreateDiskFromSnapshotRequest request)
Creates a block storage disk from a disk snapshot that can be attached to a Lightsail instance in the same
Availability Zone (e.g., us-east-2a
). The disk is created in the regional endpoint that you send the
HTTP request to. For more information, see Regions and Availability Zones in Lightsail.
createDiskFromSnapshot
in interface AmazonLightsail
createDiskFromSnapshotRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public CreateDiskSnapshotResult createDiskSnapshot(CreateDiskSnapshotRequest request)
Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.
You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending.
createDiskSnapshot
in interface AmazonLightsail
createDiskSnapshotRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public CreateDomainResult createDomain(CreateDomainRequest request)
Creates a domain resource for the specified domain (e.g., example.com).
createDomain
in interface AmazonLightsail
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.public CreateDomainEntryResult createDomainEntry(CreateDomainEntryRequest request)
Creates one of the following entry records associated with the domain: A record, CNAME record, TXT record, or MX record.
createDomainEntry
in interface AmazonLightsail
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.public CreateInstanceSnapshotResult createInstanceSnapshot(CreateInstanceSnapshotRequest request)
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.
createInstanceSnapshot
in interface AmazonLightsail
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.public CreateInstancesResult createInstances(CreateInstancesRequest request)
Creates one or more Amazon Lightsail virtual private servers, or instances.
createInstances
in interface AmazonLightsail
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.public CreateInstancesFromSnapshotResult createInstancesFromSnapshot(CreateInstancesFromSnapshotRequest request)
Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical configuration.
createInstancesFromSnapshot
in interface AmazonLightsail
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.public CreateKeyPairResult createKeyPair(CreateKeyPairRequest request)
Creates sn SSH key pair.
createKeyPair
in interface AmazonLightsail
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.public CreateLoadBalancerResult createLoadBalancer(CreateLoadBalancerRequest request)
Creates a Lightsail load balancer.
When you create a load balancer, you can specify certificates and port settings. You can create up to 5 load balancers per AWS Region in your account.
createLoadBalancer
in interface AmazonLightsail
createLoadBalancerRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to 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.public CreateLoadBalancerTlsCertificateResult createLoadBalancerTlsCertificate(CreateLoadBalancerTlsCertificateRequest request)
Creates a Lightsail load balancer TLS certificate.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
createLoadBalancerTlsCertificate
in interface AmazonLightsail
createLoadBalancerTlsCertificateRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to 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.public DeleteDiskResult deleteDisk(DeleteDiskRequest request)
Deletes the specified block storage disk. The disk must be in the available
state (not attached to a
Lightsail instance).
The disk may remain in the deleting
state for several minutes.
deleteDisk
in interface AmazonLightsail
deleteDiskRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public DeleteDiskSnapshotResult deleteDiskSnapshot(DeleteDiskSnapshotRequest request)
Deletes the specified disk snapshot.
When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk.
deleteDiskSnapshot
in interface AmazonLightsail
deleteDiskSnapshotRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public DeleteDomainResult deleteDomain(DeleteDomainRequest request)
Deletes the specified domain recordset and all of its domain records.
deleteDomain
in interface AmazonLightsail
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.public DeleteDomainEntryResult deleteDomainEntry(DeleteDomainEntryRequest request)
Deletes a specific domain entry.
deleteDomainEntry
in interface AmazonLightsail
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.public DeleteInstanceResult deleteInstance(DeleteInstanceRequest request)
Deletes a specific Amazon Lightsail virtual private server, or instance.
deleteInstance
in interface AmazonLightsail
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.public DeleteInstanceSnapshotResult deleteInstanceSnapshot(DeleteInstanceSnapshotRequest request)
Deletes a specific snapshot of a virtual private server (or instance).
deleteInstanceSnapshot
in interface AmazonLightsail
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.public DeleteKeyPairResult deleteKeyPair(DeleteKeyPairRequest request)
Deletes a specific SSH key pair.
deleteKeyPair
in interface AmazonLightsail
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.public DeleteLoadBalancerResult deleteLoadBalancer(DeleteLoadBalancerRequest request)
Deletes a Lightsail load balancer.
deleteLoadBalancer
in interface AmazonLightsail
deleteLoadBalancerRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to 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.public DeleteLoadBalancerTlsCertificateResult deleteLoadBalancerTlsCertificate(DeleteLoadBalancerTlsCertificateRequest request)
Deletes a TLS/SSL certificate associated with a Lightsail load balancer.
deleteLoadBalancerTlsCertificate
in interface AmazonLightsail
deleteLoadBalancerTlsCertificateRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to 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.public DetachDiskResult detachDisk(DetachDiskRequest request)
Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk.
detachDisk
in interface AmazonLightsail
detachDiskRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public DetachInstancesFromLoadBalancerResult detachInstancesFromLoadBalancer(DetachInstancesFromLoadBalancerRequest request)
Detaches the specified instances from a Lightsail load balancer.
detachInstancesFromLoadBalancer
in interface AmazonLightsail
detachInstancesFromLoadBalancerRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to 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.public DetachStaticIpResult detachStaticIp(DetachStaticIpRequest request)
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
detachStaticIp
in interface AmazonLightsail
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.public DownloadDefaultKeyPairResult downloadDefaultKeyPair(DownloadDefaultKeyPairRequest request)
Downloads the default SSH key pair from the user's account.
downloadDefaultKeyPair
in interface AmazonLightsail
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.public GetActiveNamesResult getActiveNames(GetActiveNamesRequest request)
Returns the names of all active (not deleted) resources.
getActiveNames
in interface AmazonLightsail
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.public GetBlueprintsResult getBlueprints(GetBlueprintsRequest request)
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.
getBlueprints
in interface AmazonLightsail
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.public GetBundlesResult getBundles(GetBundlesRequest request)
Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance).
getBundles
in interface AmazonLightsail
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.public GetDiskResult getDisk(GetDiskRequest request)
Returns information about a specific block storage disk.
getDisk
in interface AmazonLightsail
getDiskRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetDiskSnapshotResult getDiskSnapshot(GetDiskSnapshotRequest request)
Returns information about a specific block storage disk snapshot.
getDiskSnapshot
in interface AmazonLightsail
getDiskSnapshotRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetDiskSnapshotsResult getDiskSnapshots(GetDiskSnapshotsRequest request)
Returns information about all block storage disk snapshots in your AWS account and region.
If you are describing a long list of disk snapshots, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
getDiskSnapshots
in interface AmazonLightsail
getDiskSnapshotsRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetDisksResult getDisks(GetDisksRequest request)
Returns information about all block storage disks in your AWS account and region.
If you are describing a long list of disks, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
getDisks
in interface AmazonLightsail
getDisksRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetDomainResult getDomain(GetDomainRequest request)
Returns information about a specific domain recordset.
getDomain
in interface AmazonLightsail
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.public GetDomainsResult getDomains(GetDomainsRequest request)
Returns a list of all domains in the user's account.
getDomains
in interface AmazonLightsail
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.public GetInstanceResult getInstance(GetInstanceRequest request)
Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
getInstance
in interface AmazonLightsail
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.public GetInstanceAccessDetailsResult getInstanceAccessDetails(GetInstanceAccessDetailsRequest request)
Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
getInstanceAccessDetails
in interface AmazonLightsail
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.public GetInstanceMetricDataResult getInstanceMetricData(GetInstanceMetricDataRequest request)
Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
getInstanceMetricData
in interface AmazonLightsail
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.public GetInstancePortStatesResult getInstancePortStates(GetInstancePortStatesRequest request)
Returns the port states for a specific virtual private server, or instance.
getInstancePortStates
in interface AmazonLightsail
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.public GetInstanceSnapshotResult getInstanceSnapshot(GetInstanceSnapshotRequest request)
Returns information about a specific instance snapshot.
getInstanceSnapshot
in interface AmazonLightsail
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.public GetInstanceSnapshotsResult getInstanceSnapshots(GetInstanceSnapshotsRequest request)
Returns all instance snapshots for the user's account.
getInstanceSnapshots
in interface AmazonLightsail
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.public GetInstanceStateResult getInstanceState(GetInstanceStateRequest request)
Returns the state of a specific instance. Works on one instance at a time.
getInstanceState
in interface AmazonLightsail
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.public GetInstancesResult getInstances(GetInstancesRequest request)
Returns information about all Amazon Lightsail virtual private servers, or instances.
getInstances
in interface AmazonLightsail
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.public GetKeyPairResult getKeyPair(GetKeyPairRequest request)
Returns information about a specific key pair.
getKeyPair
in interface AmazonLightsail
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.public GetKeyPairsResult getKeyPairs(GetKeyPairsRequest request)
Returns information about all key pairs in the user's account.
getKeyPairs
in interface AmazonLightsail
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.public GetLoadBalancerResult getLoadBalancer(GetLoadBalancerRequest request)
Returns information about the specified Lightsail load balancer.
getLoadBalancer
in interface AmazonLightsail
getLoadBalancerRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to 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.public GetLoadBalancerMetricDataResult getLoadBalancerMetricData(GetLoadBalancerMetricDataRequest request)
Returns information about health metrics for your Lightsail load balancer.
getLoadBalancerMetricData
in interface AmazonLightsail
getLoadBalancerMetricDataRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to 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.public GetLoadBalancerTlsCertificatesResult getLoadBalancerTlsCertificates(GetLoadBalancerTlsCertificatesRequest request)
Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
getLoadBalancerTlsCertificates
in interface AmazonLightsail
getLoadBalancerTlsCertificatesRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to 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.public GetLoadBalancersResult getLoadBalancers(GetLoadBalancersRequest request)
Returns information about all load balancers in an account.
If you are describing a long list of load balancers, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
getLoadBalancers
in interface AmazonLightsail
getLoadBalancersRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to 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.public GetOperationResult getOperation(GetOperationRequest request)
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.
getOperation
in interface AmazonLightsail
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.public GetOperationsResult getOperations(GetOperationsRequest request)
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.
getOperations
in interface AmazonLightsail
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.public GetOperationsForResourceResult getOperationsForResource(GetOperationsForResourceRequest request)
Gets operations for a specific resource (e.g., an instance or a static IP).
getOperationsForResource
in interface AmazonLightsail
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.public GetRegionsResult getRegions(GetRegionsRequest request)
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.
getRegions
in interface AmazonLightsail
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.public GetStaticIpResult getStaticIp(GetStaticIpRequest request)
Returns information about a specific static IP.
getStaticIp
in interface AmazonLightsail
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.public GetStaticIpsResult getStaticIps(GetStaticIpsRequest request)
Returns information about all static IPs in the user's account.
getStaticIps
in interface AmazonLightsail
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.public ImportKeyPairResult importKeyPair(ImportKeyPairRequest request)
Imports a public SSH key from a specific key pair.
importKeyPair
in interface AmazonLightsail
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.public IsVpcPeeredResult isVpcPeered(IsVpcPeeredRequest request)
Returns a Boolean value indicating whether your Lightsail VPC is peered.
isVpcPeered
in interface AmazonLightsail
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.public OpenInstancePublicPortsResult openInstancePublicPorts(OpenInstancePublicPortsRequest request)
Adds public ports to an Amazon Lightsail instance.
openInstancePublicPorts
in interface AmazonLightsail
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.public PeerVpcResult peerVpc(PeerVpcRequest request)
Tries to peer the Lightsail VPC with the user's default VPC.
peerVpc
in interface AmazonLightsail
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.public PutInstancePublicPortsResult putInstancePublicPorts(PutInstancePublicPortsRequest request)
Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not included in the current request.
putInstancePublicPorts
in interface AmazonLightsail
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.public RebootInstanceResult rebootInstance(RebootInstanceRequest request)
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.
rebootInstance
in interface AmazonLightsail
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.public ReleaseStaticIpResult releaseStaticIp(ReleaseStaticIpRequest request)
Deletes a specific static IP from your account.
releaseStaticIp
in interface AmazonLightsail
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.public StartInstanceResult startInstance(StartInstanceRequest request)
Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation.
startInstance
in interface AmazonLightsail
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.public StopInstanceResult stopInstance(StopInstanceRequest request)
Stops a specific Amazon Lightsail instance that is currently running.
stopInstance
in interface AmazonLightsail
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.public UnpeerVpcResult unpeerVpc(UnpeerVpcRequest request)
Attempts to unpeer the Lightsail VPC from the user's default VPC.
unpeerVpc
in interface AmazonLightsail
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.public UpdateDomainEntryResult updateDomainEntry(UpdateDomainEntryRequest request)
Updates a domain recordset after it is created.
updateDomainEntry
in interface AmazonLightsail
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.public UpdateLoadBalancerAttributeResult updateLoadBalancerAttribute(UpdateLoadBalancerAttributeRequest request)
Updates the specified attribute for a load balancer.
updateLoadBalancerAttribute
in interface AmazonLightsail
updateLoadBalancerAttributeRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to 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.public 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 the request.
getCachedResponseMetadata
in interface AmazonLightsail
request
- The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.