@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, a managed database, SSD-based storage, data transfer, DNS management, and a static IP - for a low, predictable price. You manage those Lightsail servers through the Lightsail console or by using the API or command-line interface (CLI).
For more information about Lightsail concepts and tasks, see the Lightsail Dev Guide.
To use the Lightsail API or the CLI, you will need to use AWS Identity and Access Management (IAM) to generate access keys. For details about how to set this up, see the Lightsail Dev Guide.
| Modifier and Type | Field and Description |
|---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to this client
|
client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffsetENDPOINT_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 ports for a specific Amazon Lightsail instance.
|
CopySnapshotResult |
copySnapshot(CopySnapshotRequest request)
Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an
instance or disk as a manual snapshot.
|
CreateCloudFormationStackResult |
createCloudFormationStack(CreateCloudFormationStackRequest request)
Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail
snapshot.
|
CreateContactMethodResult |
createContactMethod(CreateContactMethodRequest request)
Creates an email or SMS text message contact method.
|
CreateDiskResult |
createDisk(CreateDiskRequest request)
Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone
(e.g.,
us-east-2a). |
CreateDiskFromSnapshotResult |
createDiskFromSnapshot(CreateDiskFromSnapshotRequest request)
Creates a block storage disk from a manual or automatic snapshot of a disk.
|
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: Address (A), canonical name (CNAME), mail
exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).
|
CreateInstancesResult |
createInstances(CreateInstancesRequest request)
Creates one or more Amazon Lightsail instances.
|
CreateInstancesFromSnapshotResult |
createInstancesFromSnapshot(CreateInstancesFromSnapshotRequest request)
Creates one or more new instances from a manual or automatic snapshot of an instance.
|
CreateInstanceSnapshotResult |
createInstanceSnapshot(CreateInstanceSnapshotRequest request)
Creates a snapshot of a specific virtual private server, or instance.
|
CreateKeyPairResult |
createKeyPair(CreateKeyPairRequest request)
Creates an SSH key pair.
|
CreateLoadBalancerResult |
createLoadBalancer(CreateLoadBalancerRequest request)
Creates a Lightsail load balancer.
|
CreateLoadBalancerTlsCertificateResult |
createLoadBalancerTlsCertificate(CreateLoadBalancerTlsCertificateRequest request)
Creates a Lightsail load balancer TLS certificate.
|
CreateRelationalDatabaseResult |
createRelationalDatabase(CreateRelationalDatabaseRequest request)
Creates a new database in Amazon Lightsail.
|
CreateRelationalDatabaseFromSnapshotResult |
createRelationalDatabaseFromSnapshot(CreateRelationalDatabaseFromSnapshotRequest request)
Creates a new database from an existing database snapshot in Amazon Lightsail.
|
CreateRelationalDatabaseSnapshotResult |
createRelationalDatabaseSnapshot(CreateRelationalDatabaseSnapshotRequest request)
Creates a snapshot of your database in Amazon Lightsail.
|
DeleteAlarmResult |
deleteAlarm(DeleteAlarmRequest request)
Deletes an alarm.
|
DeleteAutoSnapshotResult |
deleteAutoSnapshot(DeleteAutoSnapshotRequest request)
Deletes an automatic snapshot of an instance or disk.
|
DeleteContactMethodResult |
deleteContactMethod(DeleteContactMethodRequest request)
Deletes a contact method.
|
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 an Amazon Lightsail 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.
|
DeleteKnownHostKeysResult |
deleteKnownHostKeys(DeleteKnownHostKeysRequest request)
Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to
authenticate an instance.
|
DeleteLoadBalancerResult |
deleteLoadBalancer(DeleteLoadBalancerRequest request)
Deletes a Lightsail load balancer and all its associated SSL/TLS certificates.
|
DeleteLoadBalancerTlsCertificateResult |
deleteLoadBalancerTlsCertificate(DeleteLoadBalancerTlsCertificateRequest request)
Deletes an SSL/TLS certificate associated with a Lightsail load balancer.
|
DeleteRelationalDatabaseResult |
deleteRelationalDatabase(DeleteRelationalDatabaseRequest request)
Deletes a database in Amazon Lightsail.
|
DeleteRelationalDatabaseSnapshotResult |
deleteRelationalDatabaseSnapshot(DeleteRelationalDatabaseSnapshotRequest request)
Deletes a database snapshot in Amazon Lightsail.
|
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.
|
DisableAddOnResult |
disableAddOn(DisableAddOnRequest request)
Disables an add-on for an Amazon Lightsail resource.
|
DownloadDefaultKeyPairResult |
downloadDefaultKeyPair(DownloadDefaultKeyPairRequest request)
Downloads the default SSH key pair from the user's account.
|
EnableAddOnResult |
enableAddOn(EnableAddOnRequest request)
Enables or modifies an add-on for an Amazon Lightsail resource.
|
ExportSnapshotResult |
exportSnapshot(ExportSnapshotRequest request)
Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2).
|
GetActiveNamesResult |
getActiveNames(GetActiveNamesRequest request)
Returns the names of all active (not deleted) resources.
|
GetAlarmsResult |
getAlarms(GetAlarmsRequest request)
Returns information about the configured alarms.
|
GetAutoSnapshotsResult |
getAutoSnapshots(GetAutoSnapshotsRequest request)
Returns the available automatic snapshots for an instance or disk.
|
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.
|
GetCloudFormationStackRecordsResult |
getCloudFormationStackRecords(GetCloudFormationStackRecordsRequest request)
Returns the CloudFormation stack record created as a result of the
create cloud formation stack
operation. |
GetContactMethodsResult |
getContactMethods(GetContactMethodsRequest request)
Returns information about the configured contact methods.
|
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.
|
GetExportSnapshotRecordsResult |
getExportSnapshotRecords(GetExportSnapshotRecordsRequest request)
Returns the export snapshot record created as a result of the
export snapshot operation. |
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 firewall port states for a specific Amazon Lightsail instance, the IP addresses allowed to connect to
the instance through the ports, and the protocol.
|
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.
|
GetRelationalDatabaseResult |
getRelationalDatabase(GetRelationalDatabaseRequest request)
Returns information about a specific database in Amazon Lightsail.
|
GetRelationalDatabaseBlueprintsResult |
getRelationalDatabaseBlueprints(GetRelationalDatabaseBlueprintsRequest request)
Returns a list of available database blueprints in Amazon Lightsail.
|
GetRelationalDatabaseBundlesResult |
getRelationalDatabaseBundles(GetRelationalDatabaseBundlesRequest request)
Returns the list of bundles that are available in Amazon Lightsail.
|
GetRelationalDatabaseEventsResult |
getRelationalDatabaseEvents(GetRelationalDatabaseEventsRequest request)
Returns a list of events for a specific database in Amazon Lightsail.
|
GetRelationalDatabaseLogEventsResult |
getRelationalDatabaseLogEvents(GetRelationalDatabaseLogEventsRequest request)
Returns a list of log events for a database in Amazon Lightsail.
|
GetRelationalDatabaseLogStreamsResult |
getRelationalDatabaseLogStreams(GetRelationalDatabaseLogStreamsRequest request)
Returns a list of available log streams for a specific database in Amazon Lightsail.
|
GetRelationalDatabaseMasterUserPasswordResult |
getRelationalDatabaseMasterUserPassword(GetRelationalDatabaseMasterUserPasswordRequest request)
Returns the current, previous, or pending versions of the master user password for a Lightsail database.
|
GetRelationalDatabaseMetricDataResult |
getRelationalDatabaseMetricData(GetRelationalDatabaseMetricDataRequest request)
Returns the data points of the specified metric for a database in Amazon Lightsail.
|
GetRelationalDatabaseParametersResult |
getRelationalDatabaseParameters(GetRelationalDatabaseParametersRequest request)
Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific
database in Amazon Lightsail.
|
GetRelationalDatabasesResult |
getRelationalDatabases(GetRelationalDatabasesRequest request)
Returns information about all of your databases in Amazon Lightsail.
|
GetRelationalDatabaseSnapshotResult |
getRelationalDatabaseSnapshot(GetRelationalDatabaseSnapshotRequest request)
Returns information about a specific database snapshot in Amazon Lightsail.
|
GetRelationalDatabaseSnapshotsResult |
getRelationalDatabaseSnapshots(GetRelationalDatabaseSnapshotsRequest request)
Returns information about all of your database snapshots in 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)
Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the
instance through the ports, and the protocol.
|
PeerVpcResult |
peerVpc(PeerVpcRequest request)
Tries to peer the Lightsail VPC with the user's default VPC.
|
PutAlarmResult |
putAlarm(PutAlarmRequest request)
Creates or updates an alarm, and associates it with the specified metric.
|
PutInstancePublicPortsResult |
putInstancePublicPorts(PutInstancePublicPortsRequest request)
Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the
instance through the ports, and the protocol.
|
RebootInstanceResult |
rebootInstance(RebootInstanceRequest request)
Restarts a specific instance.
|
RebootRelationalDatabaseResult |
rebootRelationalDatabase(RebootRelationalDatabaseRequest request)
Restarts a specific database in Amazon Lightsail.
|
ReleaseStaticIpResult |
releaseStaticIp(ReleaseStaticIpRequest request)
Deletes a specific static IP from your account.
|
SendContactMethodVerificationResult |
sendContactMethodVerification(SendContactMethodVerificationRequest request)
Sends a verification request to an email contact method to ensure it's owned by the requester.
|
StartInstanceResult |
startInstance(StartInstanceRequest request)
Starts a specific Amazon Lightsail instance from a stopped state.
|
StartRelationalDatabaseResult |
startRelationalDatabase(StartRelationalDatabaseRequest request)
Starts a specific database from a stopped state in Amazon Lightsail.
|
StopInstanceResult |
stopInstance(StopInstanceRequest request)
Stops a specific Amazon Lightsail instance that is currently running.
|
StopRelationalDatabaseResult |
stopRelationalDatabase(StopRelationalDatabaseRequest request)
Stops a specific database that is currently running in Amazon Lightsail.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds one or more tags to the specified Amazon Lightsail resource.
|
TestAlarmResult |
testAlarm(TestAlarmRequest request)
Tests an alarm by displaying a banner on the Amazon Lightsail console.
|
UnpeerVpcResult |
unpeerVpc(UnpeerVpcRequest request)
Attempts to unpeer the Lightsail VPC from the user's default VPC.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.
|
UpdateDomainEntryResult |
updateDomainEntry(UpdateDomainEntryRequest request)
Updates a domain recordset after it is created.
|
UpdateLoadBalancerAttributeResult |
updateLoadBalancerAttribute(UpdateLoadBalancerAttributeRequest request)
Updates the specified attribute for a load balancer.
|
UpdateRelationalDatabaseResult |
updateRelationalDatabase(UpdateRelationalDatabaseRequest request)
Allows the update of one or more attributes of a database in Amazon Lightsail.
|
UpdateRelationalDatabaseParametersResult |
updateRelationalDatabaseParameters(UpdateRelationalDatabaseParametersRequest request)
Allows the update of one or more parameters of a database in Amazon Lightsail.
|
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdownprotected static final ClientConfigurationFactory configFactory
@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 AmazonLightsailallocateStaticIpRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.
The attach disk operation supports tag-based access control via resource tags applied to the
resource identified by disk name. For more information, see the Lightsail Dev Guide.
attachDisk in interface AmazonLightsailattachDiskRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.
After some time, the instances are attached to the load balancer and the health check status is available.
The attach instances to load balancer operation supports tag-based access control via resource tags
applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
attachInstancesToLoadBalancer in interface AmazonLightsailattachInstancesToLoadBalancerRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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).
Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API
to rotate the certificates on your account. Use the AttachLoadBalancerTlsCertificate action with the
non-attached certificate, and it will replace the existing one and become the attached certificate.
The AttachLoadBalancerTlsCertificate operation supports tag-based access control via resource tags
applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
attachLoadBalancerTlsCertificate in interface AmazonLightsailattachLoadBalancerTlsCertificateRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 AmazonLightsailattachStaticIpRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 ports for a specific Amazon Lightsail instance.
The CloseInstancePublicPorts action supports tag-based access control via resource tags applied to
the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
closeInstancePublicPorts in interface AmazonLightsailcloseInstancePublicPortsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 CopySnapshotResult copySnapshot(CopySnapshotRequest request)
Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an instance or disk as a manual snapshot. This operation can also be used to copy a manual or automatic snapshot of an instance or a disk from one AWS Region to another in Amazon Lightsail.
When copying a manual snapshot, be sure to define the source region,
source snapshot name, and target snapshot name parameters.
When copying an automatic snapshot, be sure to define the source region,
source resource name, target snapshot name, and either the restore date or
the use latest restorable auto snapshot parameters.
copySnapshot in interface AmazonLightsailcopySnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 CreateCloudFormationStackResult createCloudFormationStack(CreateCloudFormationStackRequest request)
Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail
snapshot. This operation results in a CloudFormation stack record that can be used to track the AWS
CloudFormation stack created. Use the get cloud formation stack records operation to get a list of
the CloudFormation stacks created.
Wait until after your new Amazon EC2 instance is created before running the
create cloud formation stack operation again with the same export snapshot record.
createCloudFormationStack in interface AmazonLightsailcreateCloudFormationStackRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 CreateContactMethodResult createContactMethod(CreateContactMethodRequest request)
Creates an email or SMS text message contact method.
A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
createContactMethod in interface AmazonLightsailcreateContactMethodRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.public CreateDiskResult createDisk(CreateDiskRequest request)
Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone
(e.g., us-east-2a).
The create disk operation supports tag-based access control via request tags. For more information,
see the Lightsail Dev Guide.
createDisk in interface AmazonLightsailcreateDiskRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 manual or automatic snapshot of a disk. The resulting disk can be attached to
an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a).
The create disk from snapshot operation supports tag-based access control via request tags and
resource tags applied to the resource identified by disk snapshot name. For more information, see
the
Lightsail Dev Guide.
createDiskFromSnapshot in interface AmazonLightsailcreateDiskFromSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.
You can also use this operation to create a snapshot of an instance's system volume. You might want to do this,
for example, to recover data from the system volume of a botched instance or to create a backup of the system
volume like you would for a block storage disk. To create a snapshot of a system volume, just define the
instance name parameter when issuing the snapshot command, and a snapshot of the defined instance's
system volume will be created. After the snapshot is available, you can create a block storage disk from the
snapshot and attach it to a running instance to access the data on the disk.
The create disk snapshot operation supports tag-based access control via request tags. For more
information, see the Lightsail Dev Guide.
createDiskSnapshot in interface AmazonLightsailcreateDiskSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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).
The create domain operation supports tag-based access control via request tags. For more
information, see the Lightsail Dev Guide.
createDomain in interface AmazonLightsailcreateDomainRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).
The create domain entry operation supports tag-based access control via resource tags applied to the
resource identified by domain name. For more information, see the Lightsail Dev Guide.
createDomainEntry in interface AmazonLightsailcreateDomainEntryRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.
The create instance snapshot operation supports tag-based access control via request tags. For more
information, see the Lightsail Dev Guide.
createInstanceSnapshot in interface AmazonLightsailcreateInstanceSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 instances.
The create instances operation supports tag-based access control via request tags. For more
information, see the Lightsail Dev Guide.
createInstances in interface AmazonLightsailcreateInstancesRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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)
Creates one or more new instances from a manual or automatic snapshot of an instance.
The create instances from snapshot operation supports tag-based access control via request tags and
resource tags applied to the resource identified by instance snapshot name. For more information,
see the Lightsail Dev Guide.
createInstancesFromSnapshot in interface AmazonLightsailcreateInstancesFromSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 an SSH key pair.
The create key pair operation supports tag-based access control via request tags. For more
information, see the Lightsail Dev Guide.
createKeyPair in interface AmazonLightsailcreateKeyPairRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing. You can create up to 5 load balancers per AWS Region in your account.
When you create a load balancer, you can specify a unique name and port settings. To change additional load
balancer settings, use the UpdateLoadBalancerAttribute operation.
The create load balancer operation supports tag-based access control via request tags. For more
information, see the Lightsail Dev Guide.
createLoadBalancer in interface AmazonLightsailcreateLoadBalancerRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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).
The CreateLoadBalancerTlsCertificate operation supports tag-based access control via resource tags
applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
createLoadBalancerTlsCertificate in interface AmazonLightsailcreateLoadBalancerTlsCertificateRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 CreateRelationalDatabaseResult createRelationalDatabase(CreateRelationalDatabaseRequest request)
Creates a new database in Amazon Lightsail.
The create relational database operation supports tag-based access control via request tags. For
more information, see the Lightsail Dev Guide.
createRelationalDatabase in interface AmazonLightsailcreateRelationalDatabaseRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 CreateRelationalDatabaseFromSnapshotResult createRelationalDatabaseFromSnapshot(CreateRelationalDatabaseFromSnapshotRequest request)
Creates a new database from an existing database snapshot in Amazon Lightsail.
You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a different plan, such as a high availability or standard plan.
The create relational database from snapshot operation supports tag-based access control via request
tags and resource tags applied to the resource identified by relationalDatabaseSnapshotName. For more
information, see the Lightsail Dev Guide.
createRelationalDatabaseFromSnapshot in interface AmazonLightsailcreateRelationalDatabaseFromSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 CreateRelationalDatabaseSnapshotResult createRelationalDatabaseSnapshot(CreateRelationalDatabaseSnapshotRequest request)
Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database.
The create relational database snapshot operation supports tag-based access control via request
tags. For more information, see the Lightsail Dev Guide.
createRelationalDatabaseSnapshot in interface AmazonLightsailcreateRelationalDatabaseSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 DeleteAlarmResult deleteAlarm(DeleteAlarmRequest request)
Deletes an alarm.
An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
deleteAlarm in interface AmazonLightsaildeleteAlarmRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
OperationFailureException - Lightsail throws this exception when an operation fails to execute.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.NotFoundException - Lightsail throws this exception when it cannot find a resource.public DeleteAutoSnapshotResult deleteAutoSnapshot(DeleteAutoSnapshotRequest request)
Deletes an automatic snapshot of an instance or disk. For more information, see the Lightsail Dev Guide.
deleteAutoSnapshot in interface AmazonLightsaildeleteAutoSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.public DeleteContactMethodResult deleteContactMethod(DeleteContactMethodRequest request)
Deletes a contact method.
A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
deleteContactMethod in interface AmazonLightsaildeleteContactMethodRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
OperationFailureException - Lightsail throws this exception when an operation fails to execute.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.NotFoundException - Lightsail throws this exception when it cannot find a resource.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.
The delete disk operation supports tag-based access control via resource tags applied to the
resource identified by disk name. For more information, see the Lightsail Dev Guide.
deleteDisk in interface AmazonLightsaildeleteDiskRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.
The delete disk snapshot operation supports tag-based access control via resource tags applied to
the resource identified by disk snapshot name. For more information, see the Lightsail Dev Guide.
deleteDiskSnapshot in interface AmazonLightsaildeleteDiskSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.
The delete domain operation supports tag-based access control via resource tags applied to the
resource identified by domain name. For more information, see the Lightsail Dev Guide.
deleteDomain in interface AmazonLightsaildeleteDomainRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.
The delete domain entry operation supports tag-based access control via resource tags applied to the
resource identified by domain name. For more information, see the Lightsail Dev Guide.
deleteDomainEntry in interface AmazonLightsaildeleteDomainEntryRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 an Amazon Lightsail instance.
The delete instance operation supports tag-based access control via resource tags applied to the
resource identified by instance name. For more information, see the Lightsail Dev Guide.
deleteInstance in interface AmazonLightsaildeleteInstanceRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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).
The delete instance snapshot operation supports tag-based access control via resource tags applied
to the resource identified by instance snapshot name. For more information, see the Lightsail Dev Guide.
deleteInstanceSnapshot in interface AmazonLightsaildeleteInstanceSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.
The delete key pair operation supports tag-based access control via resource tags applied to the
resource identified by key pair name. For more information, see the Lightsail Dev Guide.
deleteKeyPair in interface AmazonLightsaildeleteKeyPairRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 DeleteKnownHostKeysResult deleteKnownHostKeys(DeleteKnownHostKeysRequest request)
Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance. This operation enables the Lightsail browser-based SSH or RDP clients to connect to the instance after a host key mismatch.
Perform this operation only if you were expecting the host key or certificate mismatch or if you are familiar with the new host key or certificate on the instance. For more information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP client.
deleteKnownHostKeys in interface AmazonLightsaildeleteKnownHostKeysRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again.
The delete load balancer operation supports tag-based access control via resource tags applied to
the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
deleteLoadBalancer in interface AmazonLightsaildeleteLoadBalancerRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 an SSL/TLS certificate associated with a Lightsail load balancer.
The DeleteLoadBalancerTlsCertificate operation supports tag-based access control via resource tags
applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
deleteLoadBalancerTlsCertificate in interface AmazonLightsaildeleteLoadBalancerTlsCertificateRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 DeleteRelationalDatabaseResult deleteRelationalDatabase(DeleteRelationalDatabaseRequest request)
Deletes a database in Amazon Lightsail.
The delete relational database operation supports tag-based access control via resource tags applied
to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
deleteRelationalDatabase in interface AmazonLightsaildeleteRelationalDatabaseRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 DeleteRelationalDatabaseSnapshotResult deleteRelationalDatabaseSnapshot(DeleteRelationalDatabaseSnapshotRequest request)
Deletes a database snapshot in Amazon Lightsail.
The delete relational database snapshot operation supports tag-based access control via resource
tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
deleteRelationalDatabaseSnapshot in interface AmazonLightsaildeleteRelationalDatabaseSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.
The detach disk operation supports tag-based access control via resource tags applied to the
resource identified by disk name. For more information, see the Lightsail Dev Guide.
detachDisk in interface AmazonLightsaildetachDiskRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.
This operation waits until the instances are no longer needed before they are detached from the load balancer.
The detach instances from load balancer operation supports tag-based access control via resource
tags applied to the resource identified by load balancer name. For more information, see the Lightsail
Dev Guide.
detachInstancesFromLoadBalancer in interface AmazonLightsaildetachInstancesFromLoadBalancerRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 AmazonLightsaildetachStaticIpRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 DisableAddOnResult disableAddOn(DisableAddOnRequest request)
Disables an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide.
disableAddOn in interface AmazonLightsaildisableAddOnRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.public DownloadDefaultKeyPairResult downloadDefaultKeyPair(DownloadDefaultKeyPairRequest request)
Downloads the default SSH key pair from the user's account.
downloadDefaultKeyPair in interface AmazonLightsaildownloadDefaultKeyPairRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 EnableAddOnResult enableAddOn(EnableAddOnRequest request)
Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide.
enableAddOn in interface AmazonLightsailenableAddOnRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.public ExportSnapshotResult exportSnapshot(ExportSnapshotRequest request)
Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2).
This operation results in an export snapshot record that can be used with the
create cloud formation stack operation to create new Amazon EC2 instances.
Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot.
The export snapshot operation supports tag-based access control via resource tags applied to the
resource identified by source snapshot name. For more information, see the Lightsail Dev Guide.
Use the get instance snapshots or get disk snapshots operations to get a list of
snapshots that you can export to Amazon EC2.
exportSnapshot in interface AmazonLightsailexportSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 AmazonLightsailgetActiveNamesRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 GetAlarmsResult getAlarms(GetAlarmsRequest request)
Returns information about the configured alarms. Specify an alarm name in your request to return information about a specific alarm, or specify a monitored resource name to return information about all alarms for a specific resource.
An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
getAlarms in interface AmazonLightsailgetAlarmsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
OperationFailureException - Lightsail throws this exception when an operation fails to execute.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.NotFoundException - Lightsail throws this exception when it cannot find a resource.public GetAutoSnapshotsResult getAutoSnapshots(GetAutoSnapshotsRequest request)
Returns the available automatic snapshots for an instance or disk. For more information, see the Lightsail Dev Guide.
getAutoSnapshots in interface AmazonLightsailgetAutoSnapshotsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.public GetBlueprintsResult getBlueprints(GetBlueprintsRequest request)
Returns the list of available instance images, or blueprints. You can use a blueprint to create a new instance already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.
Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.
getBlueprints in interface AmazonLightsailgetBlueprintsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 AmazonLightsailgetBundlesRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 GetCloudFormationStackRecordsResult getCloudFormationStackRecords(GetCloudFormationStackRecordsRequest request)
Returns the CloudFormation stack record created as a result of the create cloud formation stack
operation.
An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail snapshot.
getCloudFormationStackRecords in interface AmazonLightsailgetCloudFormationStackRecordsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 GetContactMethodsResult getContactMethods(GetContactMethodsRequest request)
Returns information about the configured contact methods. Specify a protocol in your request to return information about a specific contact method.
A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
getContactMethods in interface AmazonLightsailgetContactMethodsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.public GetDiskResult getDisk(GetDiskRequest request)
Returns information about a specific block storage disk.
getDisk in interface AmazonLightsailgetDiskRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 AmazonLightsailgetDiskSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.
getDiskSnapshots in interface AmazonLightsailgetDiskSnapshotsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.
getDisks in interface AmazonLightsailgetDisksRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 AmazonLightsailgetDomainRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 AmazonLightsailgetDomainsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 GetExportSnapshotRecordsResult getExportSnapshotRecords(GetExportSnapshotRecordsRequest request)
Returns the export snapshot record created as a result of the export snapshot operation.
An export snapshot record can be used to create a new Amazon EC2 instance and its related resources with the
create cloud formation stack operation.
getExportSnapshotRecords in interface AmazonLightsailgetExportSnapshotRecordsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 AmazonLightsailgetInstanceRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.
The get instance access details operation supports tag-based access control via resource tags
applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide.
getInstanceAccessDetails in interface AmazonLightsailgetInstanceAccessDetailsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.
Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
getInstanceMetricData in interface AmazonLightsailgetInstanceMetricDataRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 firewall port states for a specific Amazon Lightsail instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.
getInstancePortStates in interface AmazonLightsailgetInstancePortStatesRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 AmazonLightsailgetInstanceSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 AmazonLightsailgetInstanceSnapshotsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 AmazonLightsailgetInstanceStateRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 AmazonLightsailgetInstancesRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 AmazonLightsailgetKeyPairRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 AmazonLightsailgetKeyPairsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 AmazonLightsailgetLoadBalancerRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.
Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
getLoadBalancerMetricData in interface AmazonLightsailgetLoadBalancerMetricDataRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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).
You can have a maximum of 2 certificates associated with a Lightsail load balancer. One is active and the other is inactive.
getLoadBalancerTlsCertificates in interface AmazonLightsailgetLoadBalancerTlsCertificatesRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.
getLoadBalancers in interface AmazonLightsailgetLoadBalancersRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 AmazonLightsailgetOperationRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 AmazonLightsailgetOperationsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 AmazonLightsailgetOperationsForResourceRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 AmazonLightsailgetRegionsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 GetRelationalDatabaseResult getRelationalDatabase(GetRelationalDatabaseRequest request)
Returns information about a specific database in Amazon Lightsail.
getRelationalDatabase in interface AmazonLightsailgetRelationalDatabaseRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 GetRelationalDatabaseBlueprintsResult getRelationalDatabaseBlueprints(GetRelationalDatabaseBlueprintsRequest request)
Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database.
You can use a blueprint ID to create a new database that runs a specific database engine.
getRelationalDatabaseBlueprints in interface AmazonLightsailgetRelationalDatabaseBlueprintsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 GetRelationalDatabaseBundlesResult getRelationalDatabaseBundles(GetRelationalDatabaseBundlesRequest request)
Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database.
You can use a bundle ID to create a new database with explicit performance specifications.
getRelationalDatabaseBundles in interface AmazonLightsailgetRelationalDatabaseBundlesRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 GetRelationalDatabaseEventsResult getRelationalDatabaseEvents(GetRelationalDatabaseEventsRequest request)
Returns a list of events for a specific database in Amazon Lightsail.
getRelationalDatabaseEvents in interface AmazonLightsailgetRelationalDatabaseEventsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 GetRelationalDatabaseLogEventsResult getRelationalDatabaseLogEvents(GetRelationalDatabaseLogEventsRequest request)
Returns a list of log events for a database in Amazon Lightsail.
getRelationalDatabaseLogEvents in interface AmazonLightsailgetRelationalDatabaseLogEventsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 GetRelationalDatabaseLogStreamsResult getRelationalDatabaseLogStreams(GetRelationalDatabaseLogStreamsRequest request)
Returns a list of available log streams for a specific database in Amazon Lightsail.
getRelationalDatabaseLogStreams in interface AmazonLightsailgetRelationalDatabaseLogStreamsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 GetRelationalDatabaseMasterUserPasswordResult getRelationalDatabaseMasterUserPassword(GetRelationalDatabaseMasterUserPasswordRequest request)
Returns the current, previous, or pending versions of the master user password for a Lightsail database.
The GetRelationalDatabaseMasterUserPassword operation supports tag-based access control via resource
tags applied to the resource identified by relationalDatabaseName.
getRelationalDatabaseMasterUserPassword in interface AmazonLightsailgetRelationalDatabaseMasterUserPasswordRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 GetRelationalDatabaseMetricDataResult getRelationalDatabaseMetricData(GetRelationalDatabaseMetricDataRequest request)
Returns the data points of the specified metric for a database in Amazon Lightsail.
Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
getRelationalDatabaseMetricData in interface AmazonLightsailgetRelationalDatabaseMetricDataRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 GetRelationalDatabaseParametersResult getRelationalDatabaseParameters(GetRelationalDatabaseParametersRequest request)
Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail.
In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a reboot, whether the parameter is modifiable, the allowed values, and the data types.
getRelationalDatabaseParameters in interface AmazonLightsailgetRelationalDatabaseParametersRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 GetRelationalDatabaseSnapshotResult getRelationalDatabaseSnapshot(GetRelationalDatabaseSnapshotRequest request)
Returns information about a specific database snapshot in Amazon Lightsail.
getRelationalDatabaseSnapshot in interface AmazonLightsailgetRelationalDatabaseSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 GetRelationalDatabaseSnapshotsResult getRelationalDatabaseSnapshots(GetRelationalDatabaseSnapshotsRequest request)
Returns information about all of your database snapshots in Amazon Lightsail.
getRelationalDatabaseSnapshots in interface AmazonLightsailgetRelationalDatabaseSnapshotsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 GetRelationalDatabasesResult getRelationalDatabases(GetRelationalDatabasesRequest request)
Returns information about all of your databases in Amazon Lightsail.
getRelationalDatabases in interface AmazonLightsailgetRelationalDatabasesRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 AmazonLightsailgetStaticIpRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 AmazonLightsailgetStaticIpsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 AmazonLightsailimportKeyPairRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 AmazonLightsailisVpcPeeredRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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)
Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol.
The OpenInstancePublicPorts action supports tag-based access control via resource tags applied to
the resource identified by instanceName. For more information, see the Lightsail Dev Guide.
openInstancePublicPorts in interface AmazonLightsailopenInstancePublicPortsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 AmazonLightsailpeerVpcRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 PutAlarmResult putAlarm(PutAlarmRequest request)
Creates or updates an alarm, and associates it with the specified metric.
An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
When this action creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The
alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then
executed.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. The alarm is then evaluated with the updated configuration.
putAlarm in interface AmazonLightsailputAlarmRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.NotFoundException - Lightsail throws this exception when it cannot find a resource.public PutInstancePublicPortsResult putInstancePublicPorts(PutInstancePublicPortsRequest request)
Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the
instance through the ports, and the protocol. This action also closes all currently open ports that are not
included in the request. Include all of the ports and the protocols you want to open in your
PutInstancePublicPortsrequest. Or use the OpenInstancePublicPorts action to open ports
without closing currently open ports.
The PutInstancePublicPorts action supports tag-based access control via resource tags applied to the
resource identified by instanceName. For more information, see the Lightsail Dev Guide.
putInstancePublicPorts in interface AmazonLightsailputInstancePublicPortsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.
The reboot instance operation supports tag-based access control via resource tags applied to the
resource identified by instance name. For more information, see the Lightsail Dev Guide.
rebootInstance in interface AmazonLightsailrebootInstanceRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 RebootRelationalDatabaseResult rebootRelationalDatabase(RebootRelationalDatabaseRequest request)
Restarts a specific database in Amazon Lightsail.
The reboot relational database operation supports tag-based access control via resource tags applied
to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
rebootRelationalDatabase in interface AmazonLightsailrebootRelationalDatabaseRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 AmazonLightsailreleaseStaticIpRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 SendContactMethodVerificationResult sendContactMethodVerification(SendContactMethodVerificationRequest request)
Sends a verification request to an email contact method to ensure it's owned by the requester. SMS contact methods don't need to be verified.
A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
A verification request is sent to the contact method when you initially create it. Use this action to send another verification request if a previous verification request was deleted, or has expired.
Notifications are not sent to an email contact method until after it is verified, and confirmed as valid.
sendContactMethodVerification in interface AmazonLightsailsendContactMethodVerificationRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
OperationFailureException - Lightsail throws this exception when an operation fails to execute.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.NotFoundException - Lightsail throws this exception when it cannot find a resource.public StartInstanceResult startInstance(StartInstanceRequest request)
Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the
reboot instance operation.
When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Lightsail Dev Guide.
The start instance operation supports tag-based access control via resource tags applied to the
resource identified by instance name. For more information, see the Lightsail Dev Guide.
startInstance in interface AmazonLightsailstartInstanceRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 StartRelationalDatabaseResult startRelationalDatabase(StartRelationalDatabaseRequest request)
Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the
reboot relational database operation.
The start relational database operation supports tag-based access control via resource tags applied
to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
startRelationalDatabase in interface AmazonLightsailstartRelationalDatabaseRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.
When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Lightsail Dev Guide.
The stop instance operation supports tag-based access control via resource tags applied to the
resource identified by instance name. For more information, see the Lightsail Dev Guide.
stopInstance in interface AmazonLightsailstopInstanceRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 StopRelationalDatabaseResult stopRelationalDatabase(StopRelationalDatabaseRequest request)
Stops a specific database that is currently running in Amazon Lightsail.
The stop relational database operation supports tag-based access control via resource tags applied
to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
stopRelationalDatabase in interface AmazonLightsailstopRelationalDatabaseRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 TagResourceResult tagResource(TagResourceRequest request)
Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the Lightsail Dev Guide.
The tag resource operation supports tag-based access control via request tags and resource tags
applied to the resource identified by resource name. For more information, see the Lightsail Dev Guide.
tagResource in interface AmazonLightsailtagResourceRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 TestAlarmResult testAlarm(TestAlarmRequest request)
Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification trigger is configured
for the specified alarm, the test also sends a notification to the notification protocol (Email
and/or SMS) configured for the alarm.
An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
testAlarm in interface AmazonLightsailtestAlarmRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
OperationFailureException - Lightsail throws this exception when an operation fails to execute.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.NotFoundException - Lightsail throws this exception when it cannot find a resource.public UnpeerVpcResult unpeerVpc(UnpeerVpcRequest request)
Attempts to unpeer the Lightsail VPC from the user's default VPC.
unpeerVpc in interface AmazonLightsailunpeerVpcRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 UntagResourceResult untagResource(UntagResourceRequest request)
Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.
The untag resource operation supports tag-based access control via request tags and resource tags
applied to the resource identified by resource name. For more information, see the Lightsail Dev Guide.
untagResource in interface AmazonLightsailuntagResourceRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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.
The update domain entry operation supports tag-based access control via resource tags applied to the
resource identified by domain name. For more information, see the Lightsail Dev Guide.
updateDomainEntry in interface AmazonLightsailupdateDomainEntryRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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. You can only update one attribute at a time.
The update load balancer attribute operation supports tag-based access control via resource tags
applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.
updateLoadBalancerAttribute in interface AmazonLightsailupdateLoadBalancerAttributeRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 UpdateRelationalDatabaseResult updateRelationalDatabase(UpdateRelationalDatabaseRequest request)
Allows the update of one or more attributes of a database in Amazon Lightsail.
Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database's predefined maintenance window.
The update relational database operation supports tag-based access control via resource tags applied
to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
updateRelationalDatabase in interface AmazonLightsailupdateRelationalDatabaseRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 UpdateRelationalDatabaseParametersResult updateRelationalDatabaseParameters(UpdateRelationalDatabaseParametersRequest request)
Allows the update of one or more parameters of a database in Amazon Lightsail.
Parameter updates don't cause outages; therefore, their application is not subject to the preferred maintenance
window. However, there are two ways in which parameter updates are applied: dynamic or
pending-reboot. Parameters marked with a dynamic apply type are applied immediately.
Parameters marked with a pending-reboot apply type are applied only after the database is rebooted
using the reboot relational database operation.
The update relational database parameters operation supports tag-based access control via resource
tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
updateRelationalDatabaseParameters in interface AmazonLightsailupdateRelationalDatabaseParametersRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this 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 AmazonLightsailrequest - The originally executed requestCopyright © 2020. All rights reserved.