@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface LightsailClient extends AwsClient
builder() method.
Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes everything you need to launch your project quickly - instances (virtual private servers), container services, storage buckets, managed databases, SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN) distributions, DNS management of registered domains, and resource snapshots (backups) - for a low, predictable monthly price.
You can manage your Lightsail resources using the Lightsail console, Lightsail API, Command Line Interface (CLI), or SDKs. For more information about Lightsail concepts and tasks, see the Amazon Lightsail Developer Guide.
This API Reference provides detailed information about the actions, data types, parameters, and errors of the Lightsail service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see Amazon Lightsail Endpoints and Quotas in the Amazon Web Services General Reference.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AllocateStaticIpResponse |
allocateStaticIp(AllocateStaticIpRequest allocateStaticIpRequest)
Allocates a static IP address.
|
default AllocateStaticIpResponse |
allocateStaticIp(Consumer<AllocateStaticIpRequest.Builder> allocateStaticIpRequest)
Allocates a static IP address.
|
default AttachCertificateToDistributionResponse |
attachCertificateToDistribution(AttachCertificateToDistributionRequest attachCertificateToDistributionRequest)
Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.
|
default AttachCertificateToDistributionResponse |
attachCertificateToDistribution(Consumer<AttachCertificateToDistributionRequest.Builder> attachCertificateToDistributionRequest)
Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.
|
default AttachDiskResponse |
attachDisk(AttachDiskRequest attachDiskRequest)
Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the
specified disk name.
|
default AttachDiskResponse |
attachDisk(Consumer<AttachDiskRequest.Builder> attachDiskRequest)
Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the
specified disk name.
|
default AttachInstancesToLoadBalancerResponse |
attachInstancesToLoadBalancer(AttachInstancesToLoadBalancerRequest attachInstancesToLoadBalancerRequest)
Attaches one or more Lightsail instances to a load balancer.
|
default AttachInstancesToLoadBalancerResponse |
attachInstancesToLoadBalancer(Consumer<AttachInstancesToLoadBalancerRequest.Builder> attachInstancesToLoadBalancerRequest)
Attaches one or more Lightsail instances to a load balancer.
|
default AttachLoadBalancerTlsCertificateResponse |
attachLoadBalancerTlsCertificate(AttachLoadBalancerTlsCertificateRequest attachLoadBalancerTlsCertificateRequest)
Attaches a Transport Layer Security (TLS) certificate to your load balancer.
|
default AttachLoadBalancerTlsCertificateResponse |
attachLoadBalancerTlsCertificate(Consumer<AttachLoadBalancerTlsCertificateRequest.Builder> attachLoadBalancerTlsCertificateRequest)
Attaches a Transport Layer Security (TLS) certificate to your load balancer.
|
default AttachStaticIpResponse |
attachStaticIp(AttachStaticIpRequest attachStaticIpRequest)
Attaches a static IP address to a specific Amazon Lightsail instance.
|
default AttachStaticIpResponse |
attachStaticIp(Consumer<AttachStaticIpRequest.Builder> attachStaticIpRequest)
Attaches a static IP address to a specific Amazon Lightsail instance.
|
static LightsailClientBuilder |
builder()
Create a builder that can be used to configure and create a
LightsailClient. |
default CloseInstancePublicPortsResponse |
closeInstancePublicPorts(CloseInstancePublicPortsRequest closeInstancePublicPortsRequest)
Closes ports for a specific Amazon Lightsail instance.
|
default CloseInstancePublicPortsResponse |
closeInstancePublicPorts(Consumer<CloseInstancePublicPortsRequest.Builder> closeInstancePublicPortsRequest)
Closes ports for a specific Amazon Lightsail instance.
|
default CopySnapshotResponse |
copySnapshot(Consumer<CopySnapshotRequest.Builder> copySnapshotRequest)
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.
|
default CopySnapshotResponse |
copySnapshot(CopySnapshotRequest copySnapshotRequest)
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.
|
static LightsailClient |
create()
Create a
LightsailClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateBucketResponse |
createBucket(Consumer<CreateBucketRequest.Builder> createBucketRequest)
Creates an Amazon Lightsail bucket.
|
default CreateBucketResponse |
createBucket(CreateBucketRequest createBucketRequest)
Creates an Amazon Lightsail bucket.
|
default CreateBucketAccessKeyResponse |
createBucketAccessKey(Consumer<CreateBucketAccessKeyRequest.Builder> createBucketAccessKeyRequest)
Creates a new access key for the specified Amazon Lightsail bucket.
|
default CreateBucketAccessKeyResponse |
createBucketAccessKey(CreateBucketAccessKeyRequest createBucketAccessKeyRequest)
Creates a new access key for the specified Amazon Lightsail bucket.
|
default CreateCertificateResponse |
createCertificate(Consumer<CreateCertificateRequest.Builder> createCertificateRequest)
Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a
container service.
|
default CreateCertificateResponse |
createCertificate(CreateCertificateRequest createCertificateRequest)
Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a
container service.
|
default CreateCloudFormationStackResponse |
createCloudFormationStack(Consumer<CreateCloudFormationStackRequest.Builder> createCloudFormationStackRequest)
Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail
snapshot.
|
default CreateCloudFormationStackResponse |
createCloudFormationStack(CreateCloudFormationStackRequest createCloudFormationStackRequest)
Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail
snapshot.
|
default CreateContactMethodResponse |
createContactMethod(Consumer<CreateContactMethodRequest.Builder> createContactMethodRequest)
Creates an email or SMS text message contact method.
|
default CreateContactMethodResponse |
createContactMethod(CreateContactMethodRequest createContactMethodRequest)
Creates an email or SMS text message contact method.
|
default CreateContainerServiceResponse |
createContainerService(Consumer<CreateContainerServiceRequest.Builder> createContainerServiceRequest)
Creates an Amazon Lightsail container service.
|
default CreateContainerServiceResponse |
createContainerService(CreateContainerServiceRequest createContainerServiceRequest)
Creates an Amazon Lightsail container service.
|
default CreateContainerServiceDeploymentResponse |
createContainerServiceDeployment(Consumer<CreateContainerServiceDeploymentRequest.Builder> createContainerServiceDeploymentRequest)
Creates a deployment for your Amazon Lightsail container service.
|
default CreateContainerServiceDeploymentResponse |
createContainerServiceDeployment(CreateContainerServiceDeploymentRequest createContainerServiceDeploymentRequest)
Creates a deployment for your Amazon Lightsail container service.
|
default CreateContainerServiceRegistryLoginResponse |
createContainerServiceRegistryLogin(Consumer<CreateContainerServiceRegistryLoginRequest.Builder> createContainerServiceRegistryLoginRequest)
Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local
machine.
|
default CreateContainerServiceRegistryLoginResponse |
createContainerServiceRegistryLogin(CreateContainerServiceRegistryLoginRequest createContainerServiceRegistryLoginRequest)
Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local
machine.
|
default CreateDiskResponse |
createDisk(Consumer<CreateDiskRequest.Builder> createDiskRequest)
Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone
(e.g.,
us-east-2a). |
default CreateDiskResponse |
createDisk(CreateDiskRequest createDiskRequest)
Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone
(e.g.,
us-east-2a). |
default CreateDiskFromSnapshotResponse |
createDiskFromSnapshot(Consumer<CreateDiskFromSnapshotRequest.Builder> createDiskFromSnapshotRequest)
Creates a block storage disk from a manual or automatic snapshot of a disk.
|
default CreateDiskFromSnapshotResponse |
createDiskFromSnapshot(CreateDiskFromSnapshotRequest createDiskFromSnapshotRequest)
Creates a block storage disk from a manual or automatic snapshot of a disk.
|
default CreateDiskSnapshotResponse |
createDiskSnapshot(Consumer<CreateDiskSnapshotRequest.Builder> createDiskSnapshotRequest)
Creates a snapshot of a block storage disk.
|
default CreateDiskSnapshotResponse |
createDiskSnapshot(CreateDiskSnapshotRequest createDiskSnapshotRequest)
Creates a snapshot of a block storage disk.
|
default CreateDistributionResponse |
createDistribution(Consumer<CreateDistributionRequest.Builder> createDistributionRequest)
Creates an Amazon Lightsail content delivery network (CDN) distribution.
|
default CreateDistributionResponse |
createDistribution(CreateDistributionRequest createDistributionRequest)
Creates an Amazon Lightsail content delivery network (CDN) distribution.
|
default CreateDomainResponse |
createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest)
Creates a domain resource for the specified domain (e.g., example.com).
|
default CreateDomainResponse |
createDomain(CreateDomainRequest createDomainRequest)
Creates a domain resource for the specified domain (e.g., example.com).
|
default CreateDomainEntryResponse |
createDomainEntry(Consumer<CreateDomainEntryRequest.Builder> createDomainEntryRequest)
Creates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name
(CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).
|
default CreateDomainEntryResponse |
createDomainEntry(CreateDomainEntryRequest createDomainEntryRequest)
Creates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name
(CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).
|
default CreateGuiSessionAccessDetailsResponse |
createGUISessionAccessDetails(Consumer<CreateGuiSessionAccessDetailsRequest.Builder> createGuiSessionAccessDetailsRequest)
Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session.
|
default CreateGuiSessionAccessDetailsResponse |
createGUISessionAccessDetails(CreateGuiSessionAccessDetailsRequest createGuiSessionAccessDetailsRequest)
Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session.
|
default CreateInstancesResponse |
createInstances(Consumer<CreateInstancesRequest.Builder> createInstancesRequest)
Creates one or more Amazon Lightsail instances.
|
default CreateInstancesResponse |
createInstances(CreateInstancesRequest createInstancesRequest)
Creates one or more Amazon Lightsail instances.
|
default CreateInstancesFromSnapshotResponse |
createInstancesFromSnapshot(Consumer<CreateInstancesFromSnapshotRequest.Builder> createInstancesFromSnapshotRequest)
Creates one or more new instances from a manual or automatic snapshot of an instance.
|
default CreateInstancesFromSnapshotResponse |
createInstancesFromSnapshot(CreateInstancesFromSnapshotRequest createInstancesFromSnapshotRequest)
Creates one or more new instances from a manual or automatic snapshot of an instance.
|
default CreateInstanceSnapshotResponse |
createInstanceSnapshot(Consumer<CreateInstanceSnapshotRequest.Builder> createInstanceSnapshotRequest)
Creates a snapshot of a specific virtual private server, or instance.
|
default CreateInstanceSnapshotResponse |
createInstanceSnapshot(CreateInstanceSnapshotRequest createInstanceSnapshotRequest)
Creates a snapshot of a specific virtual private server, or instance.
|
default CreateKeyPairResponse |
createKeyPair(Consumer<CreateKeyPairRequest.Builder> createKeyPairRequest)
Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.
|
default CreateKeyPairResponse |
createKeyPair(CreateKeyPairRequest createKeyPairRequest)
Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.
|
default CreateLoadBalancerResponse |
createLoadBalancer(Consumer<CreateLoadBalancerRequest.Builder> createLoadBalancerRequest)
Creates a Lightsail load balancer.
|
default CreateLoadBalancerResponse |
createLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest)
Creates a Lightsail load balancer.
|
default CreateLoadBalancerTlsCertificateResponse |
createLoadBalancerTlsCertificate(Consumer<CreateLoadBalancerTlsCertificateRequest.Builder> createLoadBalancerTlsCertificateRequest)
Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.
|
default CreateLoadBalancerTlsCertificateResponse |
createLoadBalancerTlsCertificate(CreateLoadBalancerTlsCertificateRequest createLoadBalancerTlsCertificateRequest)
Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.
|
default CreateRelationalDatabaseResponse |
createRelationalDatabase(Consumer<CreateRelationalDatabaseRequest.Builder> createRelationalDatabaseRequest)
Creates a new database in Amazon Lightsail.
|
default CreateRelationalDatabaseResponse |
createRelationalDatabase(CreateRelationalDatabaseRequest createRelationalDatabaseRequest)
Creates a new database in Amazon Lightsail.
|
default CreateRelationalDatabaseFromSnapshotResponse |
createRelationalDatabaseFromSnapshot(Consumer<CreateRelationalDatabaseFromSnapshotRequest.Builder> createRelationalDatabaseFromSnapshotRequest)
Creates a new database from an existing database snapshot in Amazon Lightsail.
|
default CreateRelationalDatabaseFromSnapshotResponse |
createRelationalDatabaseFromSnapshot(CreateRelationalDatabaseFromSnapshotRequest createRelationalDatabaseFromSnapshotRequest)
Creates a new database from an existing database snapshot in Amazon Lightsail.
|
default CreateRelationalDatabaseSnapshotResponse |
createRelationalDatabaseSnapshot(Consumer<CreateRelationalDatabaseSnapshotRequest.Builder> createRelationalDatabaseSnapshotRequest)
Creates a snapshot of your database in Amazon Lightsail.
|
default CreateRelationalDatabaseSnapshotResponse |
createRelationalDatabaseSnapshot(CreateRelationalDatabaseSnapshotRequest createRelationalDatabaseSnapshotRequest)
Creates a snapshot of your database in Amazon Lightsail.
|
default DeleteAlarmResponse |
deleteAlarm(Consumer<DeleteAlarmRequest.Builder> deleteAlarmRequest)
Deletes an alarm.
|
default DeleteAlarmResponse |
deleteAlarm(DeleteAlarmRequest deleteAlarmRequest)
Deletes an alarm.
|
default DeleteAutoSnapshotResponse |
deleteAutoSnapshot(Consumer<DeleteAutoSnapshotRequest.Builder> deleteAutoSnapshotRequest)
Deletes an automatic snapshot of an instance or disk.
|
default DeleteAutoSnapshotResponse |
deleteAutoSnapshot(DeleteAutoSnapshotRequest deleteAutoSnapshotRequest)
Deletes an automatic snapshot of an instance or disk.
|
default DeleteBucketResponse |
deleteBucket(Consumer<DeleteBucketRequest.Builder> deleteBucketRequest)
Deletes a Amazon Lightsail bucket.
|
default DeleteBucketResponse |
deleteBucket(DeleteBucketRequest deleteBucketRequest)
Deletes a Amazon Lightsail bucket.
|
default DeleteBucketAccessKeyResponse |
deleteBucketAccessKey(Consumer<DeleteBucketAccessKeyRequest.Builder> deleteBucketAccessKeyRequest)
Deletes an access key for the specified Amazon Lightsail bucket.
|
default DeleteBucketAccessKeyResponse |
deleteBucketAccessKey(DeleteBucketAccessKeyRequest deleteBucketAccessKeyRequest)
Deletes an access key for the specified Amazon Lightsail bucket.
|
default DeleteCertificateResponse |
deleteCertificate(Consumer<DeleteCertificateRequest.Builder> deleteCertificateRequest)
Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.
|
default DeleteCertificateResponse |
deleteCertificate(DeleteCertificateRequest deleteCertificateRequest)
Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.
|
default DeleteContactMethodResponse |
deleteContactMethod(Consumer<DeleteContactMethodRequest.Builder> deleteContactMethodRequest)
Deletes a contact method.
|
default DeleteContactMethodResponse |
deleteContactMethod(DeleteContactMethodRequest deleteContactMethodRequest)
Deletes a contact method.
|
default DeleteContainerImageResponse |
deleteContainerImage(Consumer<DeleteContainerImageRequest.Builder> deleteContainerImageRequest)
Deletes a container image that is registered to your Amazon Lightsail container service.
|
default DeleteContainerImageResponse |
deleteContainerImage(DeleteContainerImageRequest deleteContainerImageRequest)
Deletes a container image that is registered to your Amazon Lightsail container service.
|
default DeleteContainerServiceResponse |
deleteContainerService(Consumer<DeleteContainerServiceRequest.Builder> deleteContainerServiceRequest)
Deletes your Amazon Lightsail container service.
|
default DeleteContainerServiceResponse |
deleteContainerService(DeleteContainerServiceRequest deleteContainerServiceRequest)
Deletes your Amazon Lightsail container service.
|
default DeleteDiskResponse |
deleteDisk(Consumer<DeleteDiskRequest.Builder> deleteDiskRequest)
Deletes the specified block storage disk.
|
default DeleteDiskResponse |
deleteDisk(DeleteDiskRequest deleteDiskRequest)
Deletes the specified block storage disk.
|
default DeleteDiskSnapshotResponse |
deleteDiskSnapshot(Consumer<DeleteDiskSnapshotRequest.Builder> deleteDiskSnapshotRequest)
Deletes the specified disk snapshot.
|
default DeleteDiskSnapshotResponse |
deleteDiskSnapshot(DeleteDiskSnapshotRequest deleteDiskSnapshotRequest)
Deletes the specified disk snapshot.
|
default DeleteDistributionResponse |
deleteDistribution(Consumer<DeleteDistributionRequest.Builder> deleteDistributionRequest)
Deletes your Amazon Lightsail content delivery network (CDN) distribution.
|
default DeleteDistributionResponse |
deleteDistribution(DeleteDistributionRequest deleteDistributionRequest)
Deletes your Amazon Lightsail content delivery network (CDN) distribution.
|
default DeleteDomainResponse |
deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest)
Deletes the specified domain recordset and all of its domain records.
|
default DeleteDomainResponse |
deleteDomain(DeleteDomainRequest deleteDomainRequest)
Deletes the specified domain recordset and all of its domain records.
|
default DeleteDomainEntryResponse |
deleteDomainEntry(Consumer<DeleteDomainEntryRequest.Builder> deleteDomainEntryRequest)
Deletes a specific domain entry.
|
default DeleteDomainEntryResponse |
deleteDomainEntry(DeleteDomainEntryRequest deleteDomainEntryRequest)
Deletes a specific domain entry.
|
default DeleteInstanceResponse |
deleteInstance(Consumer<DeleteInstanceRequest.Builder> deleteInstanceRequest)
Deletes an Amazon Lightsail instance.
|
default DeleteInstanceResponse |
deleteInstance(DeleteInstanceRequest deleteInstanceRequest)
Deletes an Amazon Lightsail instance.
|
default DeleteInstanceSnapshotResponse |
deleteInstanceSnapshot(Consumer<DeleteInstanceSnapshotRequest.Builder> deleteInstanceSnapshotRequest)
Deletes a specific snapshot of a virtual private server (or instance).
|
default DeleteInstanceSnapshotResponse |
deleteInstanceSnapshot(DeleteInstanceSnapshotRequest deleteInstanceSnapshotRequest)
Deletes a specific snapshot of a virtual private server (or instance).
|
default DeleteKeyPairResponse |
deleteKeyPair(Consumer<DeleteKeyPairRequest.Builder> deleteKeyPairRequest)
Deletes the specified key pair by removing the public key from Amazon Lightsail.
|
default DeleteKeyPairResponse |
deleteKeyPair(DeleteKeyPairRequest deleteKeyPairRequest)
Deletes the specified key pair by removing the public key from Amazon Lightsail.
|
default DeleteKnownHostKeysResponse |
deleteKnownHostKeys(Consumer<DeleteKnownHostKeysRequest.Builder> deleteKnownHostKeysRequest)
Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to
authenticate an instance.
|
default DeleteKnownHostKeysResponse |
deleteKnownHostKeys(DeleteKnownHostKeysRequest deleteKnownHostKeysRequest)
Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to
authenticate an instance.
|
default DeleteLoadBalancerResponse |
deleteLoadBalancer(Consumer<DeleteLoadBalancerRequest.Builder> deleteLoadBalancerRequest)
Deletes a Lightsail load balancer and all its associated SSL/TLS certificates.
|
default DeleteLoadBalancerResponse |
deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest)
Deletes a Lightsail load balancer and all its associated SSL/TLS certificates.
|
default DeleteLoadBalancerTlsCertificateResponse |
deleteLoadBalancerTlsCertificate(Consumer<DeleteLoadBalancerTlsCertificateRequest.Builder> deleteLoadBalancerTlsCertificateRequest)
Deletes an SSL/TLS certificate associated with a Lightsail load balancer.
|
default DeleteLoadBalancerTlsCertificateResponse |
deleteLoadBalancerTlsCertificate(DeleteLoadBalancerTlsCertificateRequest deleteLoadBalancerTlsCertificateRequest)
Deletes an SSL/TLS certificate associated with a Lightsail load balancer.
|
default DeleteRelationalDatabaseResponse |
deleteRelationalDatabase(Consumer<DeleteRelationalDatabaseRequest.Builder> deleteRelationalDatabaseRequest)
Deletes a database in Amazon Lightsail.
|
default DeleteRelationalDatabaseResponse |
deleteRelationalDatabase(DeleteRelationalDatabaseRequest deleteRelationalDatabaseRequest)
Deletes a database in Amazon Lightsail.
|
default DeleteRelationalDatabaseSnapshotResponse |
deleteRelationalDatabaseSnapshot(Consumer<DeleteRelationalDatabaseSnapshotRequest.Builder> deleteRelationalDatabaseSnapshotRequest)
Deletes a database snapshot in Amazon Lightsail.
|
default DeleteRelationalDatabaseSnapshotResponse |
deleteRelationalDatabaseSnapshot(DeleteRelationalDatabaseSnapshotRequest deleteRelationalDatabaseSnapshotRequest)
Deletes a database snapshot in Amazon Lightsail.
|
default DetachCertificateFromDistributionResponse |
detachCertificateFromDistribution(Consumer<DetachCertificateFromDistributionRequest.Builder> detachCertificateFromDistributionRequest)
Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.
|
default DetachCertificateFromDistributionResponse |
detachCertificateFromDistribution(DetachCertificateFromDistributionRequest detachCertificateFromDistributionRequest)
Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.
|
default DetachDiskResponse |
detachDisk(Consumer<DetachDiskRequest.Builder> detachDiskRequest)
Detaches a stopped block storage disk from a Lightsail instance.
|
default DetachDiskResponse |
detachDisk(DetachDiskRequest detachDiskRequest)
Detaches a stopped block storage disk from a Lightsail instance.
|
default DetachInstancesFromLoadBalancerResponse |
detachInstancesFromLoadBalancer(Consumer<DetachInstancesFromLoadBalancerRequest.Builder> detachInstancesFromLoadBalancerRequest)
Detaches the specified instances from a Lightsail load balancer.
|
default DetachInstancesFromLoadBalancerResponse |
detachInstancesFromLoadBalancer(DetachInstancesFromLoadBalancerRequest detachInstancesFromLoadBalancerRequest)
Detaches the specified instances from a Lightsail load balancer.
|
default DetachStaticIpResponse |
detachStaticIp(Consumer<DetachStaticIpRequest.Builder> detachStaticIpRequest)
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
|
default DetachStaticIpResponse |
detachStaticIp(DetachStaticIpRequest detachStaticIpRequest)
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
|
default DisableAddOnResponse |
disableAddOn(Consumer<DisableAddOnRequest.Builder> disableAddOnRequest)
Disables an add-on for an Amazon Lightsail resource.
|
default DisableAddOnResponse |
disableAddOn(DisableAddOnRequest disableAddOnRequest)
Disables an add-on for an Amazon Lightsail resource.
|
default DownloadDefaultKeyPairResponse |
downloadDefaultKeyPair()
Downloads the regional Amazon Lightsail default key pair.
|
default DownloadDefaultKeyPairResponse |
downloadDefaultKeyPair(Consumer<DownloadDefaultKeyPairRequest.Builder> downloadDefaultKeyPairRequest)
Downloads the regional Amazon Lightsail default key pair.
|
default DownloadDefaultKeyPairResponse |
downloadDefaultKeyPair(DownloadDefaultKeyPairRequest downloadDefaultKeyPairRequest)
Downloads the regional Amazon Lightsail default key pair.
|
default EnableAddOnResponse |
enableAddOn(Consumer<EnableAddOnRequest.Builder> enableAddOnRequest)
Enables or modifies an add-on for an Amazon Lightsail resource.
|
default EnableAddOnResponse |
enableAddOn(EnableAddOnRequest enableAddOnRequest)
Enables or modifies an add-on for an Amazon Lightsail resource.
|
default ExportSnapshotResponse |
exportSnapshot(Consumer<ExportSnapshotRequest.Builder> exportSnapshotRequest)
Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2).
|
default ExportSnapshotResponse |
exportSnapshot(ExportSnapshotRequest exportSnapshotRequest)
Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2).
|
default GetActiveNamesResponse |
getActiveNames()
Returns the names of all active (not deleted) resources.
|
default GetActiveNamesResponse |
getActiveNames(Consumer<GetActiveNamesRequest.Builder> getActiveNamesRequest)
Returns the names of all active (not deleted) resources.
|
default GetActiveNamesResponse |
getActiveNames(GetActiveNamesRequest getActiveNamesRequest)
Returns the names of all active (not deleted) resources.
|
default GetAlarmsResponse |
getAlarms(Consumer<GetAlarmsRequest.Builder> getAlarmsRequest)
Returns information about the configured alarms.
|
default GetAlarmsResponse |
getAlarms(GetAlarmsRequest getAlarmsRequest)
Returns information about the configured alarms.
|
default GetAutoSnapshotsResponse |
getAutoSnapshots(Consumer<GetAutoSnapshotsRequest.Builder> getAutoSnapshotsRequest)
Returns the available automatic snapshots for an instance or disk.
|
default GetAutoSnapshotsResponse |
getAutoSnapshots(GetAutoSnapshotsRequest getAutoSnapshotsRequest)
Returns the available automatic snapshots for an instance or disk.
|
default GetBlueprintsResponse |
getBlueprints()
Returns the list of available instance images, or blueprints.
|
default GetBlueprintsResponse |
getBlueprints(Consumer<GetBlueprintsRequest.Builder> getBlueprintsRequest)
Returns the list of available instance images, or blueprints.
|
default GetBlueprintsResponse |
getBlueprints(GetBlueprintsRequest getBlueprintsRequest)
Returns the list of available instance images, or blueprints.
|
default GetBucketAccessKeysResponse |
getBucketAccessKeys(Consumer<GetBucketAccessKeysRequest.Builder> getBucketAccessKeysRequest)
Returns the existing access key IDs for the specified Amazon Lightsail bucket.
|
default GetBucketAccessKeysResponse |
getBucketAccessKeys(GetBucketAccessKeysRequest getBucketAccessKeysRequest)
Returns the existing access key IDs for the specified Amazon Lightsail bucket.
|
default GetBucketBundlesResponse |
getBucketBundles(Consumer<GetBucketBundlesRequest.Builder> getBucketBundlesRequest)
Returns the bundles that you can apply to a Amazon Lightsail bucket.
|
default GetBucketBundlesResponse |
getBucketBundles(GetBucketBundlesRequest getBucketBundlesRequest)
Returns the bundles that you can apply to a Amazon Lightsail bucket.
|
default GetBucketMetricDataResponse |
getBucketMetricData(Consumer<GetBucketMetricDataRequest.Builder> getBucketMetricDataRequest)
Returns the data points of a specific metric for an Amazon Lightsail bucket.
|
default GetBucketMetricDataResponse |
getBucketMetricData(GetBucketMetricDataRequest getBucketMetricDataRequest)
Returns the data points of a specific metric for an Amazon Lightsail bucket.
|
default GetBucketsResponse |
getBuckets(Consumer<GetBucketsRequest.Builder> getBucketsRequest)
Returns information about one or more Amazon Lightsail buckets.
|
default GetBucketsResponse |
getBuckets(GetBucketsRequest getBucketsRequest)
Returns information about one or more Amazon Lightsail buckets.
|
default GetBundlesResponse |
getBundles()
Returns the bundles that you can apply to an Amazon Lightsail instance when you create it.
|
default GetBundlesResponse |
getBundles(Consumer<GetBundlesRequest.Builder> getBundlesRequest)
Returns the bundles that you can apply to an Amazon Lightsail instance when you create it.
|
default GetBundlesResponse |
getBundles(GetBundlesRequest getBundlesRequest)
Returns the bundles that you can apply to an Amazon Lightsail instance when you create it.
|
default GetCertificatesResponse |
getCertificates(Consumer<GetCertificatesRequest.Builder> getCertificatesRequest)
Returns information about one or more Amazon Lightsail SSL/TLS certificates.
|
default GetCertificatesResponse |
getCertificates(GetCertificatesRequest getCertificatesRequest)
Returns information about one or more Amazon Lightsail SSL/TLS certificates.
|
default GetCloudFormationStackRecordsResponse |
getCloudFormationStackRecords()
Returns the CloudFormation stack record created as a result of the
create cloud formation stack
operation. |
default GetCloudFormationStackRecordsResponse |
getCloudFormationStackRecords(Consumer<GetCloudFormationStackRecordsRequest.Builder> getCloudFormationStackRecordsRequest)
Returns the CloudFormation stack record created as a result of the
create cloud formation stack
operation. |
default GetCloudFormationStackRecordsResponse |
getCloudFormationStackRecords(GetCloudFormationStackRecordsRequest getCloudFormationStackRecordsRequest)
Returns the CloudFormation stack record created as a result of the
create cloud formation stack
operation. |
default GetContactMethodsResponse |
getContactMethods(Consumer<GetContactMethodsRequest.Builder> getContactMethodsRequest)
Returns information about the configured contact methods.
|
default GetContactMethodsResponse |
getContactMethods(GetContactMethodsRequest getContactMethodsRequest)
Returns information about the configured contact methods.
|
default GetContainerApiMetadataResponse |
getContainerAPIMetadata(Consumer<GetContainerApiMetadataRequest.Builder> getContainerApiMetadataRequest)
Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control
(lightsailctl) plugin.
|
default GetContainerApiMetadataResponse |
getContainerAPIMetadata(GetContainerApiMetadataRequest getContainerApiMetadataRequest)
Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control
(lightsailctl) plugin.
|
default GetContainerImagesResponse |
getContainerImages(Consumer<GetContainerImagesRequest.Builder> getContainerImagesRequest)
Returns the container images that are registered to your Amazon Lightsail container service.
|
default GetContainerImagesResponse |
getContainerImages(GetContainerImagesRequest getContainerImagesRequest)
Returns the container images that are registered to your Amazon Lightsail container service.
|
default GetContainerLogResponse |
getContainerLog(Consumer<GetContainerLogRequest.Builder> getContainerLogRequest)
Returns the log events of a container of your Amazon Lightsail container service.
|
default GetContainerLogResponse |
getContainerLog(GetContainerLogRequest getContainerLogRequest)
Returns the log events of a container of your Amazon Lightsail container service.
|
default GetContainerServiceDeploymentsResponse |
getContainerServiceDeployments(Consumer<GetContainerServiceDeploymentsRequest.Builder> getContainerServiceDeploymentsRequest)
Returns the deployments for your Amazon Lightsail container service
|
default GetContainerServiceDeploymentsResponse |
getContainerServiceDeployments(GetContainerServiceDeploymentsRequest getContainerServiceDeploymentsRequest)
Returns the deployments for your Amazon Lightsail container service
|
default GetContainerServiceMetricDataResponse |
getContainerServiceMetricData(Consumer<GetContainerServiceMetricDataRequest.Builder> getContainerServiceMetricDataRequest)
Returns the data points of a specific metric of your Amazon Lightsail container service.
|
default GetContainerServiceMetricDataResponse |
getContainerServiceMetricData(GetContainerServiceMetricDataRequest getContainerServiceMetricDataRequest)
Returns the data points of a specific metric of your Amazon Lightsail container service.
|
default GetContainerServicePowersResponse |
getContainerServicePowers(Consumer<GetContainerServicePowersRequest.Builder> getContainerServicePowersRequest)
Returns the list of powers that can be specified for your Amazon Lightsail container services.
|
default GetContainerServicePowersResponse |
getContainerServicePowers(GetContainerServicePowersRequest getContainerServicePowersRequest)
Returns the list of powers that can be specified for your Amazon Lightsail container services.
|
default GetContainerServicesResponse |
getContainerServices(Consumer<GetContainerServicesRequest.Builder> getContainerServicesRequest)
Returns information about one or more of your Amazon Lightsail container services.
|
default GetContainerServicesResponse |
getContainerServices(GetContainerServicesRequest getContainerServicesRequest)
Returns information about one or more of your Amazon Lightsail container services.
|
default GetCostEstimateResponse |
getCostEstimate(Consumer<GetCostEstimateRequest.Builder> getCostEstimateRequest)
Retrieves information about the cost estimate for a specified resource.
|
default GetCostEstimateResponse |
getCostEstimate(GetCostEstimateRequest getCostEstimateRequest)
Retrieves information about the cost estimate for a specified resource.
|
default GetDiskResponse |
getDisk(Consumer<GetDiskRequest.Builder> getDiskRequest)
Returns information about a specific block storage disk.
|
default GetDiskResponse |
getDisk(GetDiskRequest getDiskRequest)
Returns information about a specific block storage disk.
|
default GetDisksResponse |
getDisks()
Returns information about all block storage disks in your AWS account and region.
|
default GetDisksResponse |
getDisks(Consumer<GetDisksRequest.Builder> getDisksRequest)
Returns information about all block storage disks in your AWS account and region.
|
default GetDisksResponse |
getDisks(GetDisksRequest getDisksRequest)
Returns information about all block storage disks in your AWS account and region.
|
default GetDiskSnapshotResponse |
getDiskSnapshot(Consumer<GetDiskSnapshotRequest.Builder> getDiskSnapshotRequest)
Returns information about a specific block storage disk snapshot.
|
default GetDiskSnapshotResponse |
getDiskSnapshot(GetDiskSnapshotRequest getDiskSnapshotRequest)
Returns information about a specific block storage disk snapshot.
|
default GetDiskSnapshotsResponse |
getDiskSnapshots()
Returns information about all block storage disk snapshots in your AWS account and region.
|
default GetDiskSnapshotsResponse |
getDiskSnapshots(Consumer<GetDiskSnapshotsRequest.Builder> getDiskSnapshotsRequest)
Returns information about all block storage disk snapshots in your AWS account and region.
|
default GetDiskSnapshotsResponse |
getDiskSnapshots(GetDiskSnapshotsRequest getDiskSnapshotsRequest)
Returns information about all block storage disk snapshots in your AWS account and region.
|
default GetDistributionBundlesResponse |
getDistributionBundles(Consumer<GetDistributionBundlesRequest.Builder> getDistributionBundlesRequest)
Returns the bundles that can be applied to your Amazon Lightsail content delivery network (CDN) distributions.
|
default GetDistributionBundlesResponse |
getDistributionBundles(GetDistributionBundlesRequest getDistributionBundlesRequest)
Returns the bundles that can be applied to your Amazon Lightsail content delivery network (CDN) distributions.
|
default GetDistributionLatestCacheResetResponse |
getDistributionLatestCacheReset(Consumer<GetDistributionLatestCacheResetRequest.Builder> getDistributionLatestCacheResetRequest)
Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network
(CDN) distribution.
|
default GetDistributionLatestCacheResetResponse |
getDistributionLatestCacheReset(GetDistributionLatestCacheResetRequest getDistributionLatestCacheResetRequest)
Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network
(CDN) distribution.
|
default GetDistributionMetricDataResponse |
getDistributionMetricData(Consumer<GetDistributionMetricDataRequest.Builder> getDistributionMetricDataRequest)
Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.
|
default GetDistributionMetricDataResponse |
getDistributionMetricData(GetDistributionMetricDataRequest getDistributionMetricDataRequest)
Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.
|
default GetDistributionsResponse |
getDistributions(Consumer<GetDistributionsRequest.Builder> getDistributionsRequest)
Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.
|
default GetDistributionsResponse |
getDistributions(GetDistributionsRequest getDistributionsRequest)
Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.
|
default GetDomainResponse |
getDomain(Consumer<GetDomainRequest.Builder> getDomainRequest)
Returns information about a specific domain recordset.
|
default GetDomainResponse |
getDomain(GetDomainRequest getDomainRequest)
Returns information about a specific domain recordset.
|
default GetDomainsResponse |
getDomains()
Returns a list of all domains in the user's account.
|
default GetDomainsResponse |
getDomains(Consumer<GetDomainsRequest.Builder> getDomainsRequest)
Returns a list of all domains in the user's account.
|
default GetDomainsResponse |
getDomains(GetDomainsRequest getDomainsRequest)
Returns a list of all domains in the user's account.
|
default GetExportSnapshotRecordsResponse |
getExportSnapshotRecords()
Returns all export snapshot records created as a result of the
export snapshot operation. |
default GetExportSnapshotRecordsResponse |
getExportSnapshotRecords(Consumer<GetExportSnapshotRecordsRequest.Builder> getExportSnapshotRecordsRequest)
Returns all export snapshot records created as a result of the
export snapshot operation. |
default GetExportSnapshotRecordsResponse |
getExportSnapshotRecords(GetExportSnapshotRecordsRequest getExportSnapshotRecordsRequest)
Returns all export snapshot records created as a result of the
export snapshot operation. |
default GetInstanceResponse |
getInstance(Consumer<GetInstanceRequest.Builder> getInstanceRequest)
Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
|
default GetInstanceResponse |
getInstance(GetInstanceRequest getInstanceRequest)
Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
|
default GetInstanceAccessDetailsResponse |
getInstanceAccessDetails(Consumer<GetInstanceAccessDetailsRequest.Builder> getInstanceAccessDetailsRequest)
Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
|
default GetInstanceAccessDetailsResponse |
getInstanceAccessDetails(GetInstanceAccessDetailsRequest getInstanceAccessDetailsRequest)
Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
|
default GetInstanceMetricDataResponse |
getInstanceMetricData(Consumer<GetInstanceMetricDataRequest.Builder> getInstanceMetricDataRequest)
Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
|
default GetInstanceMetricDataResponse |
getInstanceMetricData(GetInstanceMetricDataRequest getInstanceMetricDataRequest)
Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
|
default GetInstancePortStatesResponse |
getInstancePortStates(Consumer<GetInstancePortStatesRequest.Builder> getInstancePortStatesRequest)
Returns the firewall port states for a specific Amazon Lightsail instance, the IP addresses allowed to connect to
the instance through the ports, and the protocol.
|
default GetInstancePortStatesResponse |
getInstancePortStates(GetInstancePortStatesRequest getInstancePortStatesRequest)
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.
|
default GetInstancesResponse |
getInstances()
Returns information about all Amazon Lightsail virtual private servers, or instances.
|
default GetInstancesResponse |
getInstances(Consumer<GetInstancesRequest.Builder> getInstancesRequest)
Returns information about all Amazon Lightsail virtual private servers, or instances.
|
default GetInstancesResponse |
getInstances(GetInstancesRequest getInstancesRequest)
Returns information about all Amazon Lightsail virtual private servers, or instances.
|
default GetInstanceSnapshotResponse |
getInstanceSnapshot(Consumer<GetInstanceSnapshotRequest.Builder> getInstanceSnapshotRequest)
Returns information about a specific instance snapshot.
|
default GetInstanceSnapshotResponse |
getInstanceSnapshot(GetInstanceSnapshotRequest getInstanceSnapshotRequest)
Returns information about a specific instance snapshot.
|
default GetInstanceSnapshotsResponse |
getInstanceSnapshots()
Returns all instance snapshots for the user's account.
|
default GetInstanceSnapshotsResponse |
getInstanceSnapshots(Consumer<GetInstanceSnapshotsRequest.Builder> getInstanceSnapshotsRequest)
Returns all instance snapshots for the user's account.
|
default GetInstanceSnapshotsResponse |
getInstanceSnapshots(GetInstanceSnapshotsRequest getInstanceSnapshotsRequest)
Returns all instance snapshots for the user's account.
|
default GetInstanceStateResponse |
getInstanceState(Consumer<GetInstanceStateRequest.Builder> getInstanceStateRequest)
Returns the state of a specific instance.
|
default GetInstanceStateResponse |
getInstanceState(GetInstanceStateRequest getInstanceStateRequest)
Returns the state of a specific instance.
|
default GetKeyPairResponse |
getKeyPair(Consumer<GetKeyPairRequest.Builder> getKeyPairRequest)
Returns information about a specific key pair.
|
default GetKeyPairResponse |
getKeyPair(GetKeyPairRequest getKeyPairRequest)
Returns information about a specific key pair.
|
default GetKeyPairsResponse |
getKeyPairs()
Returns information about all key pairs in the user's account.
|
default GetKeyPairsResponse |
getKeyPairs(Consumer<GetKeyPairsRequest.Builder> getKeyPairsRequest)
Returns information about all key pairs in the user's account.
|
default GetKeyPairsResponse |
getKeyPairs(GetKeyPairsRequest getKeyPairsRequest)
Returns information about all key pairs in the user's account.
|
default GetLoadBalancerResponse |
getLoadBalancer(Consumer<GetLoadBalancerRequest.Builder> getLoadBalancerRequest)
Returns information about the specified Lightsail load balancer.
|
default GetLoadBalancerResponse |
getLoadBalancer(GetLoadBalancerRequest getLoadBalancerRequest)
Returns information about the specified Lightsail load balancer.
|
default GetLoadBalancerMetricDataResponse |
getLoadBalancerMetricData(Consumer<GetLoadBalancerMetricDataRequest.Builder> getLoadBalancerMetricDataRequest)
Returns information about health metrics for your Lightsail load balancer.
|
default GetLoadBalancerMetricDataResponse |
getLoadBalancerMetricData(GetLoadBalancerMetricDataRequest getLoadBalancerMetricDataRequest)
Returns information about health metrics for your Lightsail load balancer.
|
default GetLoadBalancersResponse |
getLoadBalancers()
Returns information about all load balancers in an account.
|
default GetLoadBalancersResponse |
getLoadBalancers(Consumer<GetLoadBalancersRequest.Builder> getLoadBalancersRequest)
Returns information about all load balancers in an account.
|
default GetLoadBalancersResponse |
getLoadBalancers(GetLoadBalancersRequest getLoadBalancersRequest)
Returns information about all load balancers in an account.
|
default GetLoadBalancerTlsCertificatesResponse |
getLoadBalancerTlsCertificates(Consumer<GetLoadBalancerTlsCertificatesRequest.Builder> getLoadBalancerTlsCertificatesRequest)
Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.
|
default GetLoadBalancerTlsCertificatesResponse |
getLoadBalancerTlsCertificates(GetLoadBalancerTlsCertificatesRequest getLoadBalancerTlsCertificatesRequest)
Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.
|
default GetLoadBalancerTlsPoliciesResponse |
getLoadBalancerTlsPolicies(Consumer<GetLoadBalancerTlsPoliciesRequest.Builder> getLoadBalancerTlsPoliciesRequest)
Returns a list of TLS security policies that you can apply to Lightsail load balancers.
|
default GetLoadBalancerTlsPoliciesResponse |
getLoadBalancerTlsPolicies(GetLoadBalancerTlsPoliciesRequest getLoadBalancerTlsPoliciesRequest)
Returns a list of TLS security policies that you can apply to Lightsail load balancers.
|
default GetOperationResponse |
getOperation(Consumer<GetOperationRequest.Builder> getOperationRequest)
Returns information about a specific operation.
|
default GetOperationResponse |
getOperation(GetOperationRequest getOperationRequest)
Returns information about a specific operation.
|
default GetOperationsResponse |
getOperations()
Returns information about all operations.
|
default GetOperationsResponse |
getOperations(Consumer<GetOperationsRequest.Builder> getOperationsRequest)
Returns information about all operations.
|
default GetOperationsResponse |
getOperations(GetOperationsRequest getOperationsRequest)
Returns information about all operations.
|
default GetOperationsForResourceResponse |
getOperationsForResource(Consumer<GetOperationsForResourceRequest.Builder> getOperationsForResourceRequest)
Gets operations for a specific resource (e.g., an instance or a static IP).
|
default GetOperationsForResourceResponse |
getOperationsForResource(GetOperationsForResourceRequest getOperationsForResourceRequest)
Gets operations for a specific resource (e.g., an instance or a static IP).
|
default GetRegionsResponse |
getRegions()
Returns a list of all valid regions for Amazon Lightsail.
|
default GetRegionsResponse |
getRegions(Consumer<GetRegionsRequest.Builder> getRegionsRequest)
Returns a list of all valid regions for Amazon Lightsail.
|
default GetRegionsResponse |
getRegions(GetRegionsRequest getRegionsRequest)
Returns a list of all valid regions for Amazon Lightsail.
|
default GetRelationalDatabaseResponse |
getRelationalDatabase(Consumer<GetRelationalDatabaseRequest.Builder> getRelationalDatabaseRequest)
Returns information about a specific database in Amazon Lightsail.
|
default GetRelationalDatabaseResponse |
getRelationalDatabase(GetRelationalDatabaseRequest getRelationalDatabaseRequest)
Returns information about a specific database in Amazon Lightsail.
|
default GetRelationalDatabaseBlueprintsResponse |
getRelationalDatabaseBlueprints()
Returns a list of available database blueprints in Amazon Lightsail.
|
default GetRelationalDatabaseBlueprintsResponse |
getRelationalDatabaseBlueprints(Consumer<GetRelationalDatabaseBlueprintsRequest.Builder> getRelationalDatabaseBlueprintsRequest)
Returns a list of available database blueprints in Amazon Lightsail.
|
default GetRelationalDatabaseBlueprintsResponse |
getRelationalDatabaseBlueprints(GetRelationalDatabaseBlueprintsRequest getRelationalDatabaseBlueprintsRequest)
Returns a list of available database blueprints in Amazon Lightsail.
|
default GetRelationalDatabaseBundlesResponse |
getRelationalDatabaseBundles()
Returns the list of bundles that are available in Amazon Lightsail.
|
default GetRelationalDatabaseBundlesResponse |
getRelationalDatabaseBundles(Consumer<GetRelationalDatabaseBundlesRequest.Builder> getRelationalDatabaseBundlesRequest)
Returns the list of bundles that are available in Amazon Lightsail.
|
default GetRelationalDatabaseBundlesResponse |
getRelationalDatabaseBundles(GetRelationalDatabaseBundlesRequest getRelationalDatabaseBundlesRequest)
Returns the list of bundles that are available in Amazon Lightsail.
|
default GetRelationalDatabaseEventsResponse |
getRelationalDatabaseEvents(Consumer<GetRelationalDatabaseEventsRequest.Builder> getRelationalDatabaseEventsRequest)
Returns a list of events for a specific database in Amazon Lightsail.
|
default GetRelationalDatabaseEventsResponse |
getRelationalDatabaseEvents(GetRelationalDatabaseEventsRequest getRelationalDatabaseEventsRequest)
Returns a list of events for a specific database in Amazon Lightsail.
|
default GetRelationalDatabaseLogEventsResponse |
getRelationalDatabaseLogEvents(Consumer<GetRelationalDatabaseLogEventsRequest.Builder> getRelationalDatabaseLogEventsRequest)
Returns a list of log events for a database in Amazon Lightsail.
|
default GetRelationalDatabaseLogEventsResponse |
getRelationalDatabaseLogEvents(GetRelationalDatabaseLogEventsRequest getRelationalDatabaseLogEventsRequest)
Returns a list of log events for a database in Amazon Lightsail.
|
default GetRelationalDatabaseLogStreamsResponse |
getRelationalDatabaseLogStreams(Consumer<GetRelationalDatabaseLogStreamsRequest.Builder> getRelationalDatabaseLogStreamsRequest)
Returns a list of available log streams for a specific database in Amazon Lightsail.
|
default GetRelationalDatabaseLogStreamsResponse |
getRelationalDatabaseLogStreams(GetRelationalDatabaseLogStreamsRequest getRelationalDatabaseLogStreamsRequest)
Returns a list of available log streams for a specific database in Amazon Lightsail.
|
default GetRelationalDatabaseMasterUserPasswordResponse |
getRelationalDatabaseMasterUserPassword(Consumer<GetRelationalDatabaseMasterUserPasswordRequest.Builder> getRelationalDatabaseMasterUserPasswordRequest)
Returns the current, previous, or pending versions of the master user password for a Lightsail database.
|
default GetRelationalDatabaseMasterUserPasswordResponse |
getRelationalDatabaseMasterUserPassword(GetRelationalDatabaseMasterUserPasswordRequest getRelationalDatabaseMasterUserPasswordRequest)
Returns the current, previous, or pending versions of the master user password for a Lightsail database.
|
default GetRelationalDatabaseMetricDataResponse |
getRelationalDatabaseMetricData(Consumer<GetRelationalDatabaseMetricDataRequest.Builder> getRelationalDatabaseMetricDataRequest)
Returns the data points of the specified metric for a database in Amazon Lightsail.
|
default GetRelationalDatabaseMetricDataResponse |
getRelationalDatabaseMetricData(GetRelationalDatabaseMetricDataRequest getRelationalDatabaseMetricDataRequest)
Returns the data points of the specified metric for a database in Amazon Lightsail.
|
default GetRelationalDatabaseParametersResponse |
getRelationalDatabaseParameters(Consumer<GetRelationalDatabaseParametersRequest.Builder> getRelationalDatabaseParametersRequest)
Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific
database in Amazon Lightsail.
|
default GetRelationalDatabaseParametersResponse |
getRelationalDatabaseParameters(GetRelationalDatabaseParametersRequest getRelationalDatabaseParametersRequest)
Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific
database in Amazon Lightsail.
|
default GetRelationalDatabasesResponse |
getRelationalDatabases()
Returns information about all of your databases in Amazon Lightsail.
|
default GetRelationalDatabasesResponse |
getRelationalDatabases(Consumer<GetRelationalDatabasesRequest.Builder> getRelationalDatabasesRequest)
Returns information about all of your databases in Amazon Lightsail.
|
default GetRelationalDatabasesResponse |
getRelationalDatabases(GetRelationalDatabasesRequest getRelationalDatabasesRequest)
Returns information about all of your databases in Amazon Lightsail.
|
default GetRelationalDatabaseSnapshotResponse |
getRelationalDatabaseSnapshot(Consumer<GetRelationalDatabaseSnapshotRequest.Builder> getRelationalDatabaseSnapshotRequest)
Returns information about a specific database snapshot in Amazon Lightsail.
|
default GetRelationalDatabaseSnapshotResponse |
getRelationalDatabaseSnapshot(GetRelationalDatabaseSnapshotRequest getRelationalDatabaseSnapshotRequest)
Returns information about a specific database snapshot in Amazon Lightsail.
|
default GetRelationalDatabaseSnapshotsResponse |
getRelationalDatabaseSnapshots()
Returns information about all of your database snapshots in Amazon Lightsail.
|
default GetRelationalDatabaseSnapshotsResponse |
getRelationalDatabaseSnapshots(Consumer<GetRelationalDatabaseSnapshotsRequest.Builder> getRelationalDatabaseSnapshotsRequest)
Returns information about all of your database snapshots in Amazon Lightsail.
|
default GetRelationalDatabaseSnapshotsResponse |
getRelationalDatabaseSnapshots(GetRelationalDatabaseSnapshotsRequest getRelationalDatabaseSnapshotsRequest)
Returns information about all of your database snapshots in Amazon Lightsail.
|
default GetStaticIpResponse |
getStaticIp(Consumer<GetStaticIpRequest.Builder> getStaticIpRequest)
Returns information about an Amazon Lightsail static IP.
|
default GetStaticIpResponse |
getStaticIp(GetStaticIpRequest getStaticIpRequest)
Returns information about an Amazon Lightsail static IP.
|
default GetStaticIpsResponse |
getStaticIps()
Returns information about all static IPs in the user's account.
|
default GetStaticIpsResponse |
getStaticIps(Consumer<GetStaticIpsRequest.Builder> getStaticIpsRequest)
Returns information about all static IPs in the user's account.
|
default GetStaticIpsResponse |
getStaticIps(GetStaticIpsRequest getStaticIpsRequest)
Returns information about all static IPs in the user's account.
|
default ImportKeyPairResponse |
importKeyPair(Consumer<ImportKeyPairRequest.Builder> importKeyPairRequest)
Imports a public SSH key from a specific key pair.
|
default ImportKeyPairResponse |
importKeyPair(ImportKeyPairRequest importKeyPairRequest)
Imports a public SSH key from a specific key pair.
|
default IsVpcPeeredResponse |
isVpcPeered()
Returns a Boolean value indicating whether your Lightsail VPC is peered.
|
default IsVpcPeeredResponse |
isVpcPeered(Consumer<IsVpcPeeredRequest.Builder> isVpcPeeredRequest)
Returns a Boolean value indicating whether your Lightsail VPC is peered.
|
default IsVpcPeeredResponse |
isVpcPeered(IsVpcPeeredRequest isVpcPeeredRequest)
Returns a Boolean value indicating whether your Lightsail VPC is peered.
|
default OpenInstancePublicPortsResponse |
openInstancePublicPorts(Consumer<OpenInstancePublicPortsRequest.Builder> openInstancePublicPortsRequest)
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.
|
default OpenInstancePublicPortsResponse |
openInstancePublicPorts(OpenInstancePublicPortsRequest openInstancePublicPortsRequest)
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.
|
default PeerVpcResponse |
peerVpc()
Peers the Lightsail VPC with the user's default VPC.
|
default PeerVpcResponse |
peerVpc(Consumer<PeerVpcRequest.Builder> peerVpcRequest)
Peers the Lightsail VPC with the user's default VPC.
|
default PeerVpcResponse |
peerVpc(PeerVpcRequest peerVpcRequest)
Peers the Lightsail VPC with the user's default VPC.
|
default PutAlarmResponse |
putAlarm(Consumer<PutAlarmRequest.Builder> putAlarmRequest)
Creates or updates an alarm, and associates it with the specified metric.
|
default PutAlarmResponse |
putAlarm(PutAlarmRequest putAlarmRequest)
Creates or updates an alarm, and associates it with the specified metric.
|
default PutInstancePublicPortsResponse |
putInstancePublicPorts(Consumer<PutInstancePublicPortsRequest.Builder> putInstancePublicPortsRequest)
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.
|
default PutInstancePublicPortsResponse |
putInstancePublicPorts(PutInstancePublicPortsRequest putInstancePublicPortsRequest)
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.
|
default RebootInstanceResponse |
rebootInstance(Consumer<RebootInstanceRequest.Builder> rebootInstanceRequest)
Restarts a specific instance.
|
default RebootInstanceResponse |
rebootInstance(RebootInstanceRequest rebootInstanceRequest)
Restarts a specific instance.
|
default RebootRelationalDatabaseResponse |
rebootRelationalDatabase(Consumer<RebootRelationalDatabaseRequest.Builder> rebootRelationalDatabaseRequest)
Restarts a specific database in Amazon Lightsail.
|
default RebootRelationalDatabaseResponse |
rebootRelationalDatabase(RebootRelationalDatabaseRequest rebootRelationalDatabaseRequest)
Restarts a specific database in Amazon Lightsail.
|
default RegisterContainerImageResponse |
registerContainerImage(Consumer<RegisterContainerImageRequest.Builder> registerContainerImageRequest)
Registers a container image to your Amazon Lightsail container service.
|
default RegisterContainerImageResponse |
registerContainerImage(RegisterContainerImageRequest registerContainerImageRequest)
Registers a container image to your Amazon Lightsail container service.
|
default ReleaseStaticIpResponse |
releaseStaticIp(Consumer<ReleaseStaticIpRequest.Builder> releaseStaticIpRequest)
Deletes a specific static IP from your account.
|
default ReleaseStaticIpResponse |
releaseStaticIp(ReleaseStaticIpRequest releaseStaticIpRequest)
Deletes a specific static IP from your account.
|
default ResetDistributionCacheResponse |
resetDistributionCache(Consumer<ResetDistributionCacheRequest.Builder> resetDistributionCacheRequest)
Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution.
|
default ResetDistributionCacheResponse |
resetDistributionCache(ResetDistributionCacheRequest resetDistributionCacheRequest)
Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution.
|
default SendContactMethodVerificationResponse |
sendContactMethodVerification(Consumer<SendContactMethodVerificationRequest.Builder> sendContactMethodVerificationRequest)
Sends a verification request to an email contact method to ensure it's owned by the requester.
|
default SendContactMethodVerificationResponse |
sendContactMethodVerification(SendContactMethodVerificationRequest sendContactMethodVerificationRequest)
Sends a verification request to an email contact method to ensure it's owned by the requester.
|
default LightsailServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
default SetIpAddressTypeResponse |
setIpAddressType(Consumer<SetIpAddressTypeRequest.Builder> setIpAddressTypeRequest)
Sets the IP address type for an Amazon Lightsail resource.
|
default SetIpAddressTypeResponse |
setIpAddressType(SetIpAddressTypeRequest setIpAddressTypeRequest)
Sets the IP address type for an Amazon Lightsail resource.
|
default SetResourceAccessForBucketResponse |
setResourceAccessForBucket(Consumer<SetResourceAccessForBucketRequest.Builder> setResourceAccessForBucketRequest)
Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.
|
default SetResourceAccessForBucketResponse |
setResourceAccessForBucket(SetResourceAccessForBucketRequest setResourceAccessForBucketRequest)
Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.
|
default StartGuiSessionResponse |
startGUISession(Consumer<StartGuiSessionRequest.Builder> startGuiSessionRequest)
Initiates a graphical user interface (GUI) session that’s used to access a virtual computer’s operating system
and application.
|
default StartGuiSessionResponse |
startGUISession(StartGuiSessionRequest startGuiSessionRequest)
Initiates a graphical user interface (GUI) session that’s used to access a virtual computer’s operating system
and application.
|
default StartInstanceResponse |
startInstance(Consumer<StartInstanceRequest.Builder> startInstanceRequest)
Starts a specific Amazon Lightsail instance from a stopped state.
|
default StartInstanceResponse |
startInstance(StartInstanceRequest startInstanceRequest)
Starts a specific Amazon Lightsail instance from a stopped state.
|
default StartRelationalDatabaseResponse |
startRelationalDatabase(Consumer<StartRelationalDatabaseRequest.Builder> startRelationalDatabaseRequest)
Starts a specific database from a stopped state in Amazon Lightsail.
|
default StartRelationalDatabaseResponse |
startRelationalDatabase(StartRelationalDatabaseRequest startRelationalDatabaseRequest)
Starts a specific database from a stopped state in Amazon Lightsail.
|
default StopGuiSessionResponse |
stopGUISession(Consumer<StopGuiSessionRequest.Builder> stopGuiSessionRequest)
Terminates a web-based NICE DCV session that’s used to access a virtual computer’s operating system or
application.
|
default StopGuiSessionResponse |
stopGUISession(StopGuiSessionRequest stopGuiSessionRequest)
Terminates a web-based NICE DCV session that’s used to access a virtual computer’s operating system or
application.
|
default StopInstanceResponse |
stopInstance(Consumer<StopInstanceRequest.Builder> stopInstanceRequest)
Stops a specific Amazon Lightsail instance that is currently running.
|
default StopInstanceResponse |
stopInstance(StopInstanceRequest stopInstanceRequest)
Stops a specific Amazon Lightsail instance that is currently running.
|
default StopRelationalDatabaseResponse |
stopRelationalDatabase(Consumer<StopRelationalDatabaseRequest.Builder> stopRelationalDatabaseRequest)
Stops a specific database that is currently running in Amazon Lightsail.
|
default StopRelationalDatabaseResponse |
stopRelationalDatabase(StopRelationalDatabaseRequest stopRelationalDatabaseRequest)
Stops a specific database that is currently running in Amazon Lightsail.
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds one or more tags to the specified Amazon Lightsail resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Adds one or more tags to the specified Amazon Lightsail resource.
|
default TestAlarmResponse |
testAlarm(Consumer<TestAlarmRequest.Builder> testAlarmRequest)
Tests an alarm by displaying a banner on the Amazon Lightsail console.
|
default TestAlarmResponse |
testAlarm(TestAlarmRequest testAlarmRequest)
Tests an alarm by displaying a banner on the Amazon Lightsail console.
|
default UnpeerVpcResponse |
unpeerVpc()
Unpeers the Lightsail VPC from the user's default VPC.
|
default UnpeerVpcResponse |
unpeerVpc(Consumer<UnpeerVpcRequest.Builder> unpeerVpcRequest)
Unpeers the Lightsail VPC from the user's default VPC.
|
default UnpeerVpcResponse |
unpeerVpc(UnpeerVpcRequest unpeerVpcRequest)
Unpeers the Lightsail VPC from the user's default VPC.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.
|
default UpdateBucketResponse |
updateBucket(Consumer<UpdateBucketRequest.Builder> updateBucketRequest)
Updates an existing Amazon Lightsail bucket.
|
default UpdateBucketResponse |
updateBucket(UpdateBucketRequest updateBucketRequest)
Updates an existing Amazon Lightsail bucket.
|
default UpdateBucketBundleResponse |
updateBucketBundle(Consumer<UpdateBucketBundleRequest.Builder> updateBucketBundleRequest)
Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.
|
default UpdateBucketBundleResponse |
updateBucketBundle(UpdateBucketBundleRequest updateBucketBundleRequest)
Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.
|
default UpdateContainerServiceResponse |
updateContainerService(Consumer<UpdateContainerServiceRequest.Builder> updateContainerServiceRequest)
Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain
names.
|
default UpdateContainerServiceResponse |
updateContainerService(UpdateContainerServiceRequest updateContainerServiceRequest)
Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain
names.
|
default UpdateDistributionResponse |
updateDistribution(Consumer<UpdateDistributionRequest.Builder> updateDistributionRequest)
Updates an existing Amazon Lightsail content delivery network (CDN) distribution.
|
default UpdateDistributionResponse |
updateDistribution(UpdateDistributionRequest updateDistributionRequest)
Updates an existing Amazon Lightsail content delivery network (CDN) distribution.
|
default UpdateDistributionBundleResponse |
updateDistributionBundle(Consumer<UpdateDistributionBundleRequest.Builder> updateDistributionBundleRequest)
Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.
|
default UpdateDistributionBundleResponse |
updateDistributionBundle(UpdateDistributionBundleRequest updateDistributionBundleRequest)
Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.
|
default UpdateDomainEntryResponse |
updateDomainEntry(Consumer<UpdateDomainEntryRequest.Builder> updateDomainEntryRequest)
Updates a domain recordset after it is created.
|
default UpdateDomainEntryResponse |
updateDomainEntry(UpdateDomainEntryRequest updateDomainEntryRequest)
Updates a domain recordset after it is created.
|
default UpdateInstanceMetadataOptionsResponse |
updateInstanceMetadataOptions(Consumer<UpdateInstanceMetadataOptionsRequest.Builder> updateInstanceMetadataOptionsRequest)
Modifies the Amazon Lightsail instance metadata parameters on a running or stopped instance.
|
default UpdateInstanceMetadataOptionsResponse |
updateInstanceMetadataOptions(UpdateInstanceMetadataOptionsRequest updateInstanceMetadataOptionsRequest)
Modifies the Amazon Lightsail instance metadata parameters on a running or stopped instance.
|
default UpdateLoadBalancerAttributeResponse |
updateLoadBalancerAttribute(Consumer<UpdateLoadBalancerAttributeRequest.Builder> updateLoadBalancerAttributeRequest)
Updates the specified attribute for a load balancer.
|
default UpdateLoadBalancerAttributeResponse |
updateLoadBalancerAttribute(UpdateLoadBalancerAttributeRequest updateLoadBalancerAttributeRequest)
Updates the specified attribute for a load balancer.
|
default UpdateRelationalDatabaseResponse |
updateRelationalDatabase(Consumer<UpdateRelationalDatabaseRequest.Builder> updateRelationalDatabaseRequest)
Allows the update of one or more attributes of a database in Amazon Lightsail.
|
default UpdateRelationalDatabaseResponse |
updateRelationalDatabase(UpdateRelationalDatabaseRequest updateRelationalDatabaseRequest)
Allows the update of one or more attributes of a database in Amazon Lightsail.
|
default UpdateRelationalDatabaseParametersResponse |
updateRelationalDatabaseParameters(Consumer<UpdateRelationalDatabaseParametersRequest.Builder> updateRelationalDatabaseParametersRequest)
Allows the update of one or more parameters of a database in Amazon Lightsail.
|
default UpdateRelationalDatabaseParametersResponse |
updateRelationalDatabaseParameters(UpdateRelationalDatabaseParametersRequest updateRelationalDatabaseParametersRequest)
Allows the update of one or more parameters of a database in Amazon Lightsail.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default AllocateStaticIpResponse allocateStaticIp(AllocateStaticIpRequest allocateStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Allocates a static IP address.
allocateStaticIpRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AllocateStaticIpResponse allocateStaticIp(Consumer<AllocateStaticIpRequest.Builder> allocateStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Allocates a static IP address.
This is a convenience which creates an instance of the AllocateStaticIpRequest.Builder avoiding the need
to create one manually via AllocateStaticIpRequest.builder()
allocateStaticIpRequest - A Consumer that will call methods on
AllocateStaticIpRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AttachCertificateToDistributionResponse attachCertificateToDistribution(AttachCertificateToDistributionRequest attachCertificateToDistributionRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.
After the certificate is attached, your distribution accepts HTTPS traffic for all of the domains that are associated with the certificate.
Use the CreateCertificate action to create a certificate that you can attach to your distribution.
Only certificates created in the us-east-1 Amazon Web Services Region can be attached to Lightsail
distributions. Lightsail distributions are global resources that can reference an origin in any Amazon Web
Services Region, and distribute its content globally. However, all distributions are located in the
us-east-1 Region.
attachCertificateToDistributionRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AttachCertificateToDistributionResponse attachCertificateToDistribution(Consumer<AttachCertificateToDistributionRequest.Builder> attachCertificateToDistributionRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.
After the certificate is attached, your distribution accepts HTTPS traffic for all of the domains that are associated with the certificate.
Use the CreateCertificate action to create a certificate that you can attach to your distribution.
Only certificates created in the us-east-1 Amazon Web Services Region can be attached to Lightsail
distributions. Lightsail distributions are global resources that can reference an origin in any Amazon Web
Services Region, and distribute its content globally. However, all distributions are located in the
us-east-1 Region.
This is a convenience which creates an instance of the AttachCertificateToDistributionRequest.Builder
avoiding the need to create one manually via AttachCertificateToDistributionRequest.builder()
attachCertificateToDistributionRequest - A Consumer that will call methods on
AttachCertificateToDistributionRequest.Builder to
create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AttachDiskResponse attachDisk(AttachDiskRequest attachDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.
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 Amazon Lightsail Developer Guide.
attachDiskRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AttachDiskResponse attachDisk(Consumer<AttachDiskRequest.Builder> attachDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the AttachDiskRequest.Builder avoiding the need to
create one manually via AttachDiskRequest.builder()
attachDiskRequest - A Consumer that will call methods on
AttachDiskRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AttachInstancesToLoadBalancerResponse attachInstancesToLoadBalancer(AttachInstancesToLoadBalancerRequest attachInstancesToLoadBalancerRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Developer Guide.
attachInstancesToLoadBalancerRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AttachInstancesToLoadBalancerResponse attachInstancesToLoadBalancer(Consumer<AttachInstancesToLoadBalancerRequest.Builder> attachInstancesToLoadBalancerRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Developer Guide.
This is a convenience which creates an instance of the AttachInstancesToLoadBalancerRequest.Builder
avoiding the need to create one manually via AttachInstancesToLoadBalancerRequest.builder()
attachInstancesToLoadBalancerRequest - A Consumer that will call methods on
AttachInstancesToLoadBalancerRequest.Builder to
create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AttachLoadBalancerTlsCertificateResponse attachLoadBalancerTlsCertificate(AttachLoadBalancerTlsCertificateRequest attachLoadBalancerTlsCertificateRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
attachLoadBalancerTlsCertificateRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AttachLoadBalancerTlsCertificateResponse attachLoadBalancerTlsCertificate(Consumer<AttachLoadBalancerTlsCertificateRequest.Builder> attachLoadBalancerTlsCertificateRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the AttachLoadBalancerTlsCertificateRequest.Builder
avoiding the need to create one manually via AttachLoadBalancerTlsCertificateRequest.builder()
attachLoadBalancerTlsCertificateRequest - A Consumer that will call methods on
AttachLoadBalancerTlsCertificateRequest.Builder to
create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AttachStaticIpResponse attachStaticIp(AttachStaticIpRequest attachStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Attaches a static IP address to a specific Amazon Lightsail instance.
attachStaticIpRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AttachStaticIpResponse attachStaticIp(Consumer<AttachStaticIpRequest.Builder> attachStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Attaches a static IP address to a specific Amazon Lightsail instance.
This is a convenience which creates an instance of the AttachStaticIpRequest.Builder avoiding the need to
create one manually via AttachStaticIpRequest.builder()
attachStaticIpRequest - A Consumer that will call methods on
AttachStaticIpRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CloseInstancePublicPortsResponse closeInstancePublicPorts(CloseInstancePublicPortsRequest closeInstancePublicPortsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Closes 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 Amazon Lightsail Developer Guide.
closeInstancePublicPortsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CloseInstancePublicPortsResponse closeInstancePublicPorts(Consumer<CloseInstancePublicPortsRequest.Builder> closeInstancePublicPortsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Closes 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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the CloseInstancePublicPortsRequest.Builder avoiding
the need to create one manually via CloseInstancePublicPortsRequest.builder()
closeInstancePublicPortsRequest - A Consumer that will call methods on
CloseInstancePublicPortsRequest.Builder to create
a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CopySnapshotResponse copySnapshot(CopySnapshotRequest copySnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Web Services 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.
copySnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CopySnapshotResponse copySnapshot(Consumer<CopySnapshotRequest.Builder> copySnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Web Services 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.
This is a convenience which creates an instance of the CopySnapshotRequest.Builder avoiding the need to
create one manually via CopySnapshotRequest.builder()
copySnapshotRequest - A Consumer that will call methods on
CopySnapshotRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateBucketResponse createBucket(CreateBucketRequest createBucketRequest) throws AccessDeniedException, InvalidInputException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates an Amazon Lightsail bucket.
A bucket is a cloud storage resource available in the Lightsail object storage service. Use buckets to store objects such as data and its descriptive metadata. For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.
createBucketRequest - AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateBucketResponse createBucket(Consumer<CreateBucketRequest.Builder> createBucketRequest) throws AccessDeniedException, InvalidInputException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates an Amazon Lightsail bucket.
A bucket is a cloud storage resource available in the Lightsail object storage service. Use buckets to store objects such as data and its descriptive metadata. For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the CreateBucketRequest.Builder avoiding the need to
create one manually via CreateBucketRequest.builder()
createBucketRequest - A Consumer that will call methods on
CreateBucketRequest.Builder to create a request.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateBucketAccessKeyResponse createBucketAccessKey(CreateBucketAccessKeyRequest createBucketAccessKeyRequest) throws AccessDeniedException, NotFoundException, InvalidInputException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of an access key ID and corresponding secret access key.
Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the GetBucketAccessKeys action to get a list of current access keys for a specific bucket. For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.
The secretAccessKey value is returned only in response to the CreateBucketAccessKey
action. You can get a secret access key only when you first create an access key; you cannot get the secret
access key later. If you lose the secret access key, you must create a new access key.
createBucketAccessKeyRequest - 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.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateBucketAccessKeyResponse createBucketAccessKey(Consumer<CreateBucketAccessKeyRequest.Builder> createBucketAccessKeyRequest) throws AccessDeniedException, NotFoundException, InvalidInputException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of an access key ID and corresponding secret access key.
Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the GetBucketAccessKeys action to get a list of current access keys for a specific bucket. For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.
The secretAccessKey value is returned only in response to the CreateBucketAccessKey
action. You can get a secret access key only when you first create an access key; you cannot get the secret
access key later. If you lose the secret access key, you must create a new access key.
This is a convenience which creates an instance of the CreateBucketAccessKeyRequest.Builder avoiding the
need to create one manually via CreateBucketAccessKeyRequest.builder()
createBucketAccessKeyRequest - A Consumer that will call methods on
CreateBucketAccessKeyRequest.Builder to create a
request.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.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateCertificateResponse createCertificate(CreateCertificateRequest createCertificateRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service.
After the certificate is valid, use the AttachCertificateToDistribution action to use the
certificate and its domains with your distribution. Or use the UpdateContainerService action to use
the certificate and its domains with your container service.
Only certificates created in the us-east-1 Amazon Web Services Region can be attached to Lightsail
distributions. Lightsail distributions are global resources that can reference an origin in any Amazon Web
Services Region, and distribute its content globally. However, all distributions are located in the
us-east-1 Region.
createCertificateRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateCertificateResponse createCertificate(Consumer<CreateCertificateRequest.Builder> createCertificateRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service.
After the certificate is valid, use the AttachCertificateToDistribution action to use the
certificate and its domains with your distribution. Or use the UpdateContainerService action to use
the certificate and its domains with your container service.
Only certificates created in the us-east-1 Amazon Web Services Region can be attached to Lightsail
distributions. Lightsail distributions are global resources that can reference an origin in any Amazon Web
Services Region, and distribute its content globally. However, all distributions are located in the
us-east-1 Region.
This is a convenience which creates an instance of the CreateCertificateRequest.Builder avoiding the need
to create one manually via CreateCertificateRequest.builder()
createCertificateRequest - A Consumer that will call methods on
CreateCertificateRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateCloudFormationStackResponse createCloudFormationStack(CreateCloudFormationStackRequest createCloudFormationStackRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
createCloudFormationStackRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateCloudFormationStackResponse createCloudFormationStack(Consumer<CreateCloudFormationStackRequest.Builder> createCloudFormationStackRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
This is a convenience which creates an instance of the CreateCloudFormationStackRequest.Builder avoiding
the need to create one manually via CreateCloudFormationStackRequest.builder()
createCloudFormationStackRequest - A Consumer that will call methods on
CreateCloudFormationStackRequest.Builder to create
a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateContactMethodResponse createContactMethod(CreateContactMethodRequest createContactMethodRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
createContactMethodRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateContactMethodResponse createContactMethod(Consumer<CreateContactMethodRequest.Builder> createContactMethodRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
This is a convenience which creates an instance of the CreateContactMethodRequest.Builder avoiding the
need to create one manually via CreateContactMethodRequest.builder()
createContactMethodRequest - A Consumer that will call methods on
CreateContactMethodRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateContainerServiceResponse createContainerService(CreateContainerServiceRequest createContainerServiceRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates an Amazon Lightsail container service.
A Lightsail container service is a compute resource to which you can deploy containers. For more information, see Container services in Amazon Lightsail in the Lightsail Dev Guide.
createContainerServiceRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateContainerServiceResponse createContainerService(Consumer<CreateContainerServiceRequest.Builder> createContainerServiceRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates an Amazon Lightsail container service.
A Lightsail container service is a compute resource to which you can deploy containers. For more information, see Container services in Amazon Lightsail in the Lightsail Dev Guide.
This is a convenience which creates an instance of the CreateContainerServiceRequest.Builder avoiding the
need to create one manually via CreateContainerServiceRequest.builder()
createContainerServiceRequest - A Consumer that will call methods on
CreateContainerServiceRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateContainerServiceDeploymentResponse createContainerServiceDeployment(CreateContainerServiceDeploymentRequest createContainerServiceDeploymentRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates a deployment for your Amazon Lightsail container service.
A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.
You can deploy containers to your container service using container images from a public registry such as Amazon ECR Public, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.
createContainerServiceDeploymentRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateContainerServiceDeploymentResponse createContainerServiceDeployment(Consumer<CreateContainerServiceDeploymentRequest.Builder> createContainerServiceDeploymentRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates a deployment for your Amazon Lightsail container service.
A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.
You can deploy containers to your container service using container images from a public registry such as Amazon ECR Public, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the CreateContainerServiceDeploymentRequest.Builder
avoiding the need to create one manually via CreateContainerServiceDeploymentRequest.builder()
createContainerServiceDeploymentRequest - A Consumer that will call methods on
CreateContainerServiceDeploymentRequest.Builder to
create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateContainerServiceRegistryLoginResponse createContainerServiceRegistryLogin(CreateContainerServiceRegistryLoginRequest createContainerServiceRegistryLoginRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine. After you're logged in, you can use the native Docker commands to push your local container images to the container image registry of your Amazon Lightsail account so that you can use them with your Lightsail container service. The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials.
You can only push container images to the container service registry of your Lightsail account. You cannot pull container images or perform any other container image management actions on the container service registry.
After you push your container images to the container image registry of your Lightsail account, use the
RegisterContainerImage action to register the pushed images to a specific Lightsail container
service.
This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.
createContainerServiceRegistryLoginRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateContainerServiceRegistryLoginResponse createContainerServiceRegistryLogin(Consumer<CreateContainerServiceRegistryLoginRequest.Builder> createContainerServiceRegistryLoginRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine. After you're logged in, you can use the native Docker commands to push your local container images to the container image registry of your Amazon Lightsail account so that you can use them with your Lightsail container service. The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials.
You can only push container images to the container service registry of your Lightsail account. You cannot pull container images or perform any other container image management actions on the container service registry.
After you push your container images to the container image registry of your Lightsail account, use the
RegisterContainerImage action to register the pushed images to a specific Lightsail container
service.
This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the CreateContainerServiceRegistryLoginRequest.Builder
avoiding the need to create one manually via CreateContainerServiceRegistryLoginRequest.builder()
createContainerServiceRegistryLoginRequest - A Consumer that will call methods on
CreateContainerServiceRegistryLoginRequest.Builder
to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDiskResponse createDisk(CreateDiskRequest createDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates a block storage disk that can be attached to 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 Amazon Lightsail Developer Guide.
createDiskRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDiskResponse createDisk(Consumer<CreateDiskRequest.Builder> createDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates a block storage disk that can be attached to 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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the CreateDiskRequest.Builder avoiding the need to
create one manually via CreateDiskRequest.builder()
createDiskRequest - A Consumer that will call methods on
CreateDiskRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDiskFromSnapshotResponse createDiskFromSnapshot(CreateDiskFromSnapshotRequest createDiskFromSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates a block storage disk from a 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 Amazon Lightsail Developer Guide.
createDiskFromSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDiskFromSnapshotResponse createDiskFromSnapshot(Consumer<CreateDiskFromSnapshotRequest.Builder> createDiskFromSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates a block storage disk from a 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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the CreateDiskFromSnapshotRequest.Builder avoiding the
need to create one manually via CreateDiskFromSnapshotRequest.builder()
createDiskFromSnapshotRequest - A Consumer that will call methods on
CreateDiskFromSnapshotRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDiskSnapshotResponse createDiskSnapshot(CreateDiskSnapshotRequest createDiskSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.
You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending.
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 Amazon Lightsail Developer Guide.
createDiskSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDiskSnapshotResponse createDiskSnapshot(Consumer<CreateDiskSnapshotRequest.Builder> createDiskSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.
You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending.
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the CreateDiskSnapshotRequest.Builder avoiding the
need to create one manually via CreateDiskSnapshotRequest.builder()
createDiskSnapshotRequest - A Consumer that will call methods on
CreateDiskSnapshotRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDistributionResponse createDistribution(CreateDistributionRequest createDistributionRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates an Amazon Lightsail content delivery network (CDN) distribution.
A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance. For more information, see Content delivery networks in Amazon Lightsail.
createDistributionRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDistributionResponse createDistribution(Consumer<CreateDistributionRequest.Builder> createDistributionRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates an Amazon Lightsail content delivery network (CDN) distribution.
A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance. For more information, see Content delivery networks in Amazon Lightsail.
This is a convenience which creates an instance of the CreateDistributionRequest.Builder avoiding the
need to create one manually via CreateDistributionRequest.builder()
createDistributionRequest - A Consumer that will call methods on
CreateDistributionRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDomainResponse createDomain(CreateDomainRequest createDomainRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates a domain resource for the specified domain (e.g., example.com).
The create domain operation supports tag-based access control via request tags. For more
information, see the Amazon Lightsail Developer Guide.
createDomainRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDomainResponse createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates a domain resource for the specified domain (e.g., example.com).
The create domain operation supports tag-based access control via request tags. For more
information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the CreateDomainRequest.Builder avoiding the need to
create one manually via CreateDomainRequest.builder()
createDomainRequest - A Consumer that will call methods on
CreateDomainRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDomainEntryResponse createDomainEntry(CreateDomainEntryRequest createDomainEntryRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates one of the following domain name system (DNS) records in a domain DNS zone: 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 Amazon Lightsail Developer Guide.
createDomainEntryRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDomainEntryResponse createDomainEntry(Consumer<CreateDomainEntryRequest.Builder> createDomainEntryRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates one of the following domain name system (DNS) records in a domain DNS zone: 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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the CreateDomainEntryRequest.Builder avoiding the need
to create one manually via CreateDomainEntryRequest.builder()
createDomainEntryRequest - A Consumer that will call methods on
CreateDomainEntryRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateGuiSessionAccessDetailsResponse createGUISessionAccessDetails(CreateGuiSessionAccessDetailsRequest createGuiSessionAccessDetailsRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session. The primary URL initiates a web-based NICE DCV session to the virtual computer's application. The secondary URL initiates a web-based NICE DCV session to the virtual computer's operating session.
Use StartGUISession to open the session.
createGuiSessionAccessDetailsRequest - AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateGuiSessionAccessDetailsResponse createGUISessionAccessDetails(Consumer<CreateGuiSessionAccessDetailsRequest.Builder> createGuiSessionAccessDetailsRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session. The primary URL initiates a web-based NICE DCV session to the virtual computer's application. The secondary URL initiates a web-based NICE DCV session to the virtual computer's operating session.
Use StartGUISession to open the session.
This is a convenience which creates an instance of the CreateGuiSessionAccessDetailsRequest.Builder
avoiding the need to create one manually via CreateGuiSessionAccessDetailsRequest.builder()
createGuiSessionAccessDetailsRequest - A Consumer that will call methods on
CreateGuiSessionAccessDetailsRequest.Builder to
create a request.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateInstanceSnapshotResponse createInstanceSnapshot(CreateInstanceSnapshotRequest createInstanceSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates a snapshot of a specific virtual private server, or instance. You can use a snapshot to create a new instance that is based on that snapshot.
The create instance snapshot operation supports tag-based access control via request tags. For more
information, see the Amazon Lightsail Developer Guide.
createInstanceSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateInstanceSnapshotResponse createInstanceSnapshot(Consumer<CreateInstanceSnapshotRequest.Builder> createInstanceSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates a snapshot of a specific virtual private server, or instance. You can use a snapshot to create a new instance that is based on that snapshot.
The create instance snapshot operation supports tag-based access control via request tags. For more
information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the CreateInstanceSnapshotRequest.Builder avoiding the
need to create one manually via CreateInstanceSnapshotRequest.builder()
createInstanceSnapshotRequest - A Consumer that will call methods on
CreateInstanceSnapshotRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateInstancesResponse createInstances(CreateInstancesRequest createInstancesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates one or more Amazon Lightsail instances.
The create instances operation supports tag-based access control via request tags. For more
information, see the Lightsail Developer Guide.
createInstancesRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateInstancesResponse createInstances(Consumer<CreateInstancesRequest.Builder> createInstancesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates one or more Amazon Lightsail instances.
The create instances operation supports tag-based access control via request tags. For more
information, see the Lightsail Developer Guide.
This is a convenience which creates an instance of the CreateInstancesRequest.Builder avoiding the need
to create one manually via CreateInstancesRequest.builder()
createInstancesRequest - A Consumer that will call methods on
CreateInstancesRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateInstancesFromSnapshotResponse createInstancesFromSnapshot(CreateInstancesFromSnapshotRequest createInstancesFromSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
createInstancesFromSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateInstancesFromSnapshotResponse createInstancesFromSnapshot(Consumer<CreateInstancesFromSnapshotRequest.Builder> createInstancesFromSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the CreateInstancesFromSnapshotRequest.Builder
avoiding the need to create one manually via CreateInstancesFromSnapshotRequest.builder()
createInstancesFromSnapshotRequest - A Consumer that will call methods on
CreateInstancesFromSnapshotRequest.Builder to
create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateKeyPairResponse createKeyPair(CreateKeyPairRequest createKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.
Use the DownloadDefaultKeyPair action to create a Lightsail default key pair in an Amazon Web Services Region where a default key pair does not currently exist.
The create key pair operation supports tag-based access control via request tags. For more
information, see the Amazon Lightsail Developer Guide.
createKeyPairRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateKeyPairResponse createKeyPair(Consumer<CreateKeyPairRequest.Builder> createKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.
Use the DownloadDefaultKeyPair action to create a Lightsail default key pair in an Amazon Web Services Region where a default key pair does not currently exist.
The create key pair operation supports tag-based access control via request tags. For more
information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the CreateKeyPairRequest.Builder avoiding the need to
create one manually via CreateKeyPairRequest.builder()
createKeyPairRequest - A Consumer that will call methods on
CreateKeyPairRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLoadBalancerResponse createLoadBalancer(CreateLoadBalancerRequest createLoadBalancerRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
createLoadBalancerRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLoadBalancerResponse createLoadBalancer(Consumer<CreateLoadBalancerRequest.Builder> createLoadBalancerRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the CreateLoadBalancerRequest.Builder avoiding the
need to create one manually via CreateLoadBalancerRequest.builder()
createLoadBalancerRequest - A Consumer that will call methods on
CreateLoadBalancerRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLoadBalancerTlsCertificateResponse createLoadBalancerTlsCertificate(CreateLoadBalancerTlsCertificateRequest createLoadBalancerTlsCertificateRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.
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 Amazon Lightsail Developer Guide.
createLoadBalancerTlsCertificateRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLoadBalancerTlsCertificateResponse createLoadBalancerTlsCertificate(Consumer<CreateLoadBalancerTlsCertificateRequest.Builder> createLoadBalancerTlsCertificateRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the CreateLoadBalancerTlsCertificateRequest.Builder
avoiding the need to create one manually via CreateLoadBalancerTlsCertificateRequest.builder()
createLoadBalancerTlsCertificateRequest - A Consumer that will call methods on
CreateLoadBalancerTlsCertificateRequest.Builder to
create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateRelationalDatabaseResponse createRelationalDatabase(CreateRelationalDatabaseRequest createRelationalDatabaseRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
createRelationalDatabaseRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateRelationalDatabaseResponse createRelationalDatabase(Consumer<CreateRelationalDatabaseRequest.Builder> createRelationalDatabaseRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the CreateRelationalDatabaseRequest.Builder avoiding
the need to create one manually via CreateRelationalDatabaseRequest.builder()
createRelationalDatabaseRequest - A Consumer that will call methods on
CreateRelationalDatabaseRequest.Builder to create
a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateRelationalDatabaseFromSnapshotResponse createRelationalDatabaseFromSnapshot(CreateRelationalDatabaseFromSnapshotRequest createRelationalDatabaseFromSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
createRelationalDatabaseFromSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateRelationalDatabaseFromSnapshotResponse createRelationalDatabaseFromSnapshot(Consumer<CreateRelationalDatabaseFromSnapshotRequest.Builder> createRelationalDatabaseFromSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the
CreateRelationalDatabaseFromSnapshotRequest.Builder avoiding the need to create one manually via
CreateRelationalDatabaseFromSnapshotRequest.builder()
createRelationalDatabaseFromSnapshotRequest - A Consumer that will call methods on
CreateRelationalDatabaseFromSnapshotRequest.Builder
to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateRelationalDatabaseSnapshotResponse createRelationalDatabaseSnapshot(CreateRelationalDatabaseSnapshotRequest createRelationalDatabaseSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
createRelationalDatabaseSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateRelationalDatabaseSnapshotResponse createRelationalDatabaseSnapshot(Consumer<CreateRelationalDatabaseSnapshotRequest.Builder> createRelationalDatabaseSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the CreateRelationalDatabaseSnapshotRequest.Builder
avoiding the need to create one manually via CreateRelationalDatabaseSnapshotRequest.builder()
createRelationalDatabaseSnapshotRequest - A Consumer that will call methods on
CreateRelationalDatabaseSnapshotRequest.Builder to
create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteAlarmResponse deleteAlarm(DeleteAlarmRequest deleteAlarmRequest) throws ServiceException, InvalidInputException, OperationFailureException, UnauthenticatedException, AccessDeniedException, NotFoundException, AwsServiceException, SdkClientException, LightsailException
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.
deleteAlarmRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteAlarmResponse deleteAlarm(Consumer<DeleteAlarmRequest.Builder> deleteAlarmRequest) throws ServiceException, InvalidInputException, OperationFailureException, UnauthenticatedException, AccessDeniedException, NotFoundException, AwsServiceException, SdkClientException, LightsailException
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.
This is a convenience which creates an instance of the DeleteAlarmRequest.Builder avoiding the need to
create one manually via DeleteAlarmRequest.builder()
deleteAlarmRequest - A Consumer that will call methods on
DeleteAlarmRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteAutoSnapshotResponse deleteAutoSnapshot(DeleteAutoSnapshotRequest deleteAutoSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide.
deleteAutoSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteAutoSnapshotResponse deleteAutoSnapshot(Consumer<DeleteAutoSnapshotRequest.Builder> deleteAutoSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the DeleteAutoSnapshotRequest.Builder avoiding the
need to create one manually via DeleteAutoSnapshotRequest.builder()
deleteAutoSnapshotRequest - A Consumer that will call methods on
DeleteAutoSnapshotRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteBucketResponse deleteBucket(DeleteBucketRequest deleteBucketRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes a Amazon Lightsail bucket.
When you delete your bucket, the bucket name is released and can be reused for a new bucket in your account or another Amazon Web Services account.
deleteBucketRequest - AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteBucketResponse deleteBucket(Consumer<DeleteBucketRequest.Builder> deleteBucketRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes a Amazon Lightsail bucket.
When you delete your bucket, the bucket name is released and can be reused for a new bucket in your account or another Amazon Web Services account.
This is a convenience which creates an instance of the DeleteBucketRequest.Builder avoiding the need to
create one manually via DeleteBucketRequest.builder()
deleteBucketRequest - A Consumer that will call methods on
DeleteBucketRequest.Builder to create a request.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteBucketAccessKeyResponse deleteBucketAccessKey(DeleteBucketAccessKeyRequest deleteBucketAccessKeyRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes an access key for the specified Amazon Lightsail bucket.
We recommend that you delete an access key if the secret access key is compromised.
For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.
deleteBucketAccessKeyRequest - AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteBucketAccessKeyResponse deleteBucketAccessKey(Consumer<DeleteBucketAccessKeyRequest.Builder> deleteBucketAccessKeyRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes an access key for the specified Amazon Lightsail bucket.
We recommend that you delete an access key if the secret access key is compromised.
For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the DeleteBucketAccessKeyRequest.Builder avoiding the
need to create one manually via DeleteBucketAccessKeyRequest.builder()
deleteBucketAccessKeyRequest - A Consumer that will call methods on
DeleteBucketAccessKeyRequest.Builder to create a
request.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteCertificateResponse deleteCertificate(DeleteCertificateRequest deleteCertificateRequest) throws ServiceException, InvalidInputException, AccessDeniedException, NotFoundException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.
Certificates that are currently attached to a distribution cannot be deleted. Use the
DetachCertificateFromDistribution action to detach a certificate from a distribution.
deleteCertificateRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
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.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteCertificateResponse deleteCertificate(Consumer<DeleteCertificateRequest.Builder> deleteCertificateRequest) throws ServiceException, InvalidInputException, AccessDeniedException, NotFoundException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.
Certificates that are currently attached to a distribution cannot be deleted. Use the
DetachCertificateFromDistribution action to detach a certificate from a distribution.
This is a convenience which creates an instance of the DeleteCertificateRequest.Builder avoiding the need
to create one manually via DeleteCertificateRequest.builder()
deleteCertificateRequest - A Consumer that will call methods on
DeleteCertificateRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
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.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteContactMethodResponse deleteContactMethod(DeleteContactMethodRequest deleteContactMethodRequest) throws ServiceException, InvalidInputException, OperationFailureException, UnauthenticatedException, AccessDeniedException, NotFoundException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
deleteContactMethodRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteContactMethodResponse deleteContactMethod(Consumer<DeleteContactMethodRequest.Builder> deleteContactMethodRequest) throws ServiceException, InvalidInputException, OperationFailureException, UnauthenticatedException, AccessDeniedException, NotFoundException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
This is a convenience which creates an instance of the DeleteContactMethodRequest.Builder avoiding the
need to create one manually via DeleteContactMethodRequest.builder()
deleteContactMethodRequest - A Consumer that will call methods on
DeleteContactMethodRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteContainerImageResponse deleteContainerImage(DeleteContainerImageRequest deleteContainerImageRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes a container image that is registered to your Amazon Lightsail container service.
deleteContainerImageRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteContainerImageResponse deleteContainerImage(Consumer<DeleteContainerImageRequest.Builder> deleteContainerImageRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes a container image that is registered to your Amazon Lightsail container service.
This is a convenience which creates an instance of the DeleteContainerImageRequest.Builder avoiding the
need to create one manually via DeleteContainerImageRequest.builder()
deleteContainerImageRequest - A Consumer that will call methods on
DeleteContainerImageRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteContainerServiceResponse deleteContainerService(DeleteContainerServiceRequest deleteContainerServiceRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes your Amazon Lightsail container service.
deleteContainerServiceRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteContainerServiceResponse deleteContainerService(Consumer<DeleteContainerServiceRequest.Builder> deleteContainerServiceRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes your Amazon Lightsail container service.
This is a convenience which creates an instance of the DeleteContainerServiceRequest.Builder avoiding the
need to create one manually via DeleteContainerServiceRequest.builder()
deleteContainerServiceRequest - A Consumer that will call methods on
DeleteContainerServiceRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDiskResponse deleteDisk(DeleteDiskRequest deleteDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes the specified block storage disk. The disk must be in the available state (not attached to a
Lightsail instance).
The disk may remain in the deleting state for several minutes.
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 Amazon Lightsail Developer Guide.
deleteDiskRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDiskResponse deleteDisk(Consumer<DeleteDiskRequest.Builder> deleteDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes the specified block storage disk. The disk must be in the available state (not attached to a
Lightsail instance).
The disk may remain in the deleting state for several minutes.
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the DeleteDiskRequest.Builder avoiding the need to
create one manually via DeleteDiskRequest.builder()
deleteDiskRequest - A Consumer that will call methods on
DeleteDiskRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDiskSnapshotResponse deleteDiskSnapshot(DeleteDiskSnapshotRequest deleteDiskSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes the specified disk snapshot.
When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk.
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 Amazon Lightsail Developer Guide.
deleteDiskSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDiskSnapshotResponse deleteDiskSnapshot(Consumer<DeleteDiskSnapshotRequest.Builder> deleteDiskSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes the specified disk snapshot.
When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk.
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the DeleteDiskSnapshotRequest.Builder avoiding the
need to create one manually via DeleteDiskSnapshotRequest.builder()
deleteDiskSnapshotRequest - A Consumer that will call methods on
DeleteDiskSnapshotRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDistributionResponse deleteDistribution(DeleteDistributionRequest deleteDistributionRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes your Amazon Lightsail content delivery network (CDN) distribution.
deleteDistributionRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDistributionResponse deleteDistribution(Consumer<DeleteDistributionRequest.Builder> deleteDistributionRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes your Amazon Lightsail content delivery network (CDN) distribution.
This is a convenience which creates an instance of the DeleteDistributionRequest.Builder avoiding the
need to create one manually via DeleteDistributionRequest.builder()
deleteDistributionRequest - A Consumer that will call methods on
DeleteDistributionRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDomainResponse deleteDomain(DeleteDomainRequest deleteDomainRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes the specified domain recordset and all of its domain records.
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 Amazon Lightsail Developer Guide.
deleteDomainRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDomainResponse deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes the specified domain recordset and all of its domain records.
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the DeleteDomainRequest.Builder avoiding the need to
create one manually via DeleteDomainRequest.builder()
deleteDomainRequest - A Consumer that will call methods on
DeleteDomainRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDomainEntryResponse deleteDomainEntry(DeleteDomainEntryRequest deleteDomainEntryRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes a specific domain entry.
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 Amazon Lightsail Developer Guide.
deleteDomainEntryRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDomainEntryResponse deleteDomainEntry(Consumer<DeleteDomainEntryRequest.Builder> deleteDomainEntryRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes a specific domain entry.
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the DeleteDomainEntryRequest.Builder avoiding the need
to create one manually via DeleteDomainEntryRequest.builder()
deleteDomainEntryRequest - A Consumer that will call methods on
DeleteDomainEntryRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteInstanceResponse deleteInstance(DeleteInstanceRequest deleteInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes 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 Amazon Lightsail Developer Guide.
deleteInstanceRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteInstanceResponse deleteInstance(Consumer<DeleteInstanceRequest.Builder> deleteInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes 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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the DeleteInstanceRequest.Builder avoiding the need to
create one manually via DeleteInstanceRequest.builder()
deleteInstanceRequest - A Consumer that will call methods on
DeleteInstanceRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteInstanceSnapshotResponse deleteInstanceSnapshot(DeleteInstanceSnapshotRequest deleteInstanceSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes a specific snapshot of a virtual private server (or instance).
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 Amazon Lightsail Developer Guide.
deleteInstanceSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteInstanceSnapshotResponse deleteInstanceSnapshot(Consumer<DeleteInstanceSnapshotRequest.Builder> deleteInstanceSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes a specific snapshot of a virtual private server (or instance).
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the DeleteInstanceSnapshotRequest.Builder avoiding the
need to create one manually via DeleteInstanceSnapshotRequest.builder()
deleteInstanceSnapshotRequest - A Consumer that will call methods on
DeleteInstanceSnapshotRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteKeyPairResponse deleteKeyPair(DeleteKeyPairRequest deleteKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes the specified key pair by removing the public key from Amazon Lightsail.
You can delete key pairs that were created using the ImportKeyPair and CreateKeyPair actions, as well as the Lightsail default key pair. A new default key pair will not be created unless you launch an instance without specifying a custom key pair, or you call the DownloadDefaultKeyPair API.
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 Amazon Lightsail Developer Guide.
deleteKeyPairRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteKeyPairResponse deleteKeyPair(Consumer<DeleteKeyPairRequest.Builder> deleteKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes the specified key pair by removing the public key from Amazon Lightsail.
You can delete key pairs that were created using the ImportKeyPair and CreateKeyPair actions, as well as the Lightsail default key pair. A new default key pair will not be created unless you launch an instance without specifying a custom key pair, or you call the DownloadDefaultKeyPair API.
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the DeleteKeyPairRequest.Builder avoiding the need to
create one manually via DeleteKeyPairRequest.builder()
deleteKeyPairRequest - A Consumer that will call methods on
DeleteKeyPairRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteKnownHostKeysResponse deleteKnownHostKeys(DeleteKnownHostKeysRequest deleteKnownHostKeysRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
deleteKnownHostKeysRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteKnownHostKeysResponse deleteKnownHostKeys(Consumer<DeleteKnownHostKeysRequest.Builder> deleteKnownHostKeysRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
This is a convenience which creates an instance of the DeleteKnownHostKeysRequest.Builder avoiding the
need to create one manually via DeleteKnownHostKeysRequest.builder()
deleteKnownHostKeysRequest - A Consumer that will call methods on
DeleteKnownHostKeysRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteLoadBalancerResponse deleteLoadBalancer(DeleteLoadBalancerRequest deleteLoadBalancerRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
deleteLoadBalancerRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteLoadBalancerResponse deleteLoadBalancer(Consumer<DeleteLoadBalancerRequest.Builder> deleteLoadBalancerRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the DeleteLoadBalancerRequest.Builder avoiding the
need to create one manually via DeleteLoadBalancerRequest.builder()
deleteLoadBalancerRequest - A Consumer that will call methods on
DeleteLoadBalancerRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteLoadBalancerTlsCertificateResponse deleteLoadBalancerTlsCertificate(DeleteLoadBalancerTlsCertificateRequest deleteLoadBalancerTlsCertificateRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
deleteLoadBalancerTlsCertificateRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteLoadBalancerTlsCertificateResponse deleteLoadBalancerTlsCertificate(Consumer<DeleteLoadBalancerTlsCertificateRequest.Builder> deleteLoadBalancerTlsCertificateRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the DeleteLoadBalancerTlsCertificateRequest.Builder
avoiding the need to create one manually via DeleteLoadBalancerTlsCertificateRequest.builder()
deleteLoadBalancerTlsCertificateRequest - A Consumer that will call methods on
DeleteLoadBalancerTlsCertificateRequest.Builder to
create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteRelationalDatabaseResponse deleteRelationalDatabase(DeleteRelationalDatabaseRequest deleteRelationalDatabaseRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
deleteRelationalDatabaseRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteRelationalDatabaseResponse deleteRelationalDatabase(Consumer<DeleteRelationalDatabaseRequest.Builder> deleteRelationalDatabaseRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the DeleteRelationalDatabaseRequest.Builder avoiding
the need to create one manually via DeleteRelationalDatabaseRequest.builder()
deleteRelationalDatabaseRequest - A Consumer that will call methods on
DeleteRelationalDatabaseRequest.Builder to create
a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteRelationalDatabaseSnapshotResponse deleteRelationalDatabaseSnapshot(DeleteRelationalDatabaseSnapshotRequest deleteRelationalDatabaseSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
deleteRelationalDatabaseSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteRelationalDatabaseSnapshotResponse deleteRelationalDatabaseSnapshot(Consumer<DeleteRelationalDatabaseSnapshotRequest.Builder> deleteRelationalDatabaseSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the DeleteRelationalDatabaseSnapshotRequest.Builder
avoiding the need to create one manually via DeleteRelationalDatabaseSnapshotRequest.builder()
deleteRelationalDatabaseSnapshotRequest - A Consumer that will call methods on
DeleteRelationalDatabaseSnapshotRequest.Builder to
create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DetachCertificateFromDistributionResponse detachCertificateFromDistribution(DetachCertificateFromDistributionRequest detachCertificateFromDistributionRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.
After the certificate is detached, your distribution stops accepting traffic for all of the domains that are associated with the certificate.
detachCertificateFromDistributionRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DetachCertificateFromDistributionResponse detachCertificateFromDistribution(Consumer<DetachCertificateFromDistributionRequest.Builder> detachCertificateFromDistributionRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.
After the certificate is detached, your distribution stops accepting traffic for all of the domains that are associated with the certificate.
This is a convenience which creates an instance of the DetachCertificateFromDistributionRequest.Builder
avoiding the need to create one manually via DetachCertificateFromDistributionRequest.builder()
detachCertificateFromDistributionRequest - A Consumer that will call methods on
DetachCertificateFromDistributionRequest.Builder
to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DetachDiskResponse detachDisk(DetachDiskRequest detachDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk.
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 Amazon Lightsail Developer Guide.
detachDiskRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DetachDiskResponse detachDisk(Consumer<DetachDiskRequest.Builder> detachDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk.
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the DetachDiskRequest.Builder avoiding the need to
create one manually via DetachDiskRequest.builder()
detachDiskRequest - A Consumer that will call methods on
DetachDiskRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DetachInstancesFromLoadBalancerResponse detachInstancesFromLoadBalancer(DetachInstancesFromLoadBalancerRequest detachInstancesFromLoadBalancerRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon
Lightsail Developer Guide.
detachInstancesFromLoadBalancerRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DetachInstancesFromLoadBalancerResponse detachInstancesFromLoadBalancer(Consumer<DetachInstancesFromLoadBalancerRequest.Builder> detachInstancesFromLoadBalancerRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon
Lightsail Developer Guide.
This is a convenience which creates an instance of the DetachInstancesFromLoadBalancerRequest.Builder
avoiding the need to create one manually via DetachInstancesFromLoadBalancerRequest.builder()
detachInstancesFromLoadBalancerRequest - A Consumer that will call methods on
DetachInstancesFromLoadBalancerRequest.Builder to
create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DetachStaticIpResponse detachStaticIp(DetachStaticIpRequest detachStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
detachStaticIpRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DetachStaticIpResponse detachStaticIp(Consumer<DetachStaticIpRequest.Builder> detachStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
This is a convenience which creates an instance of the DetachStaticIpRequest.Builder avoiding the need to
create one manually via DetachStaticIpRequest.builder()
detachStaticIpRequest - A Consumer that will call methods on
DetachStaticIpRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisableAddOnResponse disableAddOn(DisableAddOnRequest disableAddOnRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Disables an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.
disableAddOnRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisableAddOnResponse disableAddOn(Consumer<DisableAddOnRequest.Builder> disableAddOnRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Disables an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the DisableAddOnRequest.Builder avoiding the need to
create one manually via DisableAddOnRequest.builder()
disableAddOnRequest - A Consumer that will call methods on
DisableAddOnRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DownloadDefaultKeyPairResponse downloadDefaultKeyPair(DownloadDefaultKeyPairRequest downloadDefaultKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Downloads the regional Amazon Lightsail default key pair.
This action also creates a Lightsail default key pair if a default key pair does not currently exist in the Amazon Web Services Region.
downloadDefaultKeyPairRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DownloadDefaultKeyPairResponse downloadDefaultKeyPair(Consumer<DownloadDefaultKeyPairRequest.Builder> downloadDefaultKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Downloads the regional Amazon Lightsail default key pair.
This action also creates a Lightsail default key pair if a default key pair does not currently exist in the Amazon Web Services Region.
This is a convenience which creates an instance of the DownloadDefaultKeyPairRequest.Builder avoiding the
need to create one manually via DownloadDefaultKeyPairRequest.builder()
downloadDefaultKeyPairRequest - A Consumer that will call methods on
DownloadDefaultKeyPairRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DownloadDefaultKeyPairResponse downloadDefaultKeyPair() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Downloads the regional Amazon Lightsail default key pair.
This action also creates a Lightsail default key pair if a default key pair does not currently exist in the Amazon Web Services Region.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondownloadDefaultKeyPair(DownloadDefaultKeyPairRequest),
AWS API Documentationdefault EnableAddOnResponse enableAddOn(EnableAddOnRequest enableAddOnRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.
enableAddOnRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault EnableAddOnResponse enableAddOn(Consumer<EnableAddOnRequest.Builder> enableAddOnRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the EnableAddOnRequest.Builder avoiding the need to
create one manually via EnableAddOnRequest.builder()
enableAddOnRequest - A Consumer that will call methods on
EnableAddOnRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ExportSnapshotResponse exportSnapshot(ExportSnapshotRequest exportSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
Use the get instance snapshots or get disk snapshots operations to get a list of
snapshots that you can export to Amazon EC2.
exportSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ExportSnapshotResponse exportSnapshot(Consumer<ExportSnapshotRequest.Builder> exportSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
Use the get instance snapshots or get disk snapshots operations to get a list of
snapshots that you can export to Amazon EC2.
This is a convenience which creates an instance of the ExportSnapshotRequest.Builder avoiding the need to
create one manually via ExportSnapshotRequest.builder()
exportSnapshotRequest - A Consumer that will call methods on
ExportSnapshotRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetActiveNamesResponse getActiveNames(GetActiveNamesRequest getActiveNamesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the names of all active (not deleted) resources.
getActiveNamesRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetActiveNamesResponse getActiveNames(Consumer<GetActiveNamesRequest.Builder> getActiveNamesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the names of all active (not deleted) resources.
This is a convenience which creates an instance of the GetActiveNamesRequest.Builder avoiding the need to
create one manually via GetActiveNamesRequest.builder()
getActiveNamesRequest - A Consumer that will call methods on
GetActiveNamesRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetActiveNamesResponse getActiveNames() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the names of all active (not deleted) resources.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetActiveNames(GetActiveNamesRequest),
AWS API
Documentationdefault GetAlarmsResponse getAlarms(GetAlarmsRequest getAlarmsRequest) throws ServiceException, InvalidInputException, OperationFailureException, UnauthenticatedException, AccessDeniedException, NotFoundException, AwsServiceException, SdkClientException, LightsailException
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.
getAlarmsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAlarmsResponse getAlarms(Consumer<GetAlarmsRequest.Builder> getAlarmsRequest) throws ServiceException, InvalidInputException, OperationFailureException, UnauthenticatedException, AccessDeniedException, NotFoundException, AwsServiceException, SdkClientException, LightsailException
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.
This is a convenience which creates an instance of the GetAlarmsRequest.Builder avoiding the need to
create one manually via GetAlarmsRequest.builder()
getAlarmsRequest - A Consumer that will call methods on
GetAlarmsRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAutoSnapshotsResponse getAutoSnapshots(GetAutoSnapshotsRequest getAutoSnapshotsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the available automatic snapshots for an instance or disk. For more information, see the Amazon Lightsail Developer Guide.
getAutoSnapshotsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAutoSnapshotsResponse getAutoSnapshots(Consumer<GetAutoSnapshotsRequest.Builder> getAutoSnapshotsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the available automatic snapshots for an instance or disk. For more information, see the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the GetAutoSnapshotsRequest.Builder avoiding the need
to create one manually via GetAutoSnapshotsRequest.builder()
getAutoSnapshotsRequest - A Consumer that will call methods on
GetAutoSnapshotsRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBlueprintsResponse getBlueprints(GetBlueprintsRequest getBlueprintsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the list of available instance images, or blueprints. You can use a blueprint to create a new 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.
getBlueprintsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBlueprintsResponse getBlueprints(Consumer<GetBlueprintsRequest.Builder> getBlueprintsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the list of available instance images, or blueprints. You can use a blueprint to create a new 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.
This is a convenience which creates an instance of the GetBlueprintsRequest.Builder avoiding the need to
create one manually via GetBlueprintsRequest.builder()
getBlueprintsRequest - A Consumer that will call methods on
GetBlueprintsRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBlueprintsResponse getBlueprints() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the list of available instance images, or blueprints. You can use a blueprint to create a new 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.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetBlueprints(GetBlueprintsRequest),
AWS API
Documentationdefault GetBucketAccessKeysResponse getBucketAccessKeys(GetBucketAccessKeysRequest getBucketAccessKeysRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the existing access key IDs for the specified Amazon Lightsail bucket.
This action does not return the secret access key value of an access key. You can get a secret access key only when you create it from the response of the CreateBucketAccessKey action. If you lose the secret access key, you must create a new access key.
getBucketAccessKeysRequest - AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBucketAccessKeysResponse getBucketAccessKeys(Consumer<GetBucketAccessKeysRequest.Builder> getBucketAccessKeysRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the existing access key IDs for the specified Amazon Lightsail bucket.
This action does not return the secret access key value of an access key. You can get a secret access key only when you create it from the response of the CreateBucketAccessKey action. If you lose the secret access key, you must create a new access key.
This is a convenience which creates an instance of the GetBucketAccessKeysRequest.Builder avoiding the
need to create one manually via GetBucketAccessKeysRequest.builder()
getBucketAccessKeysRequest - A Consumer that will call methods on
GetBucketAccessKeysRequest.Builder to create a
request.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBucketBundlesResponse getBucketBundles(GetBucketBundlesRequest getBucketBundlesRequest) throws AccessDeniedException, InvalidInputException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the bundles that you can apply to a Amazon Lightsail bucket.
The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a bucket.
Use the UpdateBucketBundle action to update the bundle for a bucket.
getBucketBundlesRequest - AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBucketBundlesResponse getBucketBundles(Consumer<GetBucketBundlesRequest.Builder> getBucketBundlesRequest) throws AccessDeniedException, InvalidInputException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the bundles that you can apply to a Amazon Lightsail bucket.
The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a bucket.
Use the UpdateBucketBundle action to update the bundle for a bucket.
This is a convenience which creates an instance of the GetBucketBundlesRequest.Builder avoiding the need
to create one manually via GetBucketBundlesRequest.builder()
getBucketBundlesRequest - A Consumer that will call methods on
GetBucketBundlesRequest.Builder to create a
request.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBucketMetricDataResponse getBucketMetricData(GetBucketMetricDataRequest getBucketMetricDataRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the data points of a specific metric for an Amazon Lightsail bucket.
Metrics report the utilization of a bucket. View and collect metric data regularly to monitor the number of objects stored in a bucket (including object versions) and the storage space used by those objects.
getBucketMetricDataRequest - AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBucketMetricDataResponse getBucketMetricData(Consumer<GetBucketMetricDataRequest.Builder> getBucketMetricDataRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the data points of a specific metric for an Amazon Lightsail bucket.
Metrics report the utilization of a bucket. View and collect metric data regularly to monitor the number of objects stored in a bucket (including object versions) and the storage space used by those objects.
This is a convenience which creates an instance of the GetBucketMetricDataRequest.Builder avoiding the
need to create one manually via GetBucketMetricDataRequest.builder()
getBucketMetricDataRequest - A Consumer that will call methods on
GetBucketMetricDataRequest.Builder to create a
request.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBucketsResponse getBuckets(GetBucketsRequest getBucketsRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about one or more Amazon Lightsail buckets. The information returned includes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account-level block public access feature for your Lightsail buckets.
For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.
getBucketsRequest - AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBucketsResponse getBuckets(Consumer<GetBucketsRequest.Builder> getBucketsRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about one or more Amazon Lightsail buckets. The information returned includes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account-level block public access feature for your Lightsail buckets.
For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the GetBucketsRequest.Builder avoiding the need to
create one manually via GetBucketsRequest.builder()
getBucketsRequest - A Consumer that will call methods on
GetBucketsRequest.Builder to create a request.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBundlesResponse getBundles(GetBundlesRequest getBundlesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the bundles that you can apply to an Amazon Lightsail instance when you create it.
A bundle describes the specifications of an instance, such as the monthly cost, amount of memory, the number of vCPUs, amount of storage space, and monthly network data transfer quota.
Bundles are referred to as instance plans in the Lightsail console.
getBundlesRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBundlesResponse getBundles(Consumer<GetBundlesRequest.Builder> getBundlesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the bundles that you can apply to an Amazon Lightsail instance when you create it.
A bundle describes the specifications of an instance, such as the monthly cost, amount of memory, the number of vCPUs, amount of storage space, and monthly network data transfer quota.
Bundles are referred to as instance plans in the Lightsail console.
This is a convenience which creates an instance of the GetBundlesRequest.Builder avoiding the need to
create one manually via GetBundlesRequest.builder()
getBundlesRequest - A Consumer that will call methods on
GetBundlesRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetBundlesResponse getBundles() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the bundles that you can apply to an Amazon Lightsail instance when you create it.
A bundle describes the specifications of an instance, such as the monthly cost, amount of memory, the number of vCPUs, amount of storage space, and monthly network data transfer quota.
Bundles are referred to as instance plans in the Lightsail console.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetBundles(GetBundlesRequest),
AWS API
Documentationdefault GetCertificatesResponse getCertificates(GetCertificatesRequest getCertificatesRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about one or more Amazon Lightsail SSL/TLS certificates.
To get a summary of a certificate, omit includeCertificateDetails from your request. The response
will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.
getCertificatesRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetCertificatesResponse getCertificates(Consumer<GetCertificatesRequest.Builder> getCertificatesRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about one or more Amazon Lightsail SSL/TLS certificates.
To get a summary of a certificate, omit includeCertificateDetails from your request. The response
will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.
This is a convenience which creates an instance of the GetCertificatesRequest.Builder avoiding the need
to create one manually via GetCertificatesRequest.builder()
getCertificatesRequest - A Consumer that will call methods on
GetCertificatesRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetCloudFormationStackRecordsResponse getCloudFormationStackRecords(GetCloudFormationStackRecordsRequest getCloudFormationStackRecordsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
getCloudFormationStackRecordsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetCloudFormationStackRecordsResponse getCloudFormationStackRecords(Consumer<GetCloudFormationStackRecordsRequest.Builder> getCloudFormationStackRecordsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
This is a convenience which creates an instance of the GetCloudFormationStackRecordsRequest.Builder
avoiding the need to create one manually via GetCloudFormationStackRecordsRequest.builder()
getCloudFormationStackRecordsRequest - A Consumer that will call methods on
GetCloudFormationStackRecordsRequest.Builder to
create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetCloudFormationStackRecordsResponse getCloudFormationStackRecords() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetCloudFormationStackRecords(GetCloudFormationStackRecordsRequest),
AWS API Documentationdefault GetContactMethodsResponse getContactMethods(GetContactMethodsRequest getContactMethodsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
getContactMethodsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetContactMethodsResponse getContactMethods(Consumer<GetContactMethodsRequest.Builder> getContactMethodsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
This is a convenience which creates an instance of the GetContactMethodsRequest.Builder avoiding the need
to create one manually via GetContactMethodsRequest.builder()
getContactMethodsRequest - A Consumer that will call methods on
GetContactMethodsRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetContainerApiMetadataResponse getContainerAPIMetadata(GetContainerApiMetadataRequest getContainerApiMetadataRequest) throws ServiceException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin.
getContainerApiMetadataRequest - ServiceException - A general service exception.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetContainerApiMetadataResponse getContainerAPIMetadata(Consumer<GetContainerApiMetadataRequest.Builder> getContainerApiMetadataRequest) throws ServiceException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin.
This is a convenience which creates an instance of the GetContainerApiMetadataRequest.Builder avoiding
the need to create one manually via GetContainerApiMetadataRequest.builder()
getContainerApiMetadataRequest - A Consumer that will call methods on
GetContainerApiMetadataRequest.Builder to create a
request.ServiceException - A general service exception.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetContainerImagesResponse getContainerImages(GetContainerImagesRequest getContainerImagesRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the container images that are registered to your Amazon Lightsail container service.
If you created a deployment on your Lightsail container service that uses container images from a public registry like Docker Hub, those images are not returned as part of this action. Those images are not registered to your Lightsail container service.
getContainerImagesRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetContainerImagesResponse getContainerImages(Consumer<GetContainerImagesRequest.Builder> getContainerImagesRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the container images that are registered to your Amazon Lightsail container service.
If you created a deployment on your Lightsail container service that uses container images from a public registry like Docker Hub, those images are not returned as part of this action. Those images are not registered to your Lightsail container service.
This is a convenience which creates an instance of the GetContainerImagesRequest.Builder avoiding the
need to create one manually via GetContainerImagesRequest.builder()
getContainerImagesRequest - A Consumer that will call methods on
GetContainerImagesRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetContainerLogResponse getContainerLog(GetContainerLogRequest getContainerLogRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the log events of a container of your Amazon Lightsail container service.
If your container service has more than one node (i.e., a scale greater than 1), then the log events that are returned for the specified container are merged from all nodes on your container service.
Container logs are retained for a certain amount of time. For more information, see Amazon Lightsail endpoints and quotas in the Amazon Web Services General Reference.
getContainerLogRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetContainerLogResponse getContainerLog(Consumer<GetContainerLogRequest.Builder> getContainerLogRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the log events of a container of your Amazon Lightsail container service.
If your container service has more than one node (i.e., a scale greater than 1), then the log events that are returned for the specified container are merged from all nodes on your container service.
Container logs are retained for a certain amount of time. For more information, see Amazon Lightsail endpoints and quotas in the Amazon Web Services General Reference.
This is a convenience which creates an instance of the GetContainerLogRequest.Builder avoiding the need
to create one manually via GetContainerLogRequest.builder()
getContainerLogRequest - A Consumer that will call methods on
GetContainerLogRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetContainerServiceDeploymentsResponse getContainerServiceDeployments(GetContainerServiceDeploymentsRequest getContainerServiceDeploymentsRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the deployments for your Amazon Lightsail container service
A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.
The deployments are ordered by version in ascending order. The newest version is listed at the top of the response.
A set number of deployments are kept before the oldest one is replaced with the newest one. For more information, see Amazon Lightsail endpoints and quotas in the Amazon Web Services General Reference.
getContainerServiceDeploymentsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetContainerServiceDeploymentsResponse getContainerServiceDeployments(Consumer<GetContainerServiceDeploymentsRequest.Builder> getContainerServiceDeploymentsRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the deployments for your Amazon Lightsail container service
A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.
The deployments are ordered by version in ascending order. The newest version is listed at the top of the response.
A set number of deployments are kept before the oldest one is replaced with the newest one. For more information, see Amazon Lightsail endpoints and quotas in the Amazon Web Services General Reference.
This is a convenience which creates an instance of the GetContainerServiceDeploymentsRequest.Builder
avoiding the need to create one manually via GetContainerServiceDeploymentsRequest.builder()
getContainerServiceDeploymentsRequest - A Consumer that will call methods on
GetContainerServiceDeploymentsRequest.Builder to
create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetContainerServiceMetricDataResponse getContainerServiceMetricData(GetContainerServiceMetricDataRequest getContainerServiceMetricDataRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the data points of a specific metric of your Amazon Lightsail container service.
Metrics report the utilization of your resources. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
getContainerServiceMetricDataRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetContainerServiceMetricDataResponse getContainerServiceMetricData(Consumer<GetContainerServiceMetricDataRequest.Builder> getContainerServiceMetricDataRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the data points of a specific metric of your Amazon Lightsail container service.
Metrics report the utilization of your resources. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
This is a convenience which creates an instance of the GetContainerServiceMetricDataRequest.Builder
avoiding the need to create one manually via GetContainerServiceMetricDataRequest.builder()
getContainerServiceMetricDataRequest - A Consumer that will call methods on
GetContainerServiceMetricDataRequest.Builder to
create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetContainerServicePowersResponse getContainerServicePowers(GetContainerServicePowersRequest getContainerServicePowersRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the list of powers that can be specified for your Amazon Lightsail container services.
The power specifies the amount of memory, the number of vCPUs, and the base price of the container service.
getContainerServicePowersRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetContainerServicePowersResponse getContainerServicePowers(Consumer<GetContainerServicePowersRequest.Builder> getContainerServicePowersRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the list of powers that can be specified for your Amazon Lightsail container services.
The power specifies the amount of memory, the number of vCPUs, and the base price of the container service.
This is a convenience which creates an instance of the GetContainerServicePowersRequest.Builder avoiding
the need to create one manually via GetContainerServicePowersRequest.builder()
getContainerServicePowersRequest - A Consumer that will call methods on
GetContainerServicePowersRequest.Builder to create
a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetContainerServicesResponse getContainerServices(GetContainerServicesRequest getContainerServicesRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about one or more of your Amazon Lightsail container services.
getContainerServicesRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetContainerServicesResponse getContainerServices(Consumer<GetContainerServicesRequest.Builder> getContainerServicesRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about one or more of your Amazon Lightsail container services.
This is a convenience which creates an instance of the GetContainerServicesRequest.Builder avoiding the
need to create one manually via GetContainerServicesRequest.builder()
getContainerServicesRequest - A Consumer that will call methods on
GetContainerServicesRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetCostEstimateResponse getCostEstimate(GetCostEstimateRequest getCostEstimateRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Retrieves information about the cost estimate for a specified resource. A cost estimate will not generate for a resource that has been deleted.
getCostEstimateRequest - AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetCostEstimateResponse getCostEstimate(Consumer<GetCostEstimateRequest.Builder> getCostEstimateRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Retrieves information about the cost estimate for a specified resource. A cost estimate will not generate for a resource that has been deleted.
This is a convenience which creates an instance of the GetCostEstimateRequest.Builder avoiding the need
to create one manually via GetCostEstimateRequest.builder()
getCostEstimateRequest - A Consumer that will call methods on
GetCostEstimateRequest.Builder to create a
request.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDiskResponse getDisk(GetDiskRequest getDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about a specific block storage disk.
getDiskRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDiskResponse getDisk(Consumer<GetDiskRequest.Builder> getDiskRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about a specific block storage disk.
This is a convenience which creates an instance of the GetDiskRequest.Builder avoiding the need to create
one manually via GetDiskRequest.builder()
getDiskRequest - A Consumer that will call methods on
GetDiskRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDiskSnapshotResponse getDiskSnapshot(GetDiskSnapshotRequest getDiskSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about a specific block storage disk snapshot.
getDiskSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDiskSnapshotResponse getDiskSnapshot(Consumer<GetDiskSnapshotRequest.Builder> getDiskSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about a specific block storage disk snapshot.
This is a convenience which creates an instance of the GetDiskSnapshotRequest.Builder avoiding the need
to create one manually via GetDiskSnapshotRequest.builder()
getDiskSnapshotRequest - A Consumer that will call methods on
GetDiskSnapshotRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDiskSnapshotsResponse getDiskSnapshots(GetDiskSnapshotsRequest getDiskSnapshotsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all block storage disk snapshots in your AWS account and region.
getDiskSnapshotsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDiskSnapshotsResponse getDiskSnapshots(Consumer<GetDiskSnapshotsRequest.Builder> getDiskSnapshotsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all block storage disk snapshots in your AWS account and region.
This is a convenience which creates an instance of the GetDiskSnapshotsRequest.Builder avoiding the need
to create one manually via GetDiskSnapshotsRequest.builder()
getDiskSnapshotsRequest - A Consumer that will call methods on
GetDiskSnapshotsRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDiskSnapshotsResponse getDiskSnapshots() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all block storage disk snapshots in your AWS account and region.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetDiskSnapshots(GetDiskSnapshotsRequest),
AWS
API Documentationdefault GetDisksResponse getDisks(GetDisksRequest getDisksRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all block storage disks in your AWS account and region.
getDisksRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDisksResponse getDisks(Consumer<GetDisksRequest.Builder> getDisksRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all block storage disks in your AWS account and region.
This is a convenience which creates an instance of the GetDisksRequest.Builder avoiding the need to
create one manually via GetDisksRequest.builder()
getDisksRequest - A Consumer that will call methods on
GetDisksRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDisksResponse getDisks() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all block storage disks in your AWS account and region.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetDisks(GetDisksRequest),
AWS API
Documentationdefault GetDistributionBundlesResponse getDistributionBundles(GetDistributionBundlesRequest getDistributionBundlesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the bundles that can be applied to your Amazon Lightsail content delivery network (CDN) distributions.
A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution.
getDistributionBundlesRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDistributionBundlesResponse getDistributionBundles(Consumer<GetDistributionBundlesRequest.Builder> getDistributionBundlesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the bundles that can be applied to your Amazon Lightsail content delivery network (CDN) distributions.
A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution.
This is a convenience which creates an instance of the GetDistributionBundlesRequest.Builder avoiding the
need to create one manually via GetDistributionBundlesRequest.builder()
getDistributionBundlesRequest - A Consumer that will call methods on
GetDistributionBundlesRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDistributionLatestCacheResetResponse getDistributionLatestCacheReset(GetDistributionLatestCacheResetRequest getDistributionLatestCacheResetRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution.
getDistributionLatestCacheResetRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDistributionLatestCacheResetResponse getDistributionLatestCacheReset(Consumer<GetDistributionLatestCacheResetRequest.Builder> getDistributionLatestCacheResetRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution.
This is a convenience which creates an instance of the GetDistributionLatestCacheResetRequest.Builder
avoiding the need to create one manually via GetDistributionLatestCacheResetRequest.builder()
getDistributionLatestCacheResetRequest - A Consumer that will call methods on
GetDistributionLatestCacheResetRequest.Builder to
create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDistributionMetricDataResponse getDistributionMetricData(GetDistributionMetricDataRequest getDistributionMetricDataRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.
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.
getDistributionMetricDataRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDistributionMetricDataResponse getDistributionMetricData(Consumer<GetDistributionMetricDataRequest.Builder> getDistributionMetricDataRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.
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.
This is a convenience which creates an instance of the GetDistributionMetricDataRequest.Builder avoiding
the need to create one manually via GetDistributionMetricDataRequest.builder()
getDistributionMetricDataRequest - A Consumer that will call methods on
GetDistributionMetricDataRequest.Builder to create
a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDistributionsResponse getDistributions(GetDistributionsRequest getDistributionsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.
getDistributionsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDistributionsResponse getDistributions(Consumer<GetDistributionsRequest.Builder> getDistributionsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.
This is a convenience which creates an instance of the GetDistributionsRequest.Builder avoiding the need
to create one manually via GetDistributionsRequest.builder()
getDistributionsRequest - A Consumer that will call methods on
GetDistributionsRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDomainResponse getDomain(GetDomainRequest getDomainRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about a specific domain recordset.
getDomainRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDomainResponse getDomain(Consumer<GetDomainRequest.Builder> getDomainRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about a specific domain recordset.
This is a convenience which creates an instance of the GetDomainRequest.Builder avoiding the need to
create one manually via GetDomainRequest.builder()
getDomainRequest - A Consumer that will call methods on
GetDomainRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDomainsResponse getDomains(GetDomainsRequest getDomainsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns a list of all domains in the user's account.
getDomainsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDomainsResponse getDomains(Consumer<GetDomainsRequest.Builder> getDomainsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns a list of all domains in the user's account.
This is a convenience which creates an instance of the GetDomainsRequest.Builder avoiding the need to
create one manually via GetDomainsRequest.builder()
getDomainsRequest - A Consumer that will call methods on
GetDomainsRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDomainsResponse getDomains() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns a list of all domains in the user's account.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetDomains(GetDomainsRequest),
AWS API
Documentationdefault GetExportSnapshotRecordsResponse getExportSnapshotRecords(GetExportSnapshotRecordsRequest getExportSnapshotRecordsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns all export snapshot records 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 CreateCloudFormationStack action.
getExportSnapshotRecordsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetExportSnapshotRecordsResponse getExportSnapshotRecords(Consumer<GetExportSnapshotRecordsRequest.Builder> getExportSnapshotRecordsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns all export snapshot records 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 CreateCloudFormationStack action.
This is a convenience which creates an instance of the GetExportSnapshotRecordsRequest.Builder avoiding
the need to create one manually via GetExportSnapshotRecordsRequest.builder()
getExportSnapshotRecordsRequest - A Consumer that will call methods on
GetExportSnapshotRecordsRequest.Builder to create
a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetExportSnapshotRecordsResponse getExportSnapshotRecords() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns all export snapshot records 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 CreateCloudFormationStack action.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetExportSnapshotRecords(GetExportSnapshotRecordsRequest),
AWS API Documentationdefault GetInstanceResponse getInstance(GetInstanceRequest getInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
getInstanceRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInstanceResponse getInstance(Consumer<GetInstanceRequest.Builder> getInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
This is a convenience which creates an instance of the GetInstanceRequest.Builder avoiding the need to
create one manually via GetInstanceRequest.builder()
getInstanceRequest - A Consumer that will call methods on
GetInstanceRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInstanceAccessDetailsResponse getInstanceAccessDetails(GetInstanceAccessDetailsRequest getInstanceAccessDetailsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
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 Amazon Lightsail Developer Guide.
getInstanceAccessDetailsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInstanceAccessDetailsResponse getInstanceAccessDetails(Consumer<GetInstanceAccessDetailsRequest.Builder> getInstanceAccessDetailsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the GetInstanceAccessDetailsRequest.Builder avoiding
the need to create one manually via GetInstanceAccessDetailsRequest.builder()
getInstanceAccessDetailsRequest - A Consumer that will call methods on
GetInstanceAccessDetailsRequest.Builder to create
a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInstanceMetricDataResponse getInstanceMetricData(GetInstanceMetricDataRequest getInstanceMetricDataRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
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.
getInstanceMetricDataRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInstanceMetricDataResponse getInstanceMetricData(Consumer<GetInstanceMetricDataRequest.Builder> getInstanceMetricDataRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
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.
This is a convenience which creates an instance of the GetInstanceMetricDataRequest.Builder avoiding the
need to create one manually via GetInstanceMetricDataRequest.builder()
getInstanceMetricDataRequest - A Consumer that will call methods on
GetInstanceMetricDataRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInstancePortStatesResponse getInstancePortStates(GetInstancePortStatesRequest getInstancePortStatesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the firewall port states for a specific Amazon Lightsail instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.
getInstancePortStatesRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInstancePortStatesResponse getInstancePortStates(Consumer<GetInstancePortStatesRequest.Builder> getInstancePortStatesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the firewall port states for a specific Amazon Lightsail instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.
This is a convenience which creates an instance of the GetInstancePortStatesRequest.Builder avoiding the
need to create one manually via GetInstancePortStatesRequest.builder()
getInstancePortStatesRequest - A Consumer that will call methods on
GetInstancePortStatesRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInstanceSnapshotResponse getInstanceSnapshot(GetInstanceSnapshotRequest getInstanceSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about a specific instance snapshot.
getInstanceSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInstanceSnapshotResponse getInstanceSnapshot(Consumer<GetInstanceSnapshotRequest.Builder> getInstanceSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about a specific instance snapshot.
This is a convenience which creates an instance of the GetInstanceSnapshotRequest.Builder avoiding the
need to create one manually via GetInstanceSnapshotRequest.builder()
getInstanceSnapshotRequest - A Consumer that will call methods on
GetInstanceSnapshotRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInstanceSnapshotsResponse getInstanceSnapshots(GetInstanceSnapshotsRequest getInstanceSnapshotsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns all instance snapshots for the user's account.
getInstanceSnapshotsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInstanceSnapshotsResponse getInstanceSnapshots(Consumer<GetInstanceSnapshotsRequest.Builder> getInstanceSnapshotsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns all instance snapshots for the user's account.
This is a convenience which creates an instance of the GetInstanceSnapshotsRequest.Builder avoiding the
need to create one manually via GetInstanceSnapshotsRequest.builder()
getInstanceSnapshotsRequest - A Consumer that will call methods on
GetInstanceSnapshotsRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInstanceSnapshotsResponse getInstanceSnapshots() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns all instance snapshots for the user's account.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetInstanceSnapshots(GetInstanceSnapshotsRequest),
AWS API Documentationdefault GetInstanceStateResponse getInstanceState(GetInstanceStateRequest getInstanceStateRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the state of a specific instance. Works on one instance at a time.
getInstanceStateRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInstanceStateResponse getInstanceState(Consumer<GetInstanceStateRequest.Builder> getInstanceStateRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the state of a specific instance. Works on one instance at a time.
This is a convenience which creates an instance of the GetInstanceStateRequest.Builder avoiding the need
to create one manually via GetInstanceStateRequest.builder()
getInstanceStateRequest - A Consumer that will call methods on
GetInstanceStateRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInstancesResponse getInstances(GetInstancesRequest getInstancesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all Amazon Lightsail virtual private servers, or instances.
getInstancesRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInstancesResponse getInstances(Consumer<GetInstancesRequest.Builder> getInstancesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all Amazon Lightsail virtual private servers, or instances.
This is a convenience which creates an instance of the GetInstancesRequest.Builder avoiding the need to
create one manually via GetInstancesRequest.builder()
getInstancesRequest - A Consumer that will call methods on
GetInstancesRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetInstancesResponse getInstances() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all Amazon Lightsail virtual private servers, or instances.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetInstances(GetInstancesRequest),
AWS API
Documentationdefault GetKeyPairResponse getKeyPair(GetKeyPairRequest getKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about a specific key pair.
getKeyPairRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetKeyPairResponse getKeyPair(Consumer<GetKeyPairRequest.Builder> getKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about a specific key pair.
This is a convenience which creates an instance of the GetKeyPairRequest.Builder avoiding the need to
create one manually via GetKeyPairRequest.builder()
getKeyPairRequest - A Consumer that will call methods on
GetKeyPairRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetKeyPairsResponse getKeyPairs(GetKeyPairsRequest getKeyPairsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all key pairs in the user's account.
getKeyPairsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetKeyPairsResponse getKeyPairs(Consumer<GetKeyPairsRequest.Builder> getKeyPairsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all key pairs in the user's account.
This is a convenience which creates an instance of the GetKeyPairsRequest.Builder avoiding the need to
create one manually via GetKeyPairsRequest.builder()
getKeyPairsRequest - A Consumer that will call methods on
GetKeyPairsRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetKeyPairsResponse getKeyPairs() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all key pairs in the user's account.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetKeyPairs(GetKeyPairsRequest),
AWS API
Documentationdefault GetLoadBalancerResponse getLoadBalancer(GetLoadBalancerRequest getLoadBalancerRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about the specified Lightsail load balancer.
getLoadBalancerRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLoadBalancerResponse getLoadBalancer(Consumer<GetLoadBalancerRequest.Builder> getLoadBalancerRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about the specified Lightsail load balancer.
This is a convenience which creates an instance of the GetLoadBalancerRequest.Builder avoiding the need
to create one manually via GetLoadBalancerRequest.builder()
getLoadBalancerRequest - A Consumer that will call methods on
GetLoadBalancerRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLoadBalancerMetricDataResponse getLoadBalancerMetricData(GetLoadBalancerMetricDataRequest getLoadBalancerMetricDataRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
getLoadBalancerMetricDataRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLoadBalancerMetricDataResponse getLoadBalancerMetricData(Consumer<GetLoadBalancerMetricDataRequest.Builder> getLoadBalancerMetricDataRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
This is a convenience which creates an instance of the GetLoadBalancerMetricDataRequest.Builder avoiding
the need to create one manually via GetLoadBalancerMetricDataRequest.builder()
getLoadBalancerMetricDataRequest - A Consumer that will call methods on
GetLoadBalancerMetricDataRequest.Builder to create
a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLoadBalancerTlsCertificatesResponse getLoadBalancerTlsCertificates(GetLoadBalancerTlsCertificatesRequest getLoadBalancerTlsCertificatesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
getLoadBalancerTlsCertificatesRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLoadBalancerTlsCertificatesResponse getLoadBalancerTlsCertificates(Consumer<GetLoadBalancerTlsCertificatesRequest.Builder> getLoadBalancerTlsCertificatesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
This is a convenience which creates an instance of the GetLoadBalancerTlsCertificatesRequest.Builder
avoiding the need to create one manually via GetLoadBalancerTlsCertificatesRequest.builder()
getLoadBalancerTlsCertificatesRequest - A Consumer that will call methods on
GetLoadBalancerTlsCertificatesRequest.Builder to
create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLoadBalancerTlsPoliciesResponse getLoadBalancerTlsPolicies(GetLoadBalancerTlsPoliciesRequest getLoadBalancerTlsPoliciesRequest) throws ServiceException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, InvalidInputException, AwsServiceException, SdkClientException, LightsailException
Returns a list of TLS security policies that you can apply to Lightsail load balancers.
For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide.
getLoadBalancerTlsPoliciesRequest - ServiceException - A general service exception.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLoadBalancerTlsPoliciesResponse getLoadBalancerTlsPolicies(Consumer<GetLoadBalancerTlsPoliciesRequest.Builder> getLoadBalancerTlsPoliciesRequest) throws ServiceException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, InvalidInputException, AwsServiceException, SdkClientException, LightsailException
Returns a list of TLS security policies that you can apply to Lightsail load balancers.
For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the GetLoadBalancerTlsPoliciesRequest.Builder avoiding
the need to create one manually via GetLoadBalancerTlsPoliciesRequest.builder()
getLoadBalancerTlsPoliciesRequest - A Consumer that will call methods on
GetLoadBalancerTlsPoliciesRequest.Builder to
create a request.ServiceException - A general service exception.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLoadBalancersResponse getLoadBalancers(GetLoadBalancersRequest getLoadBalancersRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all load balancers in an account.
getLoadBalancersRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLoadBalancersResponse getLoadBalancers(Consumer<GetLoadBalancersRequest.Builder> getLoadBalancersRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all load balancers in an account.
This is a convenience which creates an instance of the GetLoadBalancersRequest.Builder avoiding the need
to create one manually via GetLoadBalancersRequest.builder()
getLoadBalancersRequest - A Consumer that will call methods on
GetLoadBalancersRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLoadBalancersResponse getLoadBalancers() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all load balancers in an account.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetLoadBalancers(GetLoadBalancersRequest),
AWS
API Documentationdefault GetOperationResponse getOperation(GetOperationRequest getOperationRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about a specific operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on.
getOperationRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetOperationResponse getOperation(Consumer<GetOperationRequest.Builder> getOperationRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about a specific operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on.
This is a convenience which creates an instance of the GetOperationRequest.Builder avoiding the need to
create one manually via GetOperationRequest.builder()
getOperationRequest - A Consumer that will call methods on
GetOperationRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetOperationsResponse getOperations(GetOperationsRequest getOperationsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all operations.
Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each
subsequent call to GetOperations use the maximum (last) statusChangedAt value from the
previous request.
getOperationsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetOperationsResponse getOperations(Consumer<GetOperationsRequest.Builder> getOperationsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all operations.
Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each
subsequent call to GetOperations use the maximum (last) statusChangedAt value from the
previous request.
This is a convenience which creates an instance of the GetOperationsRequest.Builder avoiding the need to
create one manually via GetOperationsRequest.builder()
getOperationsRequest - A Consumer that will call methods on
GetOperationsRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetOperationsResponse getOperations() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all operations.
Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each
subsequent call to GetOperations use the maximum (last) statusChangedAt value from the
previous request.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetOperations(GetOperationsRequest),
AWS API
Documentationdefault GetOperationsForResourceResponse getOperationsForResource(GetOperationsForResourceRequest getOperationsForResourceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Gets operations for a specific resource (e.g., an instance or a static IP).
getOperationsForResourceRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetOperationsForResourceResponse getOperationsForResource(Consumer<GetOperationsForResourceRequest.Builder> getOperationsForResourceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Gets operations for a specific resource (e.g., an instance or a static IP).
This is a convenience which creates an instance of the GetOperationsForResourceRequest.Builder avoiding
the need to create one manually via GetOperationsForResourceRequest.builder()
getOperationsForResourceRequest - A Consumer that will call methods on
GetOperationsForResourceRequest.Builder to create
a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRegionsResponse getRegions(GetRegionsRequest getRegionsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns a list of all valid regions for Amazon Lightsail. Use the include availability zones
parameter to also return the Availability Zones in a region.
getRegionsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRegionsResponse getRegions(Consumer<GetRegionsRequest.Builder> getRegionsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns a list of all valid regions for Amazon Lightsail. Use the include availability zones
parameter to also return the Availability Zones in a region.
This is a convenience which creates an instance of the GetRegionsRequest.Builder avoiding the need to
create one manually via GetRegionsRequest.builder()
getRegionsRequest - A Consumer that will call methods on
GetRegionsRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRegionsResponse getRegions() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns a list of all valid regions for Amazon Lightsail. Use the include availability zones
parameter to also return the Availability Zones in a region.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetRegions(GetRegionsRequest),
AWS API
Documentationdefault GetRelationalDatabaseResponse getRelationalDatabase(GetRelationalDatabaseRequest getRelationalDatabaseRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about a specific database in Amazon Lightsail.
getRelationalDatabaseRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRelationalDatabaseResponse getRelationalDatabase(Consumer<GetRelationalDatabaseRequest.Builder> getRelationalDatabaseRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about a specific database in Amazon Lightsail.
This is a convenience which creates an instance of the GetRelationalDatabaseRequest.Builder avoiding the
need to create one manually via GetRelationalDatabaseRequest.builder()
getRelationalDatabaseRequest - A Consumer that will call methods on
GetRelationalDatabaseRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRelationalDatabaseBlueprintsResponse getRelationalDatabaseBlueprints(GetRelationalDatabaseBlueprintsRequest getRelationalDatabaseBlueprintsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
getRelationalDatabaseBlueprintsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRelationalDatabaseBlueprintsResponse getRelationalDatabaseBlueprints(Consumer<GetRelationalDatabaseBlueprintsRequest.Builder> getRelationalDatabaseBlueprintsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
This is a convenience which creates an instance of the GetRelationalDatabaseBlueprintsRequest.Builder
avoiding the need to create one manually via GetRelationalDatabaseBlueprintsRequest.builder()
getRelationalDatabaseBlueprintsRequest - A Consumer that will call methods on
GetRelationalDatabaseBlueprintsRequest.Builder to
create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRelationalDatabaseBlueprintsResponse getRelationalDatabaseBlueprints() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetRelationalDatabaseBlueprints(GetRelationalDatabaseBlueprintsRequest),
AWS API Documentationdefault GetRelationalDatabaseBundlesResponse getRelationalDatabaseBundles(GetRelationalDatabaseBundlesRequest getRelationalDatabaseBundlesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
getRelationalDatabaseBundlesRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRelationalDatabaseBundlesResponse getRelationalDatabaseBundles(Consumer<GetRelationalDatabaseBundlesRequest.Builder> getRelationalDatabaseBundlesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
This is a convenience which creates an instance of the GetRelationalDatabaseBundlesRequest.Builder
avoiding the need to create one manually via GetRelationalDatabaseBundlesRequest.builder()
getRelationalDatabaseBundlesRequest - A Consumer that will call methods on
GetRelationalDatabaseBundlesRequest.Builder to
create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRelationalDatabaseBundlesResponse getRelationalDatabaseBundles() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetRelationalDatabaseBundles(GetRelationalDatabaseBundlesRequest),
AWS API Documentationdefault GetRelationalDatabaseEventsResponse getRelationalDatabaseEvents(GetRelationalDatabaseEventsRequest getRelationalDatabaseEventsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns a list of events for a specific database in Amazon Lightsail.
getRelationalDatabaseEventsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRelationalDatabaseEventsResponse getRelationalDatabaseEvents(Consumer<GetRelationalDatabaseEventsRequest.Builder> getRelationalDatabaseEventsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns a list of events for a specific database in Amazon Lightsail.
This is a convenience which creates an instance of the GetRelationalDatabaseEventsRequest.Builder
avoiding the need to create one manually via GetRelationalDatabaseEventsRequest.builder()
getRelationalDatabaseEventsRequest - A Consumer that will call methods on
GetRelationalDatabaseEventsRequest.Builder to
create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRelationalDatabaseLogEventsResponse getRelationalDatabaseLogEvents(GetRelationalDatabaseLogEventsRequest getRelationalDatabaseLogEventsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns a list of log events for a database in Amazon Lightsail.
getRelationalDatabaseLogEventsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRelationalDatabaseLogEventsResponse getRelationalDatabaseLogEvents(Consumer<GetRelationalDatabaseLogEventsRequest.Builder> getRelationalDatabaseLogEventsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns a list of log events for a database in Amazon Lightsail.
This is a convenience which creates an instance of the GetRelationalDatabaseLogEventsRequest.Builder
avoiding the need to create one manually via GetRelationalDatabaseLogEventsRequest.builder()
getRelationalDatabaseLogEventsRequest - A Consumer that will call methods on
GetRelationalDatabaseLogEventsRequest.Builder to
create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRelationalDatabaseLogStreamsResponse getRelationalDatabaseLogStreams(GetRelationalDatabaseLogStreamsRequest getRelationalDatabaseLogStreamsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns a list of available log streams for a specific database in Amazon Lightsail.
getRelationalDatabaseLogStreamsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRelationalDatabaseLogStreamsResponse getRelationalDatabaseLogStreams(Consumer<GetRelationalDatabaseLogStreamsRequest.Builder> getRelationalDatabaseLogStreamsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns a list of available log streams for a specific database in Amazon Lightsail.
This is a convenience which creates an instance of the GetRelationalDatabaseLogStreamsRequest.Builder
avoiding the need to create one manually via GetRelationalDatabaseLogStreamsRequest.builder()
getRelationalDatabaseLogStreamsRequest - A Consumer that will call methods on
GetRelationalDatabaseLogStreamsRequest.Builder to
create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRelationalDatabaseMasterUserPasswordResponse getRelationalDatabaseMasterUserPassword(GetRelationalDatabaseMasterUserPasswordRequest getRelationalDatabaseMasterUserPasswordRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
getRelationalDatabaseMasterUserPasswordRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRelationalDatabaseMasterUserPasswordResponse getRelationalDatabaseMasterUserPassword(Consumer<GetRelationalDatabaseMasterUserPasswordRequest.Builder> getRelationalDatabaseMasterUserPasswordRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
This is a convenience which creates an instance of the
GetRelationalDatabaseMasterUserPasswordRequest.Builder avoiding the need to create one manually via
GetRelationalDatabaseMasterUserPasswordRequest.builder()
getRelationalDatabaseMasterUserPasswordRequest - A Consumer that will call methods on
GetRelationalDatabaseMasterUserPasswordRequest.Builder
to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRelationalDatabaseMetricDataResponse getRelationalDatabaseMetricData(GetRelationalDatabaseMetricDataRequest getRelationalDatabaseMetricDataRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
getRelationalDatabaseMetricDataRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRelationalDatabaseMetricDataResponse getRelationalDatabaseMetricData(Consumer<GetRelationalDatabaseMetricDataRequest.Builder> getRelationalDatabaseMetricDataRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
This is a convenience which creates an instance of the GetRelationalDatabaseMetricDataRequest.Builder
avoiding the need to create one manually via GetRelationalDatabaseMetricDataRequest.builder()
getRelationalDatabaseMetricDataRequest - A Consumer that will call methods on
GetRelationalDatabaseMetricDataRequest.Builder to
create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRelationalDatabaseParametersResponse getRelationalDatabaseParameters(GetRelationalDatabaseParametersRequest getRelationalDatabaseParametersRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
getRelationalDatabaseParametersRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRelationalDatabaseParametersResponse getRelationalDatabaseParameters(Consumer<GetRelationalDatabaseParametersRequest.Builder> getRelationalDatabaseParametersRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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.
This is a convenience which creates an instance of the GetRelationalDatabaseParametersRequest.Builder
avoiding the need to create one manually via GetRelationalDatabaseParametersRequest.builder()
getRelationalDatabaseParametersRequest - A Consumer that will call methods on
GetRelationalDatabaseParametersRequest.Builder to
create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRelationalDatabaseSnapshotResponse getRelationalDatabaseSnapshot(GetRelationalDatabaseSnapshotRequest getRelationalDatabaseSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about a specific database snapshot in Amazon Lightsail.
getRelationalDatabaseSnapshotRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRelationalDatabaseSnapshotResponse getRelationalDatabaseSnapshot(Consumer<GetRelationalDatabaseSnapshotRequest.Builder> getRelationalDatabaseSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about a specific database snapshot in Amazon Lightsail.
This is a convenience which creates an instance of the GetRelationalDatabaseSnapshotRequest.Builder
avoiding the need to create one manually via GetRelationalDatabaseSnapshotRequest.builder()
getRelationalDatabaseSnapshotRequest - A Consumer that will call methods on
GetRelationalDatabaseSnapshotRequest.Builder to
create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRelationalDatabaseSnapshotsResponse getRelationalDatabaseSnapshots(GetRelationalDatabaseSnapshotsRequest getRelationalDatabaseSnapshotsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all of your database snapshots in Amazon Lightsail.
getRelationalDatabaseSnapshotsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRelationalDatabaseSnapshotsResponse getRelationalDatabaseSnapshots(Consumer<GetRelationalDatabaseSnapshotsRequest.Builder> getRelationalDatabaseSnapshotsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all of your database snapshots in Amazon Lightsail.
This is a convenience which creates an instance of the GetRelationalDatabaseSnapshotsRequest.Builder
avoiding the need to create one manually via GetRelationalDatabaseSnapshotsRequest.builder()
getRelationalDatabaseSnapshotsRequest - A Consumer that will call methods on
GetRelationalDatabaseSnapshotsRequest.Builder to
create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRelationalDatabaseSnapshotsResponse getRelationalDatabaseSnapshots() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all of your database snapshots in Amazon Lightsail.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetRelationalDatabaseSnapshots(GetRelationalDatabaseSnapshotsRequest),
AWS API Documentationdefault GetRelationalDatabasesResponse getRelationalDatabases(GetRelationalDatabasesRequest getRelationalDatabasesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all of your databases in Amazon Lightsail.
getRelationalDatabasesRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRelationalDatabasesResponse getRelationalDatabases(Consumer<GetRelationalDatabasesRequest.Builder> getRelationalDatabasesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all of your databases in Amazon Lightsail.
This is a convenience which creates an instance of the GetRelationalDatabasesRequest.Builder avoiding the
need to create one manually via GetRelationalDatabasesRequest.builder()
getRelationalDatabasesRequest - A Consumer that will call methods on
GetRelationalDatabasesRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRelationalDatabasesResponse getRelationalDatabases() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all of your databases in Amazon Lightsail.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetRelationalDatabases(GetRelationalDatabasesRequest),
AWS API Documentationdefault GetStaticIpResponse getStaticIp(GetStaticIpRequest getStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about an Amazon Lightsail static IP.
getStaticIpRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetStaticIpResponse getStaticIp(Consumer<GetStaticIpRequest.Builder> getStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about an Amazon Lightsail static IP.
This is a convenience which creates an instance of the GetStaticIpRequest.Builder avoiding the need to
create one manually via GetStaticIpRequest.builder()
getStaticIpRequest - A Consumer that will call methods on
GetStaticIpRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetStaticIpsResponse getStaticIps(GetStaticIpsRequest getStaticIpsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all static IPs in the user's account.
getStaticIpsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetStaticIpsResponse getStaticIps(Consumer<GetStaticIpsRequest.Builder> getStaticIpsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all static IPs in the user's account.
This is a convenience which creates an instance of the GetStaticIpsRequest.Builder avoiding the need to
create one manually via GetStaticIpsRequest.builder()
getStaticIpsRequest - A Consumer that will call methods on
GetStaticIpsRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetStaticIpsResponse getStaticIps() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all static IPs in the user's account.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetStaticIps(GetStaticIpsRequest),
AWS API
Documentationdefault ImportKeyPairResponse importKeyPair(ImportKeyPairRequest importKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Imports a public SSH key from a specific key pair.
importKeyPairRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ImportKeyPairResponse importKeyPair(Consumer<ImportKeyPairRequest.Builder> importKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Imports a public SSH key from a specific key pair.
This is a convenience which creates an instance of the ImportKeyPairRequest.Builder avoiding the need to
create one manually via ImportKeyPairRequest.builder()
importKeyPairRequest - A Consumer that will call methods on
ImportKeyPairRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault IsVpcPeeredResponse isVpcPeered(IsVpcPeeredRequest isVpcPeeredRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns a Boolean value indicating whether your Lightsail VPC is peered.
isVpcPeeredRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault IsVpcPeeredResponse isVpcPeered(Consumer<IsVpcPeeredRequest.Builder> isVpcPeeredRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns a Boolean value indicating whether your Lightsail VPC is peered.
This is a convenience which creates an instance of the IsVpcPeeredRequest.Builder avoiding the need to
create one manually via IsVpcPeeredRequest.builder()
isVpcPeeredRequest - A Consumer that will call methods on
IsVpcPeeredRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault IsVpcPeeredResponse isVpcPeered() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns a Boolean value indicating whether your Lightsail VPC is peered.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionisVpcPeered(IsVpcPeeredRequest),
AWS API
Documentationdefault OpenInstancePublicPortsResponse openInstancePublicPorts(OpenInstancePublicPortsRequest openInstancePublicPortsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
openInstancePublicPortsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault OpenInstancePublicPortsResponse openInstancePublicPorts(Consumer<OpenInstancePublicPortsRequest.Builder> openInstancePublicPortsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the OpenInstancePublicPortsRequest.Builder avoiding
the need to create one manually via OpenInstancePublicPortsRequest.builder()
openInstancePublicPortsRequest - A Consumer that will call methods on
OpenInstancePublicPortsRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PeerVpcResponse peerVpc(PeerVpcRequest peerVpcRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Peers the Lightsail VPC with the user's default VPC.
peerVpcRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PeerVpcResponse peerVpc(Consumer<PeerVpcRequest.Builder> peerVpcRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Peers the Lightsail VPC with the user's default VPC.
This is a convenience which creates an instance of the PeerVpcRequest.Builder avoiding the need to create
one manually via PeerVpcRequest.builder()
peerVpcRequest - A Consumer that will call methods on
PeerVpcRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PeerVpcResponse peerVpc() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Peers the Lightsail VPC with the user's default VPC.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionpeerVpc(PeerVpcRequest),
AWS API
Documentationdefault PutAlarmResponse putAlarm(PutAlarmRequest putAlarmRequest) throws ServiceException, InvalidInputException, OperationFailureException, AccessDeniedException, UnauthenticatedException, NotFoundException, AwsServiceException, SdkClientException, LightsailException
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.
putAlarmRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutAlarmResponse putAlarm(Consumer<PutAlarmRequest.Builder> putAlarmRequest) throws ServiceException, InvalidInputException, OperationFailureException, AccessDeniedException, UnauthenticatedException, NotFoundException, AwsServiceException, SdkClientException, LightsailException
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.
This is a convenience which creates an instance of the PutAlarmRequest.Builder avoiding the need to
create one manually via PutAlarmRequest.builder()
putAlarmRequest - A Consumer that will call methods on
PutAlarmRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutInstancePublicPortsResponse putInstancePublicPorts(PutInstancePublicPortsRequest putInstancePublicPortsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
putInstancePublicPortsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutInstancePublicPortsResponse putInstancePublicPorts(Consumer<PutInstancePublicPortsRequest.Builder> putInstancePublicPortsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the PutInstancePublicPortsRequest.Builder avoiding the
need to create one manually via PutInstancePublicPortsRequest.builder()
putInstancePublicPortsRequest - A Consumer that will call methods on
PutInstancePublicPortsRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RebootInstanceResponse rebootInstance(RebootInstanceRequest rebootInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Restarts a specific instance.
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 Amazon Lightsail Developer Guide.
rebootInstanceRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RebootInstanceResponse rebootInstance(Consumer<RebootInstanceRequest.Builder> rebootInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Restarts a specific instance.
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the RebootInstanceRequest.Builder avoiding the need to
create one manually via RebootInstanceRequest.builder()
rebootInstanceRequest - A Consumer that will call methods on
RebootInstanceRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RebootRelationalDatabaseResponse rebootRelationalDatabase(RebootRelationalDatabaseRequest rebootRelationalDatabaseRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
rebootRelationalDatabaseRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RebootRelationalDatabaseResponse rebootRelationalDatabase(Consumer<RebootRelationalDatabaseRequest.Builder> rebootRelationalDatabaseRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the RebootRelationalDatabaseRequest.Builder avoiding
the need to create one manually via RebootRelationalDatabaseRequest.builder()
rebootRelationalDatabaseRequest - A Consumer that will call methods on
RebootRelationalDatabaseRequest.Builder to create
a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterContainerImageResponse registerContainerImage(RegisterContainerImageRequest registerContainerImageRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Registers a container image to your Amazon Lightsail container service.
This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.
registerContainerImageRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RegisterContainerImageResponse registerContainerImage(Consumer<RegisterContainerImageRequest.Builder> registerContainerImageRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Registers a container image to your Amazon Lightsail container service.
This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the RegisterContainerImageRequest.Builder avoiding the
need to create one manually via RegisterContainerImageRequest.builder()
registerContainerImageRequest - A Consumer that will call methods on
RegisterContainerImageRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ReleaseStaticIpResponse releaseStaticIp(ReleaseStaticIpRequest releaseStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes a specific static IP from your account.
releaseStaticIpRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ReleaseStaticIpResponse releaseStaticIp(Consumer<ReleaseStaticIpRequest.Builder> releaseStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes a specific static IP from your account.
This is a convenience which creates an instance of the ReleaseStaticIpRequest.Builder avoiding the need
to create one manually via ReleaseStaticIpRequest.builder()
releaseStaticIpRequest - A Consumer that will call methods on
ReleaseStaticIpRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ResetDistributionCacheResponse resetDistributionCache(ResetDistributionCacheRequest resetDistributionCacheRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution.
After resetting the cache, the next time a content request is made, your distribution pulls, serves, and caches it from the origin.
resetDistributionCacheRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ResetDistributionCacheResponse resetDistributionCache(Consumer<ResetDistributionCacheRequest.Builder> resetDistributionCacheRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution.
After resetting the cache, the next time a content request is made, your distribution pulls, serves, and caches it from the origin.
This is a convenience which creates an instance of the ResetDistributionCacheRequest.Builder avoiding the
need to create one manually via ResetDistributionCacheRequest.builder()
resetDistributionCacheRequest - A Consumer that will call methods on
ResetDistributionCacheRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SendContactMethodVerificationResponse sendContactMethodVerification(SendContactMethodVerificationRequest sendContactMethodVerificationRequest) throws ServiceException, InvalidInputException, OperationFailureException, UnauthenticatedException, AccessDeniedException, NotFoundException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services 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.
sendContactMethodVerificationRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SendContactMethodVerificationResponse sendContactMethodVerification(Consumer<SendContactMethodVerificationRequest.Builder> sendContactMethodVerificationRequest) throws ServiceException, InvalidInputException, OperationFailureException, UnauthenticatedException, AccessDeniedException, NotFoundException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services 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.
This is a convenience which creates an instance of the SendContactMethodVerificationRequest.Builder
avoiding the need to create one manually via SendContactMethodVerificationRequest.builder()
sendContactMethodVerificationRequest - A Consumer that will call methods on
SendContactMethodVerificationRequest.Builder to
create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SetIpAddressTypeResponse setIpAddressType(SetIpAddressTypeRequest setIpAddressTypeRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Sets the IP address type for an Amazon Lightsail resource.
Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the specified resource. Alternately, you can use this action to disable dual-stack, and enable IPv4 only.
setIpAddressTypeRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SetIpAddressTypeResponse setIpAddressType(Consumer<SetIpAddressTypeRequest.Builder> setIpAddressTypeRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Sets the IP address type for an Amazon Lightsail resource.
Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the specified resource. Alternately, you can use this action to disable dual-stack, and enable IPv4 only.
This is a convenience which creates an instance of the SetIpAddressTypeRequest.Builder avoiding the need
to create one manually via SetIpAddressTypeRequest.builder()
setIpAddressTypeRequest - A Consumer that will call methods on
SetIpAddressTypeRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SetResourceAccessForBucketResponse setResourceAccessForBucket(SetResourceAccessForBucketRequest setResourceAccessForBucketRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.
Lightsail buckets currently support setting access for Lightsail instances in the same Amazon Web Services Region.
setResourceAccessForBucketRequest - AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SetResourceAccessForBucketResponse setResourceAccessForBucket(Consumer<SetResourceAccessForBucketRequest.Builder> setResourceAccessForBucketRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.
Lightsail buckets currently support setting access for Lightsail instances in the same Amazon Web Services Region.
This is a convenience which creates an instance of the SetResourceAccessForBucketRequest.Builder avoiding
the need to create one manually via SetResourceAccessForBucketRequest.builder()
setResourceAccessForBucketRequest - A Consumer that will call methods on
SetResourceAccessForBucketRequest.Builder to
create a request.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartGuiSessionResponse startGUISession(StartGuiSessionRequest startGuiSessionRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Initiates a graphical user interface (GUI) session that’s used to access a virtual computer’s operating system and application. The session will be active for 1 hour. Use this action to resume the session after it expires.
startGuiSessionRequest - AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartGuiSessionResponse startGUISession(Consumer<StartGuiSessionRequest.Builder> startGuiSessionRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Initiates a graphical user interface (GUI) session that’s used to access a virtual computer’s operating system and application. The session will be active for 1 hour. Use this action to resume the session after it expires.
This is a convenience which creates an instance of the StartGuiSessionRequest.Builder avoiding the need
to create one manually via StartGuiSessionRequest.builder()
startGuiSessionRequest - A Consumer that will call methods on
StartGuiSessionRequest.Builder to create a
request.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartInstanceResponse startInstance(StartInstanceRequest startInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the
reboot instance operation.
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 Amazon Lightsail Developer 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 Amazon Lightsail Developer Guide.
startInstanceRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartInstanceResponse startInstance(Consumer<StartInstanceRequest.Builder> startInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the
reboot instance operation.
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 Amazon Lightsail Developer 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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the StartInstanceRequest.Builder avoiding the need to
create one manually via StartInstanceRequest.builder()
startInstanceRequest - A Consumer that will call methods on
StartInstanceRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartRelationalDatabaseResponse startRelationalDatabase(StartRelationalDatabaseRequest startRelationalDatabaseRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
startRelationalDatabaseRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartRelationalDatabaseResponse startRelationalDatabase(Consumer<StartRelationalDatabaseRequest.Builder> startRelationalDatabaseRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the StartRelationalDatabaseRequest.Builder avoiding
the need to create one manually via StartRelationalDatabaseRequest.builder()
startRelationalDatabaseRequest - A Consumer that will call methods on
StartRelationalDatabaseRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopGuiSessionResponse stopGUISession(StopGuiSessionRequest stopGuiSessionRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Terminates a web-based NICE DCV session that’s used to access a virtual computer’s operating system or application. The session will close and any unsaved data will be lost.
stopGuiSessionRequest - AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopGuiSessionResponse stopGUISession(Consumer<StopGuiSessionRequest.Builder> stopGuiSessionRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Terminates a web-based NICE DCV session that’s used to access a virtual computer’s operating system or application. The session will close and any unsaved data will be lost.
This is a convenience which creates an instance of the StopGuiSessionRequest.Builder avoiding the need to
create one manually via StopGuiSessionRequest.builder()
stopGuiSessionRequest - A Consumer that will call methods on
StopGuiSessionRequest.Builder to create a request.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopInstanceResponse stopInstance(StopInstanceRequest stopInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Stops a specific Amazon Lightsail instance that is currently running.
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 Amazon Lightsail Developer 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 Amazon Lightsail Developer Guide.
stopInstanceRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopInstanceResponse stopInstance(Consumer<StopInstanceRequest.Builder> stopInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Stops a specific Amazon Lightsail instance that is currently running.
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 Amazon Lightsail Developer 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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the StopInstanceRequest.Builder avoiding the need to
create one manually via StopInstanceRequest.builder()
stopInstanceRequest - A Consumer that will call methods on
StopInstanceRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopRelationalDatabaseResponse stopRelationalDatabase(StopRelationalDatabaseRequest stopRelationalDatabaseRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
stopRelationalDatabaseRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopRelationalDatabaseResponse stopRelationalDatabase(Consumer<StopRelationalDatabaseRequest.Builder> stopRelationalDatabaseRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the StopRelationalDatabaseRequest.Builder avoiding the
need to create one manually via StopRelationalDatabaseRequest.builder()
stopRelationalDatabaseRequest - A Consumer that will call methods on
StopRelationalDatabaseRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer 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 Amazon Lightsail Developer Guide.
tagResourceRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer 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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TestAlarmResponse testAlarm(TestAlarmRequest testAlarmRequest) throws ServiceException, InvalidInputException, OperationFailureException, UnauthenticatedException, AccessDeniedException, NotFoundException, AwsServiceException, SdkClientException, LightsailException
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.
testAlarmRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TestAlarmResponse testAlarm(Consumer<TestAlarmRequest.Builder> testAlarmRequest) throws ServiceException, InvalidInputException, OperationFailureException, UnauthenticatedException, AccessDeniedException, NotFoundException, AwsServiceException, SdkClientException, LightsailException
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.
This is a convenience which creates an instance of the TestAlarmRequest.Builder avoiding the need to
create one manually via TestAlarmRequest.builder()
testAlarmRequest - A Consumer that will call methods on
TestAlarmRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UnpeerVpcResponse unpeerVpc(UnpeerVpcRequest unpeerVpcRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Unpeers the Lightsail VPC from the user's default VPC.
unpeerVpcRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UnpeerVpcResponse unpeerVpc(Consumer<UnpeerVpcRequest.Builder> unpeerVpcRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Unpeers the Lightsail VPC from the user's default VPC.
This is a convenience which creates an instance of the UnpeerVpcRequest.Builder avoiding the need to
create one manually via UnpeerVpcRequest.builder()
unpeerVpcRequest - A Consumer that will call methods on
UnpeerVpcRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UnpeerVpcResponse unpeerVpc() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Unpeers the Lightsail VPC from the user's default VPC.
ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionunpeerVpc(UnpeerVpcRequest),
AWS API
Documentationdefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
untagResourceRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateBucketResponse updateBucket(UpdateBucketRequest updateBucketRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Updates an existing Amazon Lightsail bucket.
Use this action to update the configuration of an existing bucket, such as versioning, public accessibility, and the Amazon Web Services accounts that can access the bucket.
updateBucketRequest - AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateBucketResponse updateBucket(Consumer<UpdateBucketRequest.Builder> updateBucketRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Updates an existing Amazon Lightsail bucket.
Use this action to update the configuration of an existing bucket, such as versioning, public accessibility, and the Amazon Web Services accounts that can access the bucket.
This is a convenience which creates an instance of the UpdateBucketRequest.Builder avoiding the need to
create one manually via UpdateBucketRequest.builder()
updateBucketRequest - A Consumer that will call methods on
UpdateBucketRequest.Builder to create a request.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateBucketBundleResponse updateBucketBundle(UpdateBucketBundleRequest updateBucketBundleRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.
A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. You can update a
bucket's bundle only one time within a monthly Amazon Web Services billing cycle. To determine if you can update
a bucket's bundle, use the GetBuckets action.
The ableToUpdateBundle parameter in the response will indicate whether you can currently update a
bucket's bundle.
Update a bucket's bundle if it's consistently going over its storage space or data transfer quota, or if a bucket's usage is consistently in the lower range of its storage space or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might experience, we strongly recommend that you update a bucket's bundle only as a long-term strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle that will provide the bucket with ample storage space and data transfer for a long time to come.
updateBucketBundleRequest - AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateBucketBundleResponse updateBucketBundle(Consumer<UpdateBucketBundleRequest.Builder> updateBucketBundleRequest) throws AccessDeniedException, InvalidInputException, NotFoundException, ServiceException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.
A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. You can update a
bucket's bundle only one time within a monthly Amazon Web Services billing cycle. To determine if you can update
a bucket's bundle, use the GetBuckets action.
The ableToUpdateBundle parameter in the response will indicate whether you can currently update a
bucket's bundle.
Update a bucket's bundle if it's consistently going over its storage space or data transfer quota, or if a bucket's usage is consistently in the lower range of its storage space or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might experience, we strongly recommend that you update a bucket's bundle only as a long-term strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle that will provide the bucket with ample storage space and data transfer for a long time to come.
This is a convenience which creates an instance of the UpdateBucketBundleRequest.Builder avoiding the
need to create one manually via UpdateBucketBundleRequest.builder()
updateBucketBundleRequest - A Consumer that will call methods on
UpdateBucketBundleRequest.Builder to create a
request.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.ServiceException - A general service exception.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateContainerServiceResponse updateContainerService(UpdateContainerServiceRequest updateContainerServiceRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain names.
updateContainerServiceRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateContainerServiceResponse updateContainerService(Consumer<UpdateContainerServiceRequest.Builder> updateContainerServiceRequest) throws ServiceException, InvalidInputException, NotFoundException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain names.
This is a convenience which creates an instance of the UpdateContainerServiceRequest.Builder avoiding the
need to create one manually via UpdateContainerServiceRequest.builder()
updateContainerServiceRequest - A Consumer that will call methods on
UpdateContainerServiceRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDistributionResponse updateDistribution(UpdateDistributionRequest updateDistributionRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Updates an existing Amazon Lightsail content delivery network (CDN) distribution.
Use this action to update the configuration of your existing distribution.
updateDistributionRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDistributionResponse updateDistribution(Consumer<UpdateDistributionRequest.Builder> updateDistributionRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Updates an existing Amazon Lightsail content delivery network (CDN) distribution.
Use this action to update the configuration of your existing distribution.
This is a convenience which creates an instance of the UpdateDistributionRequest.Builder avoiding the
need to create one manually via UpdateDistributionRequest.builder()
updateDistributionRequest - A Consumer that will call methods on
UpdateDistributionRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDistributionBundleResponse updateDistributionBundle(UpdateDistributionBundleRequest updateDistributionBundleRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.
A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution.
Update your distribution's bundle if your distribution is going over its monthly network transfer quota and is incurring an overage fee.
You can update your distribution's bundle only one time within your monthly Amazon Web Services billing cycle. To
determine if you can update your distribution's bundle, use the GetDistributions action. The
ableToUpdateBundle parameter in the result will indicate whether you can currently update your
distribution's bundle.
updateDistributionBundleRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDistributionBundleResponse updateDistributionBundle(Consumer<UpdateDistributionBundleRequest.Builder> updateDistributionBundleRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.
A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution.
Update your distribution's bundle if your distribution is going over its monthly network transfer quota and is incurring an overage fee.
You can update your distribution's bundle only one time within your monthly Amazon Web Services billing cycle. To
determine if you can update your distribution's bundle, use the GetDistributions action. The
ableToUpdateBundle parameter in the result will indicate whether you can currently update your
distribution's bundle.
This is a convenience which creates an instance of the UpdateDistributionBundleRequest.Builder avoiding
the need to create one manually via UpdateDistributionBundleRequest.builder()
updateDistributionBundleRequest - A Consumer that will call methods on
UpdateDistributionBundleRequest.Builder to create
a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDomainEntryResponse updateDomainEntry(UpdateDomainEntryRequest updateDomainEntryRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Updates a domain recordset after it is created.
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 Amazon Lightsail Developer Guide.
updateDomainEntryRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateDomainEntryResponse updateDomainEntry(Consumer<UpdateDomainEntryRequest.Builder> updateDomainEntryRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Updates a domain recordset after it is created.
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the UpdateDomainEntryRequest.Builder avoiding the need
to create one manually via UpdateDomainEntryRequest.builder()
updateDomainEntryRequest - A Consumer that will call methods on
UpdateDomainEntryRequest.Builder to create a
request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateInstanceMetadataOptionsResponse updateInstanceMetadataOptions(UpdateInstanceMetadataOptionsRequest updateInstanceMetadataOptionsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Modifies the Amazon Lightsail instance metadata parameters on a running or stopped instance. When you modify the
parameters on a running instance, the GetInstance or GetInstances API operation
initially responds with a state of pending. After the parameter modifications are successfully
applied, the state changes to applied in subsequent GetInstance or
GetInstances API calls. For more information, see Use IMDSv2 with an Amazon Lightsail instance in the Amazon Lightsail Developer Guide.
updateInstanceMetadataOptionsRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateInstanceMetadataOptionsResponse updateInstanceMetadataOptions(Consumer<UpdateInstanceMetadataOptionsRequest.Builder> updateInstanceMetadataOptionsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Modifies the Amazon Lightsail instance metadata parameters on a running or stopped instance. When you modify the
parameters on a running instance, the GetInstance or GetInstances API operation
initially responds with a state of pending. After the parameter modifications are successfully
applied, the state changes to applied in subsequent GetInstance or
GetInstances API calls. For more information, see Use IMDSv2 with an Amazon Lightsail instance in the Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the UpdateInstanceMetadataOptionsRequest.Builder
avoiding the need to create one manually via UpdateInstanceMetadataOptionsRequest.builder()
updateInstanceMetadataOptionsRequest - A Consumer that will call methods on
UpdateInstanceMetadataOptionsRequest.Builder to
create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateLoadBalancerAttributeResponse updateLoadBalancerAttribute(UpdateLoadBalancerAttributeRequest updateLoadBalancerAttributeRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
updateLoadBalancerAttributeRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateLoadBalancerAttributeResponse updateLoadBalancerAttribute(Consumer<UpdateLoadBalancerAttributeRequest.Builder> updateLoadBalancerAttributeRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the UpdateLoadBalancerAttributeRequest.Builder
avoiding the need to create one manually via UpdateLoadBalancerAttributeRequest.builder()
updateLoadBalancerAttributeRequest - A Consumer that will call methods on
UpdateLoadBalancerAttributeRequest.Builder to
create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateRelationalDatabaseResponse updateRelationalDatabase(UpdateRelationalDatabaseRequest updateRelationalDatabaseRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
updateRelationalDatabaseRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateRelationalDatabaseResponse updateRelationalDatabase(Consumer<UpdateRelationalDatabaseRequest.Builder> updateRelationalDatabaseRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the UpdateRelationalDatabaseRequest.Builder avoiding
the need to create one manually via UpdateRelationalDatabaseRequest.builder()
updateRelationalDatabaseRequest - A Consumer that will call methods on
UpdateRelationalDatabaseRequest.Builder to create
a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateRelationalDatabaseParametersResponse updateRelationalDatabaseParameters(UpdateRelationalDatabaseParametersRequest updateRelationalDatabaseParametersRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
updateRelationalDatabaseParametersRequest - ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateRelationalDatabaseParametersResponse updateRelationalDatabaseParameters(Consumer<UpdateRelationalDatabaseParametersRequest.Builder> updateRelationalDatabaseParametersRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
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 Amazon Lightsail Developer Guide.
This is a convenience which creates an instance of the UpdateRelationalDatabaseParametersRequest.Builder
avoiding the need to create one manually via UpdateRelationalDatabaseParametersRequest.builder()
updateRelationalDatabaseParametersRequest - A Consumer that will call methods on
UpdateRelationalDatabaseParametersRequest.Builder
to create a request.ServiceException - A general service exception.InvalidInputException - Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to
create, view, or edit these resources.
NotFoundException - Lightsail throws this exception when it cannot find a resource.OperationFailureException - Lightsail throws this exception when an operation fails to execute.AccessDeniedException - Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException - Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException - Lightsail throws this exception when the user has not been authenticated.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic LightsailClient create()
LightsailClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static LightsailClientBuilder builder()
LightsailClient.static ServiceMetadata serviceMetadata()
default LightsailServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.