@Generated(value="software.amazon.awssdk:codegen") public interface LightsailClient extends SdkClient
builder()
method.
Amazon Lightsail is the easiest way to get started with AWS for developers who just need virtual private servers. Lightsail includes everything you need to launch your project quickly - a virtual machine, SSD-based storage, data transfer, DNS management, and a static IP - for a low, predictable price. You manage those Lightsail servers through the Lightsail console or by using the API or command-line interface (CLI).
For more information about Lightsail concepts and tasks, see the Lightsail Dev Guide.
To use the Lightsail API or the CLI, you will need to use AWS Identity and Access Management (IAM) to generate access keys. For details about how to set this up, see the Lightsail Dev Guide.
Modifier and Type | Field and Description |
---|---|
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 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 the public ports on a specific Amazon Lightsail instance.
|
default CloseInstancePublicPortsResponse |
closeInstancePublicPorts(Consumer<CloseInstancePublicPortsRequest.Builder> closeInstancePublicPortsRequest)
Closes the public ports on a specific Amazon Lightsail instance.
|
default CopySnapshotResponse |
copySnapshot(Consumer<CopySnapshotRequest.Builder> copySnapshotRequest)
Copies an instance or disk snapshot from one AWS Region to another in Amazon Lightsail.
|
default CopySnapshotResponse |
copySnapshot(CopySnapshotRequest copySnapshotRequest)
Copies an instance or disk snapshot from one AWS Region to another in Amazon Lightsail.
|
static LightsailClient |
create()
Create a
LightsailClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
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 CreateDiskResponse |
createDisk(Consumer<CreateDiskRequest.Builder> createDiskRequest)
Creates a block storage disk that can be attached to a 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 a 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 disk snapshot that can be attached to a Lightsail instance in the same
Availability Zone (e.g.,
us-east-2a ). |
default CreateDiskFromSnapshotResponse |
createDiskFromSnapshot(CreateDiskFromSnapshotRequest createDiskFromSnapshotRequest)
Creates a block storage disk from a disk snapshot that can be attached to a Lightsail instance in the same
Availability Zone (e.g.,
us-east-2a ). |
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 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 entry records associated with the domain: A record, CNAME record, TXT record, or MX
record.
|
default CreateDomainEntryResponse |
createDomainEntry(CreateDomainEntryRequest createDomainEntryRequest)
Creates one of the following entry records associated with the domain: A record, CNAME record, TXT record, or MX
record.
|
default CreateInstancesResponse |
createInstances(Consumer<CreateInstancesRequest.Builder> createInstancesRequest)
Creates one or more Amazon Lightsail virtual private servers, or instances.
|
default CreateInstancesResponse |
createInstances(CreateInstancesRequest createInstancesRequest)
Creates one or more Amazon Lightsail virtual private servers, or instances.
|
default CreateInstancesFromSnapshotResponse |
createInstancesFromSnapshot(Consumer<CreateInstancesFromSnapshotRequest.Builder> createInstancesFromSnapshotRequest)
Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical
configuration.
|
default CreateInstancesFromSnapshotResponse |
createInstancesFromSnapshot(CreateInstancesFromSnapshotRequest createInstancesFromSnapshotRequest)
Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical
configuration.
|
default CreateInstanceSnapshotResponse |
createInstanceSnapshot(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 an SSH key pair.
|
default CreateKeyPairResponse |
createKeyPair(CreateKeyPairRequest createKeyPairRequest)
Creates an SSH key pair.
|
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 a Lightsail load balancer TLS certificate.
|
default CreateLoadBalancerTlsCertificateResponse |
createLoadBalancerTlsCertificate(CreateLoadBalancerTlsCertificateRequest createLoadBalancerTlsCertificateRequest)
Creates a Lightsail load balancer TLS certificate.
|
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 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 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 a specific Amazon Lightsail virtual private server, or instance.
|
default DeleteInstanceResponse |
deleteInstance(DeleteInstanceRequest deleteInstanceRequest)
Deletes a specific Amazon Lightsail virtual private server, or 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 a specific SSH key pair.
|
default DeleteKeyPairResponse |
deleteKeyPair(DeleteKeyPairRequest deleteKeyPairRequest)
Deletes a specific SSH key pair.
|
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 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 DownloadDefaultKeyPairResponse |
downloadDefaultKeyPair()
Downloads the default SSH key pair from the user's account.
|
default DownloadDefaultKeyPairResponse |
downloadDefaultKeyPair(Consumer<DownloadDefaultKeyPairRequest.Builder> downloadDefaultKeyPairRequest)
Downloads the default SSH key pair from the user's account.
|
default DownloadDefaultKeyPairResponse |
downloadDefaultKeyPair(DownloadDefaultKeyPairRequest downloadDefaultKeyPairRequest)
Downloads the default SSH key pair from the user's account.
|
default ExportSnapshotResponse |
exportSnapshot(Consumer<ExportSnapshotRequest.Builder> exportSnapshotRequest)
Exports a Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2).
|
default ExportSnapshotResponse |
exportSnapshot(ExportSnapshotRequest exportSnapshotRequest)
Exports a 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 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 GetBundlesResponse |
getBundles()
Returns the list of bundles that are available for purchase.
|
default GetBundlesResponse |
getBundles(Consumer<GetBundlesRequest.Builder> getBundlesRequest)
Returns the list of bundles that are available for purchase.
|
default GetBundlesResponse |
getBundles(GetBundlesRequest getBundlesRequest)
Returns the list of bundles that are available for purchase.
|
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 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 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 the export snapshot record created as a result of the
export snapshot operation. |
default GetExportSnapshotRecordsResponse |
getExportSnapshotRecords(Consumer<GetExportSnapshotRecordsRequest.Builder> getExportSnapshotRecordsRequest)
Returns the export snapshot record created as a result of the
export snapshot operation. |
default GetExportSnapshotRecordsResponse |
getExportSnapshotRecords(GetExportSnapshotRecordsRequest getExportSnapshotRecordsRequest)
Returns the export snapshot record 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 port states for a specific virtual private server, or instance.
|
default GetInstancePortStatesResponse |
getInstancePortStates(GetInstancePortStatesRequest getInstancePortStatesRequest)
Returns the port states for a specific virtual private server, or instance.
|
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 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 a specific static IP.
|
default GetStaticIpResponse |
getStaticIp(GetStaticIpRequest getStaticIpRequest)
Returns information about a specific 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)
Adds public ports to an Amazon Lightsail instance.
|
default OpenInstancePublicPortsResponse |
openInstancePublicPorts(OpenInstancePublicPortsRequest openInstancePublicPortsRequest)
Adds public ports to an Amazon Lightsail instance.
|
default PeerVpcResponse |
peerVpc()
Tries to peer the Lightsail VPC with the user's default VPC.
|
default PeerVpcResponse |
peerVpc(Consumer<PeerVpcRequest.Builder> peerVpcRequest)
Tries to peer the Lightsail VPC with the user's default VPC.
|
default PeerVpcResponse |
peerVpc(PeerVpcRequest peerVpcRequest)
Tries to peer the Lightsail VPC with the user's default VPC.
|
default PutInstancePublicPortsResponse |
putInstancePublicPorts(Consumer<PutInstancePublicPortsRequest.Builder> putInstancePublicPortsRequest)
Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not
included in the current request.
|
default PutInstancePublicPortsResponse |
putInstancePublicPorts(PutInstancePublicPortsRequest putInstancePublicPortsRequest)
Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not
included in the current request.
|
default RebootInstanceResponse |
rebootInstance(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 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.
|
static ServiceMetadata |
serviceMetadata() |
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 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 UnpeerVpcResponse |
unpeerVpc()
Attempts to unpeer the Lightsail VPC from the user's default VPC.
|
default UnpeerVpcResponse |
unpeerVpc(Consumer<UnpeerVpcRequest.Builder> unpeerVpcRequest)
Attempts to unpeer the Lightsail VPC from the user's default VPC.
|
default UnpeerVpcResponse |
unpeerVpc(UnpeerVpcRequest unpeerVpcRequest)
Attempts to unpeer 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 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 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.
|
serviceName
close
static final String SERVICE_NAME
static LightsailClient create()
LightsailClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static LightsailClientBuilder builder()
LightsailClient
.default AllocateStaticIpResponse allocateStaticIp(AllocateStaticIpRequest allocateStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 diskName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 diskName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 loadBalancerName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 loadBalancerName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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
operation with
the non-attached certificate, and it will replace the existing one and become the attached certificate.
The attach load balancer tls certificate
operation supports tag-based access control via resource
tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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
operation with
the non-attached certificate, and it will replace the existing one and become the attached certificate.
The attach load balancer tls certificate
operation supports tag-based access control via resource
tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CloseInstancePublicPortsResponse closeInstancePublicPorts(CloseInstancePublicPortsRequest closeInstancePublicPortsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Closes the public ports on a specific Amazon Lightsail instance.
The close instance public ports
operation supports tag-based access control via resource tags
applied to the resource identified by instanceName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CloseInstancePublicPortsResponse closeInstancePublicPorts(Consumer<CloseInstancePublicPortsRequest.Builder> closeInstancePublicPortsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Closes the public ports on a specific Amazon Lightsail instance.
The close instance public ports
operation supports tag-based access control via resource tags
applied to the resource identified by instanceName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CopySnapshotResponse copySnapshot(CopySnapshotRequest copySnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Copies an instance or disk snapshot from one AWS Region to another in Amazon Lightsail.
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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CopySnapshotResponse copySnapshot(Consumer<CopySnapshotRequest.Builder> copySnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Copies an instance or disk snapshot from one AWS Region to another in Amazon Lightsail.
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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 a Lightsail instance in the same Availability Zone (e.g.,
us-east-2a
). The disk is created in the regional endpoint that you send the HTTP request to. For
more information, see Regions and Availability Zones in Lightsail.
The create disk
operation supports tag-based access control via request tags. For more information,
see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 a Lightsail instance in the same Availability Zone (e.g.,
us-east-2a
). The disk is created in the regional endpoint that you send the HTTP request to. For
more information, see Regions and Availability Zones in Lightsail.
The create disk
operation supports tag-based access control via request tags. For more information,
see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateDiskFromSnapshotResponse createDiskFromSnapshot(CreateDiskFromSnapshotRequest createDiskFromSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates a block storage disk from a disk snapshot that can be attached to a Lightsail instance in the same
Availability Zone (e.g., us-east-2a
). The disk is created in the regional endpoint that you send the
HTTP request to. For more information, see Regions and Availability Zones in Lightsail.
The create disk from snapshot
operation supports tag-based access control via request tags and
resource tags applied to the resource identified by diskSnapshotName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateDiskFromSnapshotResponse createDiskFromSnapshot(Consumer<CreateDiskFromSnapshotRequest.Builder> createDiskFromSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates a block storage disk from a disk snapshot that can be attached to a Lightsail instance in the same
Availability Zone (e.g., us-east-2a
). The disk is created in the regional endpoint that you send the
HTTP request to. For more information, see Regions and Availability Zones in Lightsail.
The create disk from snapshot
operation supports tag-based access control via request tags and
resource tags applied to the resource identified by diskSnapshotName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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.
The create disk snapshot
operation supports tag-based access control via request tags. For more
information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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.
The create disk snapshot
operation supports tag-based access control via request tags. For more
information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateDomainEntryResponse createDomainEntry(CreateDomainEntryRequest createDomainEntryRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates one of the following entry records associated with the domain: A record, CNAME record, TXT record, or MX record.
The create domain entry
operation supports tag-based access control via resource tags applied to the
resource identified by domainName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateDomainEntryResponse createDomainEntry(Consumer<CreateDomainEntryRequest.Builder> createDomainEntryRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates one of the following entry records associated with the domain: A record, CNAME record, TXT record, or MX record.
The create domain entry
operation supports tag-based access control via resource tags applied to the
resource identified by domainName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateInstancesResponse createInstances(CreateInstancesRequest createInstancesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates one or more Amazon Lightsail virtual private servers, or instances. Create instances using active blueprints. Inactive blueprints are listed to support customers with existing instances but are not necessarily available for launch of new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases. Use the get blueprints operation to return a list of available blueprints.
The create instances
operation supports tag-based access control via request tags. For more
information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateInstancesResponse createInstances(Consumer<CreateInstancesRequest.Builder> createInstancesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates one or more Amazon Lightsail virtual private servers, or instances. Create instances using active blueprints. Inactive blueprints are listed to support customers with existing instances but are not necessarily available for launch of new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases. Use the get blueprints operation to return a list of available blueprints.
The create instances
operation supports tag-based access control via request tags. For more
information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateInstancesFromSnapshotResponse createInstancesFromSnapshot(CreateInstancesFromSnapshotRequest createInstancesFromSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical configuration.
The create instances from snapshot
operation supports tag-based access control via request tags and
resource tags applied to the resource identified by instanceSnapshotName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateInstancesFromSnapshotResponse createInstancesFromSnapshot(Consumer<CreateInstancesFromSnapshotRequest.Builder> createInstancesFromSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical configuration.
The create instances from snapshot
operation supports tag-based access control via request tags and
resource tags applied to the resource identified by instanceSnapshotName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateKeyPairResponse createKeyPair(CreateKeyPairRequest createKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates an SSH key pair.
The create key pair
operation supports tag-based access control via request tags. For more
information, see the Lightsail Dev Guide.
createKeyPairRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateKeyPairResponse createKeyPair(Consumer<CreateKeyPairRequest.Builder> createKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates an SSH key pair.
The create key pair
operation supports tag-based access control via request tags. For more
information, see the Lightsail Dev Guide.
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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateLoadBalancerTlsCertificateResponse createLoadBalancerTlsCertificate(CreateLoadBalancerTlsCertificateRequest createLoadBalancerTlsCertificateRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates a Lightsail load balancer TLS certificate.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
The create load balancer tls certificate
operation supports tag-based access control via resource
tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateLoadBalancerTlsCertificateResponse createLoadBalancerTlsCertificate(Consumer<CreateLoadBalancerTlsCertificateRequest.Builder> createLoadBalancerTlsCertificateRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Creates a Lightsail load balancer TLS certificate.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
The create load balancer tls certificate
operation supports tag-based access control via resource
tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 diskName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 diskName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 diskSnapshotName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 diskSnapshotName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 domainName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 domainName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 domainName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 domainName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteInstanceResponse deleteInstance(DeleteInstanceRequest deleteInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes a specific Amazon Lightsail virtual private server, or instance.
The delete instance
operation supports tag-based access control via resource tags applied to the
resource identified by instanceName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteInstanceResponse deleteInstance(Consumer<DeleteInstanceRequest.Builder> deleteInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes a specific Amazon Lightsail virtual private server, or instance.
The delete instance
operation supports tag-based access control via resource tags applied to the
resource identified by instanceName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 instanceSnapshotName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 instanceSnapshotName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteKeyPairResponse deleteKeyPair(DeleteKeyPairRequest deleteKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes a specific SSH key pair.
The delete key pair
operation supports tag-based access control via resource tags applied to the
resource identified by keyPairName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteKeyPairResponse deleteKeyPair(Consumer<DeleteKeyPairRequest.Builder> deleteKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Deletes a specific SSH key pair.
The delete key pair
operation supports tag-based access control via resource tags applied to the
resource identified by keyPairName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 loadBalancerName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 loadBalancerName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 delete load balancer tls certificate
operation supports tag-based access control via resource
tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 delete load balancer tls certificate
operation supports tag-based access control via resource
tags applied to the resource identified by loadBalancerName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 diskName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 diskName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 loadBalancerName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 loadBalancerName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DownloadDefaultKeyPairResponse downloadDefaultKeyPair() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Downloads the default SSH key pair from 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
downloadDefaultKeyPair(DownloadDefaultKeyPairRequest)
,
AWS API Documentationdefault DownloadDefaultKeyPairResponse downloadDefaultKeyPair(DownloadDefaultKeyPairRequest downloadDefaultKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Downloads the default SSH key pair from the user's account.
downloadDefaultKeyPairRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DownloadDefaultKeyPairResponse downloadDefaultKeyPair(Consumer<DownloadDefaultKeyPairRequest.Builder> downloadDefaultKeyPairRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Downloads the default SSH key pair from the user's account.
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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ExportSnapshotResponse exportSnapshot(ExportSnapshotRequest exportSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Exports a 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 sourceSnapshotName. For more information, see the Lightsail Dev Guide.
Use the get instance snapshots
or get disk snapshots
operations to get a list of
snapshots that you can export to Amazon EC2.
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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ExportSnapshotResponse exportSnapshot(Consumer<ExportSnapshotRequest.Builder> exportSnapshotRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Exports a 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 sourceSnapshotName. For more information, see the Lightsail Dev Guide.
Use the get instance snapshots
or get disk snapshots
operations to get a list of
snapshots that you can export to Amazon EC2.
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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getActiveNames(GetActiveNamesRequest)
,
AWS API
Documentationdefault 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 virtual private server already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.
ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getBlueprints(GetBlueprintsRequest)
,
AWS API
Documentationdefault 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 virtual private server already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.
getBlueprintsRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 virtual private server already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.
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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetBundlesResponse getBundles() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance).
ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getBundles(GetBundlesRequest)
,
AWS API
Documentationdefault GetBundlesResponse getBundles(GetBundlesRequest getBundlesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance).
getBundlesRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetBundlesResponse getBundles(Consumer<GetBundlesRequest.Builder> getBundlesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance).
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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getCloudFormationStackRecords(GetCloudFormationStackRecordsRequest)
,
AWS API Documentationdefault 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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.
If you are describing a long list of disk snapshots, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getDiskSnapshots(GetDiskSnapshotsRequest)
,
AWS API
Documentationdefault 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.
If you are describing a long list of disk snapshots, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
getDiskSnapshotsRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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.
If you are describing a long list of disk snapshots, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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.
If you are describing a long list of disks, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getDisks(GetDisksRequest)
,
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.
If you are describing a long list of disks, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
getDisksRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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.
If you are describing a long list of disks, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getDomains(GetDomainsRequest)
,
AWS API
Documentationdefault 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetExportSnapshotRecordsResponse getExportSnapshotRecords() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the export snapshot record created as a result of the export snapshot
operation.
An export snapshot record can be used to create a new Amazon EC2 instance and its related resources with the
create cloud formation stack
operation.
ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getExportSnapshotRecords(GetExportSnapshotRecordsRequest)
,
AWS API Documentationdefault GetExportSnapshotRecordsResponse getExportSnapshotRecords(GetExportSnapshotRecordsRequest getExportSnapshotRecordsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the export snapshot record created as a result of the export snapshot
operation.
An export snapshot record can be used to create a new Amazon EC2 instance and its related resources with the
create cloud formation stack
operation.
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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetExportSnapshotRecordsResponse getExportSnapshotRecords(Consumer<GetExportSnapshotRecordsRequest.Builder> getExportSnapshotRecordsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the export snapshot record created as a result of the export snapshot
operation.
An export snapshot record can be used to create a new Amazon EC2 instance and its related resources with the
create cloud formation stack
operation.
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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 instanceName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 instanceName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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.
getInstanceMetricDataRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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.
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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetInstancePortStatesResponse getInstancePortStates(GetInstancePortStatesRequest getInstancePortStatesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the port states for a specific virtual private server, or instance.
getInstancePortStatesRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetInstancePortStatesResponse getInstancePortStates(Consumer<GetInstancePortStatesRequest.Builder> getInstancePortStatesRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns the port states for a specific virtual private server, or instance.
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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getInstanceSnapshots(GetInstanceSnapshotsRequest)
,
AWS
API Documentationdefault 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getInstances(GetInstancesRequest)
,
AWS API
Documentationdefault 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getKeyPairs(GetKeyPairsRequest)
,
AWS API
Documentationdefault 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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.
getLoadBalancerMetricDataRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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.
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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetLoadBalancersResponse getLoadBalancers() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all load balancers in an account.
If you are describing a long list of load balancers, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getLoadBalancers(GetLoadBalancersRequest)
,
AWS API
Documentationdefault GetLoadBalancersResponse getLoadBalancers(GetLoadBalancersRequest getLoadBalancersRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about all load balancers in an account.
If you are describing a long list of load balancers, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
getLoadBalancersRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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.
If you are describing a long list of load balancers, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.
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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getOperations(GetOperationsRequest)
,
AWS API
Documentationdefault 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getRegions(GetRegionsRequest)
,
AWS API
Documentationdefault 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getRelationalDatabaseBlueprints(GetRelationalDatabaseBlueprintsRequest)
,
AWS API Documentationdefault 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getRelationalDatabaseBundles(GetRelationalDatabaseBundlesRequest)
,
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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 asdf
operation GetRelationalDatabaseMasterUserPassword 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 asdf
operation GetRelationalDatabaseMasterUserPassword 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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.
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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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.
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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getRelationalDatabaseSnapshots(GetRelationalDatabaseSnapshotsRequest)
,
AWS API Documentationdefault 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getRelationalDatabases(GetRelationalDatabasesRequest)
,
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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetStaticIpResponse getStaticIp(GetStaticIpRequest getStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about a specific static IP.
getStaticIpRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetStaticIpResponse getStaticIp(Consumer<GetStaticIpRequest.Builder> getStaticIpRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Returns information about a specific 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getStaticIps(GetStaticIpsRequest)
,
AWS API
Documentationdefault 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
isVpcPeered(IsVpcPeeredRequest)
,
AWS API
Documentationdefault 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default OpenInstancePublicPortsResponse openInstancePublicPorts(OpenInstancePublicPortsRequest openInstancePublicPortsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Adds public ports to an Amazon Lightsail instance.
The open instance public ports
operation supports tag-based access control via resource tags applied
to the resource identified by instanceName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default OpenInstancePublicPortsResponse openInstancePublicPorts(Consumer<OpenInstancePublicPortsRequest.Builder> openInstancePublicPortsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Adds public ports to an Amazon Lightsail instance.
The open instance public ports
operation supports tag-based access control via resource tags applied
to the resource identified by instanceName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PeerVpcResponse peerVpc() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Tries to peer 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
peerVpc(PeerVpcRequest)
,
AWS API
Documentationdefault PeerVpcResponse peerVpc(PeerVpcRequest peerVpcRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Tries to peer the Lightsail VPC with the user's default VPC.
peerVpcRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PeerVpcResponse peerVpc(Consumer<PeerVpcRequest.Builder> peerVpcRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Tries to peer 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutInstancePublicPortsResponse putInstancePublicPorts(PutInstancePublicPortsRequest putInstancePublicPortsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not included in the current request.
The put instance public ports
operation supports tag-based access control via resource tags applied
to the resource identified by instanceName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutInstancePublicPortsResponse putInstancePublicPorts(Consumer<PutInstancePublicPortsRequest.Builder> putInstancePublicPortsRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not included in the current request.
The put instance public ports
operation supports tag-based access control via resource tags applied
to the resource identified by instanceName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RebootInstanceResponse rebootInstance(RebootInstanceRequest rebootInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Restarts a specific instance. When your Amazon Lightsail instance is finished rebooting, Lightsail assigns a new public IP address. To use the same IP address after restarting, create a static IP address and attach it to the instance.
The reboot instance
operation supports tag-based access control via resource tags applied to the
resource identified by instanceName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RebootInstanceResponse rebootInstance(Consumer<RebootInstanceRequest.Builder> rebootInstanceRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Restarts a specific instance. When your Amazon Lightsail instance is finished rebooting, Lightsail assigns a new public IP address. To use the same IP address after restarting, create a static IP address and attach it to the instance.
The reboot instance
operation supports tag-based access control via resource tags applied to the
resource identified by instanceName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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.
The start instance
operation supports tag-based access control via resource tags applied to the
resource identified by instanceName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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.
The start instance
operation supports tag-based access control via resource tags applied to the
resource identified by instanceName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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.
The stop instance
operation supports tag-based access control via resource tags applied to the
resource identified by instanceName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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.
The stop instance
operation supports tag-based access control via resource tags applied to the
resource identified by instanceName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 Lightsail Dev Guide.
The tag resource
operation supports tag-based access control via request tags and resource tags
applied to the resource identified by resourceName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 Lightsail Dev Guide.
The tag resource
operation supports tag-based access control via request tags and resource tags
applied to the resource identified by resourceName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UnpeerVpcResponse unpeerVpc() throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Attempts to unpeer 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
unpeerVpc(UnpeerVpcRequest)
,
AWS API
Documentationdefault UnpeerVpcResponse unpeerVpc(UnpeerVpcRequest unpeerVpcRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Attempts to unpeer the Lightsail VPC from the user's default VPC.
unpeerVpcRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UnpeerVpcResponse unpeerVpc(Consumer<UnpeerVpcRequest.Builder> unpeerVpcRequest) throws ServiceException, InvalidInputException, NotFoundException, OperationFailureException, AccessDeniedException, AccountSetupInProgressException, UnauthenticatedException, AwsServiceException, SdkClientException, LightsailException
Attempts to unpeer 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 resourceName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 resourceName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 domainName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 domainName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 loadBalancerName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 loadBalancerName. For more information, see the Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 Lightsail Dev 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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 paramater updates are applied: dynamic
or
pending-reboot
. Parameters marked with a dynamic
apply type are applied immediately.
Parameters marked with a pending-reboot
apply type are applied only after the database is rebooted
using the reboot relational database
operation.
The update relational database parameters
operation supports tag-based access control via resource
tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default 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 paramater updates are applied: dynamic
or
pending-reboot
. Parameters marked with a dynamic
apply type are applied immediately.
Parameters marked with a pending-reboot
apply type are applied only after the database is rebooted
using the reboot relational database
operation.
The update relational database parameters
operation supports tag-based access control via resource
tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.
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-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.LightsailException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.