@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonLightsailClient extends AmazonWebServiceClient implements AmazonLightsail
Amazon Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes everything you need to launch your project quickly - instances (virtual private servers), container services, storage buckets, managed databases, SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN) distributions, DNS management of registered domains, and resource snapshots (backups) - for a low, predictable monthly price.
You can manage your Lightsail resources using the Lightsail console, Lightsail API, AWS Command Line Interface (AWS CLI), or SDKs. For more information about Lightsail concepts and tasks, see the Amazon Lightsail Developer Guide.
This API Reference provides detailed information about the actions, data types, parameters, and errors of the Lightsail service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see Amazon Lightsail Endpoints and Quotas in the Amazon Web Services General Reference.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Constructor and Description |
---|
AmazonLightsailClient()
Deprecated.
|
AmazonLightsailClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonLightsailClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AmazonLightsailClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AmazonLightsailClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonLightsailClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonLightsailClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AmazonLightsailClient(ClientConfiguration clientConfiguration)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
AllocateStaticIpResult |
allocateStaticIp(AllocateStaticIpRequest request)
Allocates a static IP address.
|
AttachCertificateToDistributionResult |
attachCertificateToDistribution(AttachCertificateToDistributionRequest request)
Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.
|
AttachDiskResult |
attachDisk(AttachDiskRequest request)
Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the
specified disk name.
|
AttachInstancesToLoadBalancerResult |
attachInstancesToLoadBalancer(AttachInstancesToLoadBalancerRequest request)
Attaches one or more Lightsail instances to a load balancer.
|
AttachLoadBalancerTlsCertificateResult |
attachLoadBalancerTlsCertificate(AttachLoadBalancerTlsCertificateRequest request)
Attaches a Transport Layer Security (TLS) certificate to your load balancer.
|
AttachStaticIpResult |
attachStaticIp(AttachStaticIpRequest request)
Attaches a static IP address to a specific Amazon Lightsail instance.
|
static AmazonLightsailClientBuilder |
builder() |
CloseInstancePublicPortsResult |
closeInstancePublicPorts(CloseInstancePublicPortsRequest request)
Closes ports for a specific Amazon Lightsail instance.
|
CopySnapshotResult |
copySnapshot(CopySnapshotRequest request)
Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an
instance or disk as a manual snapshot.
|
CreateBucketResult |
createBucket(CreateBucketRequest request)
Creates an Amazon Lightsail bucket.
|
CreateBucketAccessKeyResult |
createBucketAccessKey(CreateBucketAccessKeyRequest request)
Creates a new access key for the specified Amazon Lightsail bucket.
|
CreateCertificateResult |
createCertificate(CreateCertificateRequest request)
Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a
container service.
|
CreateCloudFormationStackResult |
createCloudFormationStack(CreateCloudFormationStackRequest request)
Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail
snapshot.
|
CreateContactMethodResult |
createContactMethod(CreateContactMethodRequest request)
Creates an email or SMS text message contact method.
|
CreateContainerServiceResult |
createContainerService(CreateContainerServiceRequest request)
Creates an Amazon Lightsail container service.
|
CreateContainerServiceDeploymentResult |
createContainerServiceDeployment(CreateContainerServiceDeploymentRequest request)
Creates a deployment for your Amazon Lightsail container service.
|
CreateContainerServiceRegistryLoginResult |
createContainerServiceRegistryLogin(CreateContainerServiceRegistryLoginRequest request)
Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local
machine.
|
CreateDiskResult |
createDisk(CreateDiskRequest request)
Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone
(e.g.,
us-east-2a ). |
CreateDiskFromSnapshotResult |
createDiskFromSnapshot(CreateDiskFromSnapshotRequest request)
Creates a block storage disk from a manual or automatic snapshot of a disk.
|
CreateDiskSnapshotResult |
createDiskSnapshot(CreateDiskSnapshotRequest request)
Creates a snapshot of a block storage disk.
|
CreateDistributionResult |
createDistribution(CreateDistributionRequest request)
Creates an Amazon Lightsail content delivery network (CDN) distribution.
|
CreateDomainResult |
createDomain(CreateDomainRequest request)
Creates a domain resource for the specified domain (e.g., example.com).
|
CreateDomainEntryResult |
createDomainEntry(CreateDomainEntryRequest request)
Creates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name
(CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).
|
CreateInstancesResult |
createInstances(CreateInstancesRequest request)
Creates one or more Amazon Lightsail instances.
|
CreateInstancesFromSnapshotResult |
createInstancesFromSnapshot(CreateInstancesFromSnapshotRequest request)
Creates one or more new instances from a manual or automatic snapshot of an instance.
|
CreateInstanceSnapshotResult |
createInstanceSnapshot(CreateInstanceSnapshotRequest request)
Creates a snapshot of a specific virtual private server, or instance.
|
CreateKeyPairResult |
createKeyPair(CreateKeyPairRequest request)
Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.
|
CreateLoadBalancerResult |
createLoadBalancer(CreateLoadBalancerRequest request)
Creates a Lightsail load balancer.
|
CreateLoadBalancerTlsCertificateResult |
createLoadBalancerTlsCertificate(CreateLoadBalancerTlsCertificateRequest request)
Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.
|
CreateRelationalDatabaseResult |
createRelationalDatabase(CreateRelationalDatabaseRequest request)
Creates a new database in Amazon Lightsail.
|
CreateRelationalDatabaseFromSnapshotResult |
createRelationalDatabaseFromSnapshot(CreateRelationalDatabaseFromSnapshotRequest request)
Creates a new database from an existing database snapshot in Amazon Lightsail.
|
CreateRelationalDatabaseSnapshotResult |
createRelationalDatabaseSnapshot(CreateRelationalDatabaseSnapshotRequest request)
Creates a snapshot of your database in Amazon Lightsail.
|
DeleteAlarmResult |
deleteAlarm(DeleteAlarmRequest request)
Deletes an alarm.
|
DeleteAutoSnapshotResult |
deleteAutoSnapshot(DeleteAutoSnapshotRequest request)
Deletes an automatic snapshot of an instance or disk.
|
DeleteBucketResult |
deleteBucket(DeleteBucketRequest request)
Deletes a Amazon Lightsail bucket.
|
DeleteBucketAccessKeyResult |
deleteBucketAccessKey(DeleteBucketAccessKeyRequest request)
Deletes an access key for the specified Amazon Lightsail bucket.
|
DeleteCertificateResult |
deleteCertificate(DeleteCertificateRequest request)
Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.
|
DeleteContactMethodResult |
deleteContactMethod(DeleteContactMethodRequest request)
Deletes a contact method.
|
DeleteContainerImageResult |
deleteContainerImage(DeleteContainerImageRequest request)
Deletes a container image that is registered to your Amazon Lightsail container service.
|
DeleteContainerServiceResult |
deleteContainerService(DeleteContainerServiceRequest request)
Deletes your Amazon Lightsail container service.
|
DeleteDiskResult |
deleteDisk(DeleteDiskRequest request)
Deletes the specified block storage disk.
|
DeleteDiskSnapshotResult |
deleteDiskSnapshot(DeleteDiskSnapshotRequest request)
Deletes the specified disk snapshot.
|
DeleteDistributionResult |
deleteDistribution(DeleteDistributionRequest request)
Deletes your Amazon Lightsail content delivery network (CDN) distribution.
|
DeleteDomainResult |
deleteDomain(DeleteDomainRequest request)
Deletes the specified domain recordset and all of its domain records.
|
DeleteDomainEntryResult |
deleteDomainEntry(DeleteDomainEntryRequest request)
Deletes a specific domain entry.
|
DeleteInstanceResult |
deleteInstance(DeleteInstanceRequest request)
Deletes an Amazon Lightsail instance.
|
DeleteInstanceSnapshotResult |
deleteInstanceSnapshot(DeleteInstanceSnapshotRequest request)
Deletes a specific snapshot of a virtual private server (or instance).
|
DeleteKeyPairResult |
deleteKeyPair(DeleteKeyPairRequest request)
Deletes the specified key pair by removing the public key from Amazon Lightsail.
|
DeleteKnownHostKeysResult |
deleteKnownHostKeys(DeleteKnownHostKeysRequest request)
Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to
authenticate an instance.
|
DeleteLoadBalancerResult |
deleteLoadBalancer(DeleteLoadBalancerRequest request)
Deletes a Lightsail load balancer and all its associated SSL/TLS certificates.
|
DeleteLoadBalancerTlsCertificateResult |
deleteLoadBalancerTlsCertificate(DeleteLoadBalancerTlsCertificateRequest request)
Deletes an SSL/TLS certificate associated with a Lightsail load balancer.
|
DeleteRelationalDatabaseResult |
deleteRelationalDatabase(DeleteRelationalDatabaseRequest request)
Deletes a database in Amazon Lightsail.
|
DeleteRelationalDatabaseSnapshotResult |
deleteRelationalDatabaseSnapshot(DeleteRelationalDatabaseSnapshotRequest request)
Deletes a database snapshot in Amazon Lightsail.
|
DetachCertificateFromDistributionResult |
detachCertificateFromDistribution(DetachCertificateFromDistributionRequest request)
Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.
|
DetachDiskResult |
detachDisk(DetachDiskRequest request)
Detaches a stopped block storage disk from a Lightsail instance.
|
DetachInstancesFromLoadBalancerResult |
detachInstancesFromLoadBalancer(DetachInstancesFromLoadBalancerRequest request)
Detaches the specified instances from a Lightsail load balancer.
|
DetachStaticIpResult |
detachStaticIp(DetachStaticIpRequest request)
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
|
DisableAddOnResult |
disableAddOn(DisableAddOnRequest request)
Disables an add-on for an Amazon Lightsail resource.
|
DownloadDefaultKeyPairResult |
downloadDefaultKeyPair(DownloadDefaultKeyPairRequest request)
Downloads the regional Amazon Lightsail default key pair.
|
EnableAddOnResult |
enableAddOn(EnableAddOnRequest request)
Enables or modifies an add-on for an Amazon Lightsail resource.
|
ExportSnapshotResult |
exportSnapshot(ExportSnapshotRequest request)
Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2).
|
GetActiveNamesResult |
getActiveNames(GetActiveNamesRequest request)
Returns the names of all active (not deleted) resources.
|
GetAlarmsResult |
getAlarms(GetAlarmsRequest request)
Returns information about the configured alarms.
|
GetAutoSnapshotsResult |
getAutoSnapshots(GetAutoSnapshotsRequest request)
Returns the available automatic snapshots for an instance or disk.
|
GetBlueprintsResult |
getBlueprints(GetBlueprintsRequest request)
Returns the list of available instance images, or blueprints.
|
GetBucketAccessKeysResult |
getBucketAccessKeys(GetBucketAccessKeysRequest request)
Returns the existing access key IDs for the specified Amazon Lightsail bucket.
|
GetBucketBundlesResult |
getBucketBundles(GetBucketBundlesRequest request)
Returns the bundles that you can apply to a Amazon Lightsail bucket.
|
GetBucketMetricDataResult |
getBucketMetricData(GetBucketMetricDataRequest request)
Returns the data points of a specific metric for an Amazon Lightsail bucket.
|
GetBucketsResult |
getBuckets(GetBucketsRequest request)
Returns information about one or more Amazon Lightsail buckets.
|
GetBundlesResult |
getBundles(GetBundlesRequest request)
Returns the bundles that you can apply to an Amazon Lightsail instance when you create it.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetCertificatesResult |
getCertificates(GetCertificatesRequest request)
Returns information about one or more Amazon Lightsail SSL/TLS certificates.
|
GetCloudFormationStackRecordsResult |
getCloudFormationStackRecords(GetCloudFormationStackRecordsRequest request)
Returns the CloudFormation stack record created as a result of the
create cloud formation stack
operation. |
GetContactMethodsResult |
getContactMethods(GetContactMethodsRequest request)
Returns information about the configured contact methods.
|
GetContainerAPIMetadataResult |
getContainerAPIMetadata(GetContainerAPIMetadataRequest request)
Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control
(lightsailctl) plugin.
|
GetContainerImagesResult |
getContainerImages(GetContainerImagesRequest request)
Returns the container images that are registered to your Amazon Lightsail container service.
|
GetContainerLogResult |
getContainerLog(GetContainerLogRequest request)
Returns the log events of a container of your Amazon Lightsail container service.
|
GetContainerServiceDeploymentsResult |
getContainerServiceDeployments(GetContainerServiceDeploymentsRequest request)
Returns the deployments for your Amazon Lightsail container service
|
GetContainerServiceMetricDataResult |
getContainerServiceMetricData(GetContainerServiceMetricDataRequest request)
Returns the data points of a specific metric of your Amazon Lightsail container service.
|
GetContainerServicePowersResult |
getContainerServicePowers(GetContainerServicePowersRequest request)
Returns the list of powers that can be specified for your Amazon Lightsail container services.
|
GetContainerServicesResult |
getContainerServices(GetContainerServicesRequest request)
Returns information about one or more of your Amazon Lightsail container services.
|
GetDiskResult |
getDisk(GetDiskRequest request)
Returns information about a specific block storage disk.
|
GetDisksResult |
getDisks(GetDisksRequest request)
Returns information about all block storage disks in your AWS account and region.
|
GetDiskSnapshotResult |
getDiskSnapshot(GetDiskSnapshotRequest request)
Returns information about a specific block storage disk snapshot.
|
GetDiskSnapshotsResult |
getDiskSnapshots(GetDiskSnapshotsRequest request)
Returns information about all block storage disk snapshots in your AWS account and region.
|
GetDistributionBundlesResult |
getDistributionBundles(GetDistributionBundlesRequest request)
Returns the bundles that can be applied to your Amazon Lightsail content delivery network (CDN) distributions.
|
GetDistributionLatestCacheResetResult |
getDistributionLatestCacheReset(GetDistributionLatestCacheResetRequest request)
Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network
(CDN) distribution.
|
GetDistributionMetricDataResult |
getDistributionMetricData(GetDistributionMetricDataRequest request)
Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.
|
GetDistributionsResult |
getDistributions(GetDistributionsRequest request)
Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.
|
GetDomainResult |
getDomain(GetDomainRequest request)
Returns information about a specific domain recordset.
|
GetDomainsResult |
getDomains(GetDomainsRequest request)
Returns a list of all domains in the user's account.
|
GetExportSnapshotRecordsResult |
getExportSnapshotRecords(GetExportSnapshotRecordsRequest request)
Returns all export snapshot records created as a result of the
export snapshot operation. |
GetInstanceResult |
getInstance(GetInstanceRequest request)
Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
|
GetInstanceAccessDetailsResult |
getInstanceAccessDetails(GetInstanceAccessDetailsRequest request)
Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
|
GetInstanceMetricDataResult |
getInstanceMetricData(GetInstanceMetricDataRequest request)
Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
|
GetInstancePortStatesResult |
getInstancePortStates(GetInstancePortStatesRequest request)
Returns the firewall port states for a specific Amazon Lightsail instance, the IP addresses allowed to connect to
the instance through the ports, and the protocol.
|
GetInstancesResult |
getInstances(GetInstancesRequest request)
Returns information about all Amazon Lightsail virtual private servers, or instances.
|
GetInstanceSnapshotResult |
getInstanceSnapshot(GetInstanceSnapshotRequest request)
Returns information about a specific instance snapshot.
|
GetInstanceSnapshotsResult |
getInstanceSnapshots(GetInstanceSnapshotsRequest request)
Returns all instance snapshots for the user's account.
|
GetInstanceStateResult |
getInstanceState(GetInstanceStateRequest request)
Returns the state of a specific instance.
|
GetKeyPairResult |
getKeyPair(GetKeyPairRequest request)
Returns information about a specific key pair.
|
GetKeyPairsResult |
getKeyPairs(GetKeyPairsRequest request)
Returns information about all key pairs in the user's account.
|
GetLoadBalancerResult |
getLoadBalancer(GetLoadBalancerRequest request)
Returns information about the specified Lightsail load balancer.
|
GetLoadBalancerMetricDataResult |
getLoadBalancerMetricData(GetLoadBalancerMetricDataRequest request)
Returns information about health metrics for your Lightsail load balancer.
|
GetLoadBalancersResult |
getLoadBalancers(GetLoadBalancersRequest request)
Returns information about all load balancers in an account.
|
GetLoadBalancerTlsCertificatesResult |
getLoadBalancerTlsCertificates(GetLoadBalancerTlsCertificatesRequest request)
Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.
|
GetLoadBalancerTlsPoliciesResult |
getLoadBalancerTlsPolicies(GetLoadBalancerTlsPoliciesRequest request)
Returns a list of TLS security policies that you can apply to Lightsail load balancers.
|
GetOperationResult |
getOperation(GetOperationRequest request)
Returns information about a specific operation.
|
GetOperationsResult |
getOperations(GetOperationsRequest request)
Returns information about all operations.
|
GetOperationsForResourceResult |
getOperationsForResource(GetOperationsForResourceRequest request)
Gets operations for a specific resource (e.g., an instance or a static IP).
|
GetRegionsResult |
getRegions(GetRegionsRequest request)
Returns a list of all valid regions for Amazon Lightsail.
|
GetRelationalDatabaseResult |
getRelationalDatabase(GetRelationalDatabaseRequest request)
Returns information about a specific database in Amazon Lightsail.
|
GetRelationalDatabaseBlueprintsResult |
getRelationalDatabaseBlueprints(GetRelationalDatabaseBlueprintsRequest request)
Returns a list of available database blueprints in Amazon Lightsail.
|
GetRelationalDatabaseBundlesResult |
getRelationalDatabaseBundles(GetRelationalDatabaseBundlesRequest request)
Returns the list of bundles that are available in Amazon Lightsail.
|
GetRelationalDatabaseEventsResult |
getRelationalDatabaseEvents(GetRelationalDatabaseEventsRequest request)
Returns a list of events for a specific database in Amazon Lightsail.
|
GetRelationalDatabaseLogEventsResult |
getRelationalDatabaseLogEvents(GetRelationalDatabaseLogEventsRequest request)
Returns a list of log events for a database in Amazon Lightsail.
|
GetRelationalDatabaseLogStreamsResult |
getRelationalDatabaseLogStreams(GetRelationalDatabaseLogStreamsRequest request)
Returns a list of available log streams for a specific database in Amazon Lightsail.
|
GetRelationalDatabaseMasterUserPasswordResult |
getRelationalDatabaseMasterUserPassword(GetRelationalDatabaseMasterUserPasswordRequest request)
Returns the current, previous, or pending versions of the master user password for a Lightsail database.
|
GetRelationalDatabaseMetricDataResult |
getRelationalDatabaseMetricData(GetRelationalDatabaseMetricDataRequest request)
Returns the data points of the specified metric for a database in Amazon Lightsail.
|
GetRelationalDatabaseParametersResult |
getRelationalDatabaseParameters(GetRelationalDatabaseParametersRequest request)
Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific
database in Amazon Lightsail.
|
GetRelationalDatabasesResult |
getRelationalDatabases(GetRelationalDatabasesRequest request)
Returns information about all of your databases in Amazon Lightsail.
|
GetRelationalDatabaseSnapshotResult |
getRelationalDatabaseSnapshot(GetRelationalDatabaseSnapshotRequest request)
Returns information about a specific database snapshot in Amazon Lightsail.
|
GetRelationalDatabaseSnapshotsResult |
getRelationalDatabaseSnapshots(GetRelationalDatabaseSnapshotsRequest request)
Returns information about all of your database snapshots in Amazon Lightsail.
|
GetStaticIpResult |
getStaticIp(GetStaticIpRequest request)
Returns information about an Amazon Lightsail static IP.
|
GetStaticIpsResult |
getStaticIps(GetStaticIpsRequest request)
Returns information about all static IPs in the user's account.
|
ImportKeyPairResult |
importKeyPair(ImportKeyPairRequest request)
Imports a public SSH key from a specific key pair.
|
IsVpcPeeredResult |
isVpcPeered(IsVpcPeeredRequest request)
Returns a Boolean value indicating whether your Lightsail VPC is peered.
|
OpenInstancePublicPortsResult |
openInstancePublicPorts(OpenInstancePublicPortsRequest request)
Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the
instance through the ports, and the protocol.
|
PeerVpcResult |
peerVpc(PeerVpcRequest request)
Peers the Lightsail VPC with the user's default VPC.
|
PutAlarmResult |
putAlarm(PutAlarmRequest request)
Creates or updates an alarm, and associates it with the specified metric.
|
PutInstancePublicPortsResult |
putInstancePublicPorts(PutInstancePublicPortsRequest request)
Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the
instance through the ports, and the protocol.
|
RebootInstanceResult |
rebootInstance(RebootInstanceRequest request)
Restarts a specific instance.
|
RebootRelationalDatabaseResult |
rebootRelationalDatabase(RebootRelationalDatabaseRequest request)
Restarts a specific database in Amazon Lightsail.
|
RegisterContainerImageResult |
registerContainerImage(RegisterContainerImageRequest request)
Registers a container image to your Amazon Lightsail container service.
|
ReleaseStaticIpResult |
releaseStaticIp(ReleaseStaticIpRequest request)
Deletes a specific static IP from your account.
|
ResetDistributionCacheResult |
resetDistributionCache(ResetDistributionCacheRequest request)
Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution.
|
SendContactMethodVerificationResult |
sendContactMethodVerification(SendContactMethodVerificationRequest request)
Sends a verification request to an email contact method to ensure it's owned by the requester.
|
SetIpAddressTypeResult |
setIpAddressType(SetIpAddressTypeRequest request)
Sets the IP address type for an Amazon Lightsail resource.
|
SetResourceAccessForBucketResult |
setResourceAccessForBucket(SetResourceAccessForBucketRequest request)
Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartInstanceResult |
startInstance(StartInstanceRequest request)
Starts a specific Amazon Lightsail instance from a stopped state.
|
StartRelationalDatabaseResult |
startRelationalDatabase(StartRelationalDatabaseRequest request)
Starts a specific database from a stopped state in Amazon Lightsail.
|
StopInstanceResult |
stopInstance(StopInstanceRequest request)
Stops a specific Amazon Lightsail instance that is currently running.
|
StopRelationalDatabaseResult |
stopRelationalDatabase(StopRelationalDatabaseRequest request)
Stops a specific database that is currently running in Amazon Lightsail.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds one or more tags to the specified Amazon Lightsail resource.
|
TestAlarmResult |
testAlarm(TestAlarmRequest request)
Tests an alarm by displaying a banner on the Amazon Lightsail console.
|
UnpeerVpcResult |
unpeerVpc(UnpeerVpcRequest request)
Unpeers the Lightsail VPC from the user's default VPC.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.
|
UpdateBucketResult |
updateBucket(UpdateBucketRequest request)
Updates an existing Amazon Lightsail bucket.
|
UpdateBucketBundleResult |
updateBucketBundle(UpdateBucketBundleRequest request)
Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.
|
UpdateContainerServiceResult |
updateContainerService(UpdateContainerServiceRequest request)
Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain
names.
|
UpdateDistributionResult |
updateDistribution(UpdateDistributionRequest request)
Updates an existing Amazon Lightsail content delivery network (CDN) distribution.
|
UpdateDistributionBundleResult |
updateDistributionBundle(UpdateDistributionBundleRequest request)
Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.
|
UpdateDomainEntryResult |
updateDomainEntry(UpdateDomainEntryRequest request)
Updates a domain recordset after it is created.
|
UpdateLoadBalancerAttributeResult |
updateLoadBalancerAttribute(UpdateLoadBalancerAttributeRequest request)
Updates the specified attribute for a load balancer.
|
UpdateRelationalDatabaseResult |
updateRelationalDatabase(UpdateRelationalDatabaseRequest request)
Allows the update of one or more attributes of a database in Amazon Lightsail.
|
UpdateRelationalDatabaseParametersResult |
updateRelationalDatabaseParameters(UpdateRelationalDatabaseParametersRequest request)
Allows the update of one or more parameters of a database in Amazon Lightsail.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion
@Deprecated public AmazonLightsailClient()
AmazonLightsailClientBuilder.defaultClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
@Deprecated public AmazonLightsailClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client connects to Amazon Lightsail (ex: proxy
settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
@Deprecated public AmazonLightsailClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
for example:
AmazonLightsailClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AmazonLightsailClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon Lightsail (ex: proxy
settings, retry counts, etc.).@Deprecated public AmazonLightsailClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AmazonLightsailClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon Lightsail (ex: proxy
settings, retry counts, etc.).@Deprecated public AmazonLightsailClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon Lightsail (ex: proxy
settings, retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic static AmazonLightsailClientBuilder builder()
public AllocateStaticIpResult allocateStaticIp(AllocateStaticIpRequest request)
Allocates a static IP address.
allocateStaticIp
in interface AmazonLightsail
allocateStaticIpRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public AttachCertificateToDistributionResult attachCertificateToDistribution(AttachCertificateToDistributionRequest request)
Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.
After the certificate is attached, your distribution accepts HTTPS traffic for all of the domains that are associated with the certificate.
Use the CreateCertificate
action to create a certificate that you can attach to your distribution.
Only certificates created in the us-east-1
Amazon Web Services Region can be attached to Lightsail
distributions. Lightsail distributions are global resources that can reference an origin in any Amazon Web
Services Region, and distribute its content globally. However, all distributions are located in the
us-east-1
Region.
attachCertificateToDistribution
in interface AmazonLightsail
attachCertificateToDistributionRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public AttachDiskResult attachDisk(AttachDiskRequest request)
Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.
The attach disk
operation supports tag-based access control via resource tags applied to the
resource identified by disk name
. For more information, see the Amazon Lightsail Developer Guide.
attachDisk
in interface AmazonLightsail
attachDiskRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public AttachInstancesToLoadBalancerResult attachInstancesToLoadBalancer(AttachInstancesToLoadBalancerRequest request)
Attaches one or more Lightsail instances to a load balancer.
After some time, the instances are attached to the load balancer and the health check status is available.
The attach instances to load balancer
operation supports tag-based access control via resource tags
applied to the resource identified by load balancer name
. For more information, see the Lightsail Developer Guide.
attachInstancesToLoadBalancer
in interface AmazonLightsail
attachInstancesToLoadBalancerRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public AttachLoadBalancerTlsCertificateResult attachLoadBalancerTlsCertificate(AttachLoadBalancerTlsCertificateRequest request)
Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL).
Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API
to rotate the certificates on your account. Use the AttachLoadBalancerTlsCertificate
action with the
non-attached certificate, and it will replace the existing one and become the attached certificate.
The AttachLoadBalancerTlsCertificate
operation supports tag-based access control via resource tags
applied to the resource identified by load balancer name
. For more information, see the Amazon Lightsail Developer Guide.
attachLoadBalancerTlsCertificate
in interface AmazonLightsail
attachLoadBalancerTlsCertificateRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public AttachStaticIpResult attachStaticIp(AttachStaticIpRequest request)
Attaches a static IP address to a specific Amazon Lightsail instance.
attachStaticIp
in interface AmazonLightsail
attachStaticIpRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public CloseInstancePublicPortsResult closeInstancePublicPorts(CloseInstancePublicPortsRequest request)
Closes ports for a specific Amazon Lightsail instance.
The CloseInstancePublicPorts
action supports tag-based access control via resource tags applied to
the resource identified by instanceName
. For more information, see the Amazon Lightsail Developer Guide.
closeInstancePublicPorts
in interface AmazonLightsail
closeInstancePublicPortsRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public CopySnapshotResult copySnapshot(CopySnapshotRequest request)
Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an instance or disk as a manual snapshot. This operation can also be used to copy a manual or automatic snapshot of an instance or a disk from one Amazon Web Services Region to another in Amazon Lightsail.
When copying a manual snapshot, be sure to define the source region
,
source snapshot name
, and target snapshot name
parameters.
When copying an automatic snapshot, be sure to define the source region
,
source resource name
, target snapshot name
, and either the restore date
or
the use latest restorable auto snapshot
parameters.
copySnapshot
in interface AmazonLightsail
copySnapshotRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public CreateBucketResult createBucket(CreateBucketRequest request)
Creates an Amazon Lightsail bucket.
A bucket is a cloud storage resource available in the Lightsail object storage service. Use buckets to store objects such as data and its descriptive metadata. For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.
createBucket
in interface AmazonLightsail
createBucketRequest
- AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
ServiceException
- A general service exception.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public CreateBucketAccessKeyResult createBucketAccessKey(CreateBucketAccessKeyRequest request)
Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of an access key ID and corresponding secret access key.
Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the GetBucketAccessKeys action to get a list of current access keys for a specific bucket. For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.
The secretAccessKey
value is returned only in response to the CreateBucketAccessKey
action. You can get a secret access key only when you first create an access key; you cannot get the secret
access key later. If you lose the secret access key, you must create a new access key.
createBucketAccessKey
in interface AmazonLightsail
createBucketAccessKeyRequest
- AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.NotFoundException
- Lightsail throws this exception when it cannot find a resource.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
ServiceException
- A general service exception.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public CreateCertificateResult createCertificate(CreateCertificateRequest request)
Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service.
After the certificate is valid, use the AttachCertificateToDistribution
action to use the
certificate and its domains with your distribution. Or use the UpdateContainerService
action to use
the certificate and its domains with your container service.
Only certificates created in the us-east-1
Amazon Web Services Region can be attached to Lightsail
distributions. Lightsail distributions are global resources that can reference an origin in any Amazon Web
Services Region, and distribute its content globally. However, all distributions are located in the
us-east-1
Region.
createCertificate
in interface AmazonLightsail
createCertificateRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public CreateCloudFormationStackResult createCloudFormationStack(CreateCloudFormationStackRequest request)
Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail
snapshot. This operation results in a CloudFormation stack record that can be used to track the AWS
CloudFormation stack created. Use the get cloud formation stack records
operation to get a list of
the CloudFormation stacks created.
Wait until after your new Amazon EC2 instance is created before running the
create cloud formation stack
operation again with the same export snapshot record.
createCloudFormationStack
in interface AmazonLightsail
createCloudFormationStackRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public CreateContactMethodResult createContactMethod(CreateContactMethodRequest request)
Creates an email or SMS text message contact method.
A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
createContactMethod
in interface AmazonLightsail
createContactMethodRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public CreateContainerServiceResult createContainerService(CreateContainerServiceRequest request)
Creates an Amazon Lightsail container service.
A Lightsail container service is a compute resource to which you can deploy containers. For more information, see Container services in Amazon Lightsail in the Lightsail Dev Guide.
createContainerService
in interface AmazonLightsail
createContainerServiceRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public CreateContainerServiceDeploymentResult createContainerServiceDeployment(CreateContainerServiceDeploymentRequest request)
Creates a deployment for your Amazon Lightsail container service.
A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.
You can deploy containers to your container service using container images from a public registry such as Amazon ECR Public, or from your local machine. For more information, see Creating container images for your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.
createContainerServiceDeployment
in interface AmazonLightsail
createContainerServiceDeploymentRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public CreateContainerServiceRegistryLoginResult createContainerServiceRegistryLogin(CreateContainerServiceRegistryLoginRequest request)
Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine. After you're logged in, you can use the native Docker commands to push your local container images to the container image registry of your Amazon Lightsail account so that you can use them with your Lightsail container service. The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials.
You can only push container images to the container service registry of your Lightsail account. You cannot pull container images or perform any other container image management actions on the container service registry.
After you push your container images to the container image registry of your Lightsail account, use the
RegisterContainerImage
action to register the pushed images to a specific Lightsail container
service.
This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.
createContainerServiceRegistryLogin
in interface AmazonLightsail
createContainerServiceRegistryLoginRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public CreateDiskResult createDisk(CreateDiskRequest request)
Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone
(e.g., us-east-2a
).
The create disk
operation supports tag-based access control via request tags. For more information,
see the Amazon Lightsail Developer Guide.
createDisk
in interface AmazonLightsail
createDiskRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public CreateDiskFromSnapshotResult createDiskFromSnapshot(CreateDiskFromSnapshotRequest request)
Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to
an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a
).
The create disk from snapshot
operation supports tag-based access control via request tags and
resource tags applied to the resource identified by disk snapshot name
. For more information, see
the Amazon Lightsail Developer Guide.
createDiskFromSnapshot
in interface AmazonLightsail
createDiskFromSnapshotRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public CreateDiskSnapshotResult createDiskSnapshot(CreateDiskSnapshotRequest request)
Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.
You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending.
You can also use this operation to create a snapshot of an instance's system volume. You might want to do this,
for example, to recover data from the system volume of a botched instance or to create a backup of the system
volume like you would for a block storage disk. To create a snapshot of a system volume, just define the
instance name
parameter when issuing the snapshot command, and a snapshot of the defined instance's
system volume will be created. After the snapshot is available, you can create a block storage disk from the
snapshot and attach it to a running instance to access the data on the disk.
The create disk snapshot
operation supports tag-based access control via request tags. For more
information, see the Amazon Lightsail Developer Guide.
createDiskSnapshot
in interface AmazonLightsail
createDiskSnapshotRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public CreateDistributionResult createDistribution(CreateDistributionRequest request)
Creates an Amazon Lightsail content delivery network (CDN) distribution.
A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance. For more information, see Content delivery networks in Amazon Lightsail.
createDistribution
in interface AmazonLightsail
createDistributionRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public CreateDomainResult createDomain(CreateDomainRequest request)
Creates a domain resource for the specified domain (e.g., example.com).
The create domain
operation supports tag-based access control via request tags. For more
information, see the Amazon Lightsail Developer Guide.
createDomain
in interface AmazonLightsail
createDomainRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public CreateDomainEntryResult createDomainEntry(CreateDomainEntryRequest request)
Creates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).
The create domain entry
operation supports tag-based access control via resource tags applied to the
resource identified by domain name
. For more information, see the Amazon Lightsail Developer Guide.
createDomainEntry
in interface AmazonLightsail
createDomainEntryRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public CreateInstanceSnapshotResult createInstanceSnapshot(CreateInstanceSnapshotRequest request)
Creates a snapshot of a specific virtual private server, or instance. You can use a snapshot to create a new instance that is based on that snapshot.
The create instance snapshot
operation supports tag-based access control via request tags. For more
information, see the Amazon Lightsail Developer Guide.
createInstanceSnapshot
in interface AmazonLightsail
createInstanceSnapshotRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public CreateInstancesResult createInstances(CreateInstancesRequest request)
Creates one or more Amazon Lightsail instances.
The create instances
operation supports tag-based access control via request tags. For more
information, see the Lightsail Developer Guide.
createInstances
in interface AmazonLightsail
createInstancesRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public CreateInstancesFromSnapshotResult createInstancesFromSnapshot(CreateInstancesFromSnapshotRequest request)
Creates one or more new instances from a manual or automatic snapshot of an instance.
The create instances from snapshot
operation supports tag-based access control via request tags and
resource tags applied to the resource identified by instance snapshot name
. For more information,
see the Amazon Lightsail Developer Guide.
createInstancesFromSnapshot
in interface AmazonLightsail
createInstancesFromSnapshotRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public CreateKeyPairResult createKeyPair(CreateKeyPairRequest request)
Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.
Use the DownloadDefaultKeyPair action to create a Lightsail default key pair in an Amazon Web Services Region where a default key pair does not currently exist.
The create key pair
operation supports tag-based access control via request tags. For more
information, see the Amazon Lightsail Developer Guide.
createKeyPair
in interface AmazonLightsail
createKeyPairRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public CreateLoadBalancerResult createLoadBalancer(CreateLoadBalancerRequest request)
Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing. You can create up to 5 load balancers per AWS Region in your account.
When you create a load balancer, you can specify a unique name and port settings. To change additional load
balancer settings, use the UpdateLoadBalancerAttribute
operation.
The create load balancer
operation supports tag-based access control via request tags. For more
information, see the Amazon Lightsail Developer Guide.
createLoadBalancer
in interface AmazonLightsail
createLoadBalancerRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public CreateLoadBalancerTlsCertificateResult createLoadBalancerTlsCertificate(CreateLoadBalancerTlsCertificateRequest request)
Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
The CreateLoadBalancerTlsCertificate
operation supports tag-based access control via resource tags
applied to the resource identified by load balancer name
. For more information, see the Amazon Lightsail Developer Guide.
createLoadBalancerTlsCertificate
in interface AmazonLightsail
createLoadBalancerTlsCertificateRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public CreateRelationalDatabaseResult createRelationalDatabase(CreateRelationalDatabaseRequest request)
Creates a new database in Amazon Lightsail.
The create relational database
operation supports tag-based access control via request tags. For
more information, see the Amazon Lightsail Developer Guide.
createRelationalDatabase
in interface AmazonLightsail
createRelationalDatabaseRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public CreateRelationalDatabaseFromSnapshotResult createRelationalDatabaseFromSnapshot(CreateRelationalDatabaseFromSnapshotRequest request)
Creates a new database from an existing database snapshot in Amazon Lightsail.
You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a different plan, such as a high availability or standard plan.
The create relational database from snapshot
operation supports tag-based access control via request
tags and resource tags applied to the resource identified by relationalDatabaseSnapshotName. For more
information, see the Amazon Lightsail Developer Guide.
createRelationalDatabaseFromSnapshot
in interface AmazonLightsail
createRelationalDatabaseFromSnapshotRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public CreateRelationalDatabaseSnapshotResult createRelationalDatabaseSnapshot(CreateRelationalDatabaseSnapshotRequest request)
Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database.
The create relational database snapshot
operation supports tag-based access control via request
tags. For more information, see the Amazon Lightsail Developer Guide.
createRelationalDatabaseSnapshot
in interface AmazonLightsail
createRelationalDatabaseSnapshotRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public DeleteAlarmResult deleteAlarm(DeleteAlarmRequest request)
Deletes an alarm.
An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
deleteAlarm
in interface AmazonLightsail
deleteAlarmRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
OperationFailureException
- Lightsail throws this exception when an operation fails to execute.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.NotFoundException
- Lightsail throws this exception when it cannot find a resource.public DeleteAutoSnapshotResult deleteAutoSnapshot(DeleteAutoSnapshotRequest request)
Deletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide.
deleteAutoSnapshot
in interface AmazonLightsail
deleteAutoSnapshotRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public DeleteBucketResult deleteBucket(DeleteBucketRequest request)
Deletes a Amazon Lightsail bucket.
When you delete your bucket, the bucket name is released and can be reused for a new bucket in your account or another Amazon Web Services account.
deleteBucket
in interface AmazonLightsail
deleteBucketRequest
- AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.ServiceException
- A general service exception.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public DeleteBucketAccessKeyResult deleteBucketAccessKey(DeleteBucketAccessKeyRequest request)
Deletes an access key for the specified Amazon Lightsail bucket.
We recommend that you delete an access key if the secret access key is compromised.
For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide.
deleteBucketAccessKey
in interface AmazonLightsail
deleteBucketAccessKeyRequest
- AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.ServiceException
- A general service exception.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public DeleteCertificateResult deleteCertificate(DeleteCertificateRequest request)
Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.
Certificates that are currently attached to a distribution cannot be deleted. Use the
DetachCertificateFromDistribution
action to detach a certificate from a distribution.
deleteCertificate
in interface AmazonLightsail
deleteCertificateRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.NotFoundException
- Lightsail throws this exception when it cannot find a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public DeleteContactMethodResult deleteContactMethod(DeleteContactMethodRequest request)
Deletes a contact method.
A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
deleteContactMethod
in interface AmazonLightsail
deleteContactMethodRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
OperationFailureException
- Lightsail throws this exception when an operation fails to execute.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.NotFoundException
- Lightsail throws this exception when it cannot find a resource.public DeleteContainerImageResult deleteContainerImage(DeleteContainerImageRequest request)
Deletes a container image that is registered to your Amazon Lightsail container service.
deleteContainerImage
in interface AmazonLightsail
deleteContainerImageRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public DeleteContainerServiceResult deleteContainerService(DeleteContainerServiceRequest request)
Deletes your Amazon Lightsail container service.
deleteContainerService
in interface AmazonLightsail
deleteContainerServiceRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public DeleteDiskResult deleteDisk(DeleteDiskRequest request)
Deletes the specified block storage disk. The disk must be in the available
state (not attached to a
Lightsail instance).
The disk may remain in the deleting
state for several minutes.
The delete disk
operation supports tag-based access control via resource tags applied to the
resource identified by disk name
. For more information, see the Amazon Lightsail Developer Guide.
deleteDisk
in interface AmazonLightsail
deleteDiskRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public DeleteDiskSnapshotResult deleteDiskSnapshot(DeleteDiskSnapshotRequest request)
Deletes the specified disk snapshot.
When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk.
The delete disk snapshot
operation supports tag-based access control via resource tags applied to
the resource identified by disk snapshot name
. For more information, see the Amazon Lightsail Developer Guide.
deleteDiskSnapshot
in interface AmazonLightsail
deleteDiskSnapshotRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public DeleteDistributionResult deleteDistribution(DeleteDistributionRequest request)
Deletes your Amazon Lightsail content delivery network (CDN) distribution.
deleteDistribution
in interface AmazonLightsail
deleteDistributionRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public DeleteDomainResult deleteDomain(DeleteDomainRequest request)
Deletes the specified domain recordset and all of its domain records.
The delete domain
operation supports tag-based access control via resource tags applied to the
resource identified by domain name
. For more information, see the Amazon Lightsail Developer Guide.
deleteDomain
in interface AmazonLightsail
deleteDomainRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public DeleteDomainEntryResult deleteDomainEntry(DeleteDomainEntryRequest request)
Deletes a specific domain entry.
The delete domain entry
operation supports tag-based access control via resource tags applied to the
resource identified by domain name
. For more information, see the Amazon Lightsail Developer Guide.
deleteDomainEntry
in interface AmazonLightsail
deleteDomainEntryRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public DeleteInstanceResult deleteInstance(DeleteInstanceRequest request)
Deletes an Amazon Lightsail instance.
The delete instance
operation supports tag-based access control via resource tags applied to the
resource identified by instance name
. For more information, see the Amazon Lightsail Developer Guide.
deleteInstance
in interface AmazonLightsail
deleteInstanceRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public DeleteInstanceSnapshotResult deleteInstanceSnapshot(DeleteInstanceSnapshotRequest request)
Deletes a specific snapshot of a virtual private server (or instance).
The delete instance snapshot
operation supports tag-based access control via resource tags applied
to the resource identified by instance snapshot name
. For more information, see the Amazon Lightsail Developer Guide.
deleteInstanceSnapshot
in interface AmazonLightsail
deleteInstanceSnapshotRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public DeleteKeyPairResult deleteKeyPair(DeleteKeyPairRequest request)
Deletes the specified key pair by removing the public key from Amazon Lightsail.
You can delete key pairs that were created using the ImportKeyPair and CreateKeyPair actions, as well as the Lightsail default key pair. A new default key pair will not be created unless you launch an instance without specifying a custom key pair, or you call the DownloadDefaultKeyPair API.
The delete key pair
operation supports tag-based access control via resource tags applied to the
resource identified by key pair name
. For more information, see the Amazon Lightsail Developer Guide.
deleteKeyPair
in interface AmazonLightsail
deleteKeyPairRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public DeleteKnownHostKeysResult deleteKnownHostKeys(DeleteKnownHostKeysRequest request)
Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance. This operation enables the Lightsail browser-based SSH or RDP clients to connect to the instance after a host key mismatch.
Perform this operation only if you were expecting the host key or certificate mismatch or if you are familiar with the new host key or certificate on the instance. For more information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP client.
deleteKnownHostKeys
in interface AmazonLightsail
deleteKnownHostKeysRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public DeleteLoadBalancerResult deleteLoadBalancer(DeleteLoadBalancerRequest request)
Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again.
The delete load balancer
operation supports tag-based access control via resource tags applied to
the resource identified by load balancer name
. For more information, see the Amazon Lightsail Developer Guide.
deleteLoadBalancer
in interface AmazonLightsail
deleteLoadBalancerRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public DeleteLoadBalancerTlsCertificateResult deleteLoadBalancerTlsCertificate(DeleteLoadBalancerTlsCertificateRequest request)
Deletes an SSL/TLS certificate associated with a Lightsail load balancer.
The DeleteLoadBalancerTlsCertificate
operation supports tag-based access control via resource tags
applied to the resource identified by load balancer name
. For more information, see the Amazon Lightsail Developer Guide.
deleteLoadBalancerTlsCertificate
in interface AmazonLightsail
deleteLoadBalancerTlsCertificateRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public DeleteRelationalDatabaseResult deleteRelationalDatabase(DeleteRelationalDatabaseRequest request)
Deletes a database in Amazon Lightsail.
The delete relational database
operation supports tag-based access control via resource tags applied
to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.
deleteRelationalDatabase
in interface AmazonLightsail
deleteRelationalDatabaseRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public DeleteRelationalDatabaseSnapshotResult deleteRelationalDatabaseSnapshot(DeleteRelationalDatabaseSnapshotRequest request)
Deletes a database snapshot in Amazon Lightsail.
The delete relational database snapshot
operation supports tag-based access control via resource
tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.
deleteRelationalDatabaseSnapshot
in interface AmazonLightsail
deleteRelationalDatabaseSnapshotRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public DetachCertificateFromDistributionResult detachCertificateFromDistribution(DetachCertificateFromDistributionRequest request)
Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.
After the certificate is detached, your distribution stops accepting traffic for all of the domains that are associated with the certificate.
detachCertificateFromDistribution
in interface AmazonLightsail
detachCertificateFromDistributionRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public DetachDiskResult detachDisk(DetachDiskRequest request)
Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk.
The detach disk
operation supports tag-based access control via resource tags applied to the
resource identified by disk name
. For more information, see the Amazon Lightsail Developer Guide.
detachDisk
in interface AmazonLightsail
detachDiskRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public DetachInstancesFromLoadBalancerResult detachInstancesFromLoadBalancer(DetachInstancesFromLoadBalancerRequest request)
Detaches the specified instances from a Lightsail load balancer.
This operation waits until the instances are no longer needed before they are detached from the load balancer.
The detach instances from load balancer
operation supports tag-based access control via resource
tags applied to the resource identified by load balancer name
. For more information, see the Amazon
Lightsail Developer Guide.
detachInstancesFromLoadBalancer
in interface AmazonLightsail
detachInstancesFromLoadBalancerRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public DetachStaticIpResult detachStaticIp(DetachStaticIpRequest request)
Detaches a static IP from the Amazon Lightsail instance to which it is attached.
detachStaticIp
in interface AmazonLightsail
detachStaticIpRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public DisableAddOnResult disableAddOn(DisableAddOnRequest request)
Disables an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.
disableAddOn
in interface AmazonLightsail
disableAddOnRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public DownloadDefaultKeyPairResult downloadDefaultKeyPair(DownloadDefaultKeyPairRequest request)
Downloads the regional Amazon Lightsail default key pair.
This action also creates a Lightsail default key pair if a default key pair does not currently exist in the Amazon Web Services Region.
downloadDefaultKeyPair
in interface AmazonLightsail
downloadDefaultKeyPairRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public EnableAddOnResult enableAddOn(EnableAddOnRequest request)
Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide.
enableAddOn
in interface AmazonLightsail
enableAddOnRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public ExportSnapshotResult exportSnapshot(ExportSnapshotRequest request)
Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2).
This operation results in an export snapshot record that can be used with the
create cloud formation stack
operation to create new Amazon EC2 instances.
Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot.
The export snapshot
operation supports tag-based access control via resource tags applied to the
resource identified by source snapshot name
. For more information, see the Amazon Lightsail Developer Guide.
Use the get instance snapshots
or get disk snapshots
operations to get a list of
snapshots that you can export to Amazon EC2.
exportSnapshot
in interface AmazonLightsail
exportSnapshotRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetActiveNamesResult getActiveNames(GetActiveNamesRequest request)
Returns the names of all active (not deleted) resources.
getActiveNames
in interface AmazonLightsail
getActiveNamesRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetAlarmsResult getAlarms(GetAlarmsRequest request)
Returns information about the configured alarms. Specify an alarm name in your request to return information about a specific alarm, or specify a monitored resource name to return information about all alarms for a specific resource.
An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
getAlarms
in interface AmazonLightsail
getAlarmsRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
OperationFailureException
- Lightsail throws this exception when an operation fails to execute.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.NotFoundException
- Lightsail throws this exception when it cannot find a resource.public GetAutoSnapshotsResult getAutoSnapshots(GetAutoSnapshotsRequest request)
Returns the available automatic snapshots for an instance or disk. For more information, see the Amazon Lightsail Developer Guide.
getAutoSnapshots
in interface AmazonLightsail
getAutoSnapshotsRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetBlueprintsResult getBlueprints(GetBlueprintsRequest request)
Returns the list of available instance images, or blueprints. You can use a blueprint to create a new instance already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.
Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.
getBlueprints
in interface AmazonLightsail
getBlueprintsRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetBucketAccessKeysResult getBucketAccessKeys(GetBucketAccessKeysRequest request)
Returns the existing access key IDs for the specified Amazon Lightsail bucket.
This action does not return the secret access key value of an access key. You can get a secret access key only when you create it from the response of the CreateBucketAccessKey action. If you lose the secret access key, you must create a new access key.
getBucketAccessKeys
in interface AmazonLightsail
getBucketAccessKeysRequest
- AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.ServiceException
- A general service exception.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetBucketBundlesResult getBucketBundles(GetBucketBundlesRequest request)
Returns the bundles that you can apply to a Amazon Lightsail bucket.
The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a bucket.
Use the UpdateBucketBundle action to update the bundle for a bucket.
getBucketBundles
in interface AmazonLightsail
getBucketBundlesRequest
- AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
ServiceException
- A general service exception.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetBucketMetricDataResult getBucketMetricData(GetBucketMetricDataRequest request)
Returns the data points of a specific metric for an Amazon Lightsail bucket.
Metrics report the utilization of a bucket. View and collect metric data regularly to monitor the number of objects stored in a bucket (including object versions) and the storage space used by those objects.
getBucketMetricData
in interface AmazonLightsail
getBucketMetricDataRequest
- AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.ServiceException
- A general service exception.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetBucketsResult getBuckets(GetBucketsRequest request)
Returns information about one or more Amazon Lightsail buckets. The information returned includes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account-level block public access feature for your Lightsail buckets.
For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide.
getBuckets
in interface AmazonLightsail
getBucketsRequest
- AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.ServiceException
- A general service exception.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetBundlesResult getBundles(GetBundlesRequest request)
Returns the bundles that you can apply to an Amazon Lightsail instance when you create it.
A bundle describes the specifications of an instance, such as the monthly cost, amount of memory, the number of vCPUs, amount of storage space, and monthly network data transfer quota.
Bundles are referred to as instance plans in the Lightsail console.
getBundles
in interface AmazonLightsail
getBundlesRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetCertificatesResult getCertificates(GetCertificatesRequest request)
Returns information about one or more Amazon Lightsail SSL/TLS certificates.
To get a summary of a certificate, ommit includeCertificateDetails
from your request. The response
will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.
getCertificates
in interface AmazonLightsail
getCertificatesRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetCloudFormationStackRecordsResult getCloudFormationStackRecords(GetCloudFormationStackRecordsRequest request)
Returns the CloudFormation stack record created as a result of the create cloud formation stack
operation.
An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail snapshot.
getCloudFormationStackRecords
in interface AmazonLightsail
getCloudFormationStackRecordsRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetContactMethodsResult getContactMethods(GetContactMethodsRequest request)
Returns information about the configured contact methods. Specify a protocol in your request to return information about a specific contact method.
A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
getContactMethods
in interface AmazonLightsail
getContactMethodsRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetContainerAPIMetadataResult getContainerAPIMetadata(GetContainerAPIMetadataRequest request)
Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin.
getContainerAPIMetadata
in interface AmazonLightsail
getContainerAPIMetadataRequest
- ServiceException
- A general service exception.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetContainerImagesResult getContainerImages(GetContainerImagesRequest request)
Returns the container images that are registered to your Amazon Lightsail container service.
If you created a deployment on your Lightsail container service that uses container images from a public registry like Docker Hub, those images are not returned as part of this action. Those images are not registered to your Lightsail container service.
getContainerImages
in interface AmazonLightsail
getContainerImagesRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetContainerLogResult getContainerLog(GetContainerLogRequest request)
Returns the log events of a container of your Amazon Lightsail container service.
If your container service has more than one node (i.e., a scale greater than 1), then the log events that are returned for the specified container are merged from all nodes on your container service.
Container logs are retained for a certain amount of time. For more information, see Amazon Lightsail endpoints and quotas in the AWS General Reference.
getContainerLog
in interface AmazonLightsail
getContainerLogRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetContainerServiceDeploymentsResult getContainerServiceDeployments(GetContainerServiceDeploymentsRequest request)
Returns the deployments for your Amazon Lightsail container service
A deployment specifies the settings, such as the ports and launch command, of containers that are deployed to your container service.
The deployments are ordered by version in ascending order. The newest version is listed at the top of the response.
A set number of deployments are kept before the oldest one is replaced with the newest one. For more information, see Amazon Lightsail endpoints and quotas in the AWS General Reference.
getContainerServiceDeployments
in interface AmazonLightsail
getContainerServiceDeploymentsRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetContainerServiceMetricDataResult getContainerServiceMetricData(GetContainerServiceMetricDataRequest request)
Returns the data points of a specific metric of your Amazon Lightsail container service.
Metrics report the utilization of your resources. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
getContainerServiceMetricData
in interface AmazonLightsail
getContainerServiceMetricDataRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetContainerServicePowersResult getContainerServicePowers(GetContainerServicePowersRequest request)
Returns the list of powers that can be specified for your Amazon Lightsail container services.
The power specifies the amount of memory, the number of vCPUs, and the base price of the container service.
getContainerServicePowers
in interface AmazonLightsail
getContainerServicePowersRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetContainerServicesResult getContainerServices(GetContainerServicesRequest request)
Returns information about one or more of your Amazon Lightsail container services.
getContainerServices
in interface AmazonLightsail
getContainerServicesRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetDiskResult getDisk(GetDiskRequest request)
Returns information about a specific block storage disk.
getDisk
in interface AmazonLightsail
getDiskRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetDiskSnapshotResult getDiskSnapshot(GetDiskSnapshotRequest request)
Returns information about a specific block storage disk snapshot.
getDiskSnapshot
in interface AmazonLightsail
getDiskSnapshotRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetDiskSnapshotsResult getDiskSnapshots(GetDiskSnapshotsRequest request)
Returns information about all block storage disk snapshots in your AWS account and region.
getDiskSnapshots
in interface AmazonLightsail
getDiskSnapshotsRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetDisksResult getDisks(GetDisksRequest request)
Returns information about all block storage disks in your AWS account and region.
getDisks
in interface AmazonLightsail
getDisksRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetDistributionBundlesResult getDistributionBundles(GetDistributionBundlesRequest request)
Returns the bundles that can be applied to your Amazon Lightsail content delivery network (CDN) distributions.
A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution.
getDistributionBundles
in interface AmazonLightsail
getDistributionBundlesRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetDistributionLatestCacheResetResult getDistributionLatestCacheReset(GetDistributionLatestCacheResetRequest request)
Returns the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution.
getDistributionLatestCacheReset
in interface AmazonLightsail
getDistributionLatestCacheResetRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetDistributionMetricDataResult getDistributionMetricData(GetDistributionMetricDataRequest request)
Returns the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution.
Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
getDistributionMetricData
in interface AmazonLightsail
getDistributionMetricDataRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetDistributionsResult getDistributions(GetDistributionsRequest request)
Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions.
getDistributions
in interface AmazonLightsail
getDistributionsRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetDomainResult getDomain(GetDomainRequest request)
Returns information about a specific domain recordset.
getDomain
in interface AmazonLightsail
getDomainRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetDomainsResult getDomains(GetDomainsRequest request)
Returns a list of all domains in the user's account.
getDomains
in interface AmazonLightsail
getDomainsRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetExportSnapshotRecordsResult getExportSnapshotRecords(GetExportSnapshotRecordsRequest request)
Returns all export snapshot records created as a result of the export snapshot
operation.
An export snapshot record can be used to create a new Amazon EC2 instance and its related resources with the CreateCloudFormationStack action.
getExportSnapshotRecords
in interface AmazonLightsail
getExportSnapshotRecordsRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetInstanceResult getInstance(GetInstanceRequest request)
Returns information about a specific Amazon Lightsail instance, which is a virtual private server.
getInstance
in interface AmazonLightsail
getInstanceRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetInstanceAccessDetailsResult getInstanceAccessDetails(GetInstanceAccessDetailsRequest request)
Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.
The get instance access details
operation supports tag-based access control via resource tags
applied to the resource identified by instance name
. For more information, see the Amazon Lightsail Developer Guide.
getInstanceAccessDetails
in interface AmazonLightsail
getInstanceAccessDetailsRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetInstanceMetricDataResult getInstanceMetricData(GetInstanceMetricDataRequest request)
Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.
Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
getInstanceMetricData
in interface AmazonLightsail
getInstanceMetricDataRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetInstancePortStatesResult getInstancePortStates(GetInstancePortStatesRequest request)
Returns the firewall port states for a specific Amazon Lightsail instance, the IP addresses allowed to connect to the instance through the ports, and the protocol.
getInstancePortStates
in interface AmazonLightsail
getInstancePortStatesRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetInstanceSnapshotResult getInstanceSnapshot(GetInstanceSnapshotRequest request)
Returns information about a specific instance snapshot.
getInstanceSnapshot
in interface AmazonLightsail
getInstanceSnapshotRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetInstanceSnapshotsResult getInstanceSnapshots(GetInstanceSnapshotsRequest request)
Returns all instance snapshots for the user's account.
getInstanceSnapshots
in interface AmazonLightsail
getInstanceSnapshotsRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetInstanceStateResult getInstanceState(GetInstanceStateRequest request)
Returns the state of a specific instance. Works on one instance at a time.
getInstanceState
in interface AmazonLightsail
getInstanceStateRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetInstancesResult getInstances(GetInstancesRequest request)
Returns information about all Amazon Lightsail virtual private servers, or instances.
getInstances
in interface AmazonLightsail
getInstancesRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetKeyPairResult getKeyPair(GetKeyPairRequest request)
Returns information about a specific key pair.
getKeyPair
in interface AmazonLightsail
getKeyPairRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetKeyPairsResult getKeyPairs(GetKeyPairsRequest request)
Returns information about all key pairs in the user's account.
getKeyPairs
in interface AmazonLightsail
getKeyPairsRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetLoadBalancerResult getLoadBalancer(GetLoadBalancerRequest request)
Returns information about the specified Lightsail load balancer.
getLoadBalancer
in interface AmazonLightsail
getLoadBalancerRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetLoadBalancerMetricDataResult getLoadBalancerMetricData(GetLoadBalancerMetricDataRequest request)
Returns information about health metrics for your Lightsail load balancer.
Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
getLoadBalancerMetricData
in interface AmazonLightsail
getLoadBalancerMetricDataRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetLoadBalancerTlsCertificatesResult getLoadBalancerTlsCertificates(GetLoadBalancerTlsCertificatesRequest request)
Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
You can have a maximum of 2 certificates associated with a Lightsail load balancer. One is active and the other is inactive.
getLoadBalancerTlsCertificates
in interface AmazonLightsail
getLoadBalancerTlsCertificatesRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetLoadBalancerTlsPoliciesResult getLoadBalancerTlsPolicies(GetLoadBalancerTlsPoliciesRequest request)
Returns a list of TLS security policies that you can apply to Lightsail load balancers.
For more information about load balancer TLS security policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide.
getLoadBalancerTlsPolicies
in interface AmazonLightsail
getLoadBalancerTlsPoliciesRequest
- ServiceException
- A general service exception.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
public GetLoadBalancersResult getLoadBalancers(GetLoadBalancersRequest request)
Returns information about all load balancers in an account.
getLoadBalancers
in interface AmazonLightsail
getLoadBalancersRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetOperationResult getOperation(GetOperationRequest request)
Returns information about a specific operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on.
getOperation
in interface AmazonLightsail
getOperationRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetOperationsResult getOperations(GetOperationsRequest request)
Returns information about all operations.
Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each
subsequent call to GetOperations
use the maximum (last) statusChangedAt
value from the
previous request.
getOperations
in interface AmazonLightsail
getOperationsRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetOperationsForResourceResult getOperationsForResource(GetOperationsForResourceRequest request)
Gets operations for a specific resource (e.g., an instance or a static IP).
getOperationsForResource
in interface AmazonLightsail
getOperationsForResourceRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetRegionsResult getRegions(GetRegionsRequest request)
Returns a list of all valid regions for Amazon Lightsail. Use the include availability zones
parameter to also return the Availability Zones in a region.
getRegions
in interface AmazonLightsail
getRegionsRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetRelationalDatabaseResult getRelationalDatabase(GetRelationalDatabaseRequest request)
Returns information about a specific database in Amazon Lightsail.
getRelationalDatabase
in interface AmazonLightsail
getRelationalDatabaseRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetRelationalDatabaseBlueprintsResult getRelationalDatabaseBlueprints(GetRelationalDatabaseBlueprintsRequest request)
Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database.
You can use a blueprint ID to create a new database that runs a specific database engine.
getRelationalDatabaseBlueprints
in interface AmazonLightsail
getRelationalDatabaseBlueprintsRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetRelationalDatabaseBundlesResult getRelationalDatabaseBundles(GetRelationalDatabaseBundlesRequest request)
Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database.
You can use a bundle ID to create a new database with explicit performance specifications.
getRelationalDatabaseBundles
in interface AmazonLightsail
getRelationalDatabaseBundlesRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetRelationalDatabaseEventsResult getRelationalDatabaseEvents(GetRelationalDatabaseEventsRequest request)
Returns a list of events for a specific database in Amazon Lightsail.
getRelationalDatabaseEvents
in interface AmazonLightsail
getRelationalDatabaseEventsRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetRelationalDatabaseLogEventsResult getRelationalDatabaseLogEvents(GetRelationalDatabaseLogEventsRequest request)
Returns a list of log events for a database in Amazon Lightsail.
getRelationalDatabaseLogEvents
in interface AmazonLightsail
getRelationalDatabaseLogEventsRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetRelationalDatabaseLogStreamsResult getRelationalDatabaseLogStreams(GetRelationalDatabaseLogStreamsRequest request)
Returns a list of available log streams for a specific database in Amazon Lightsail.
getRelationalDatabaseLogStreams
in interface AmazonLightsail
getRelationalDatabaseLogStreamsRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetRelationalDatabaseMasterUserPasswordResult getRelationalDatabaseMasterUserPassword(GetRelationalDatabaseMasterUserPasswordRequest request)
Returns the current, previous, or pending versions of the master user password for a Lightsail database.
The GetRelationalDatabaseMasterUserPassword
operation supports tag-based access control via resource
tags applied to the resource identified by relationalDatabaseName.
getRelationalDatabaseMasterUserPassword
in interface AmazonLightsail
getRelationalDatabaseMasterUserPasswordRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetRelationalDatabaseMetricDataResult getRelationalDatabaseMetricData(GetRelationalDatabaseMetricDataRequest request)
Returns the data points of the specified metric for a database in Amazon Lightsail.
Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources.
getRelationalDatabaseMetricData
in interface AmazonLightsail
getRelationalDatabaseMetricDataRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetRelationalDatabaseParametersResult getRelationalDatabaseParameters(GetRelationalDatabaseParametersRequest request)
Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail.
In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a reboot, whether the parameter is modifiable, the allowed values, and the data types.
getRelationalDatabaseParameters
in interface AmazonLightsail
getRelationalDatabaseParametersRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetRelationalDatabaseSnapshotResult getRelationalDatabaseSnapshot(GetRelationalDatabaseSnapshotRequest request)
Returns information about a specific database snapshot in Amazon Lightsail.
getRelationalDatabaseSnapshot
in interface AmazonLightsail
getRelationalDatabaseSnapshotRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetRelationalDatabaseSnapshotsResult getRelationalDatabaseSnapshots(GetRelationalDatabaseSnapshotsRequest request)
Returns information about all of your database snapshots in Amazon Lightsail.
getRelationalDatabaseSnapshots
in interface AmazonLightsail
getRelationalDatabaseSnapshotsRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetRelationalDatabasesResult getRelationalDatabases(GetRelationalDatabasesRequest request)
Returns information about all of your databases in Amazon Lightsail.
getRelationalDatabases
in interface AmazonLightsail
getRelationalDatabasesRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetStaticIpResult getStaticIp(GetStaticIpRequest request)
Returns information about an Amazon Lightsail static IP.
getStaticIp
in interface AmazonLightsail
getStaticIpRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public GetStaticIpsResult getStaticIps(GetStaticIpsRequest request)
Returns information about all static IPs in the user's account.
getStaticIps
in interface AmazonLightsail
getStaticIpsRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public ImportKeyPairResult importKeyPair(ImportKeyPairRequest request)
Imports a public SSH key from a specific key pair.
importKeyPair
in interface AmazonLightsail
importKeyPairRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public IsVpcPeeredResult isVpcPeered(IsVpcPeeredRequest request)
Returns a Boolean value indicating whether your Lightsail VPC is peered.
isVpcPeered
in interface AmazonLightsail
isVpcPeeredRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public OpenInstancePublicPortsResult openInstancePublicPorts(OpenInstancePublicPortsRequest request)
Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol.
The OpenInstancePublicPorts
action supports tag-based access control via resource tags applied to
the resource identified by instanceName
. For more information, see the Amazon Lightsail Developer Guide.
openInstancePublicPorts
in interface AmazonLightsail
openInstancePublicPortsRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public PeerVpcResult peerVpc(PeerVpcRequest request)
Peers the Lightsail VPC with the user's default VPC.
peerVpc
in interface AmazonLightsail
peerVpcRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public PutAlarmResult putAlarm(PutAlarmRequest request)
Creates or updates an alarm, and associates it with the specified metric.
An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
When this action creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA
. The
alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then
executed.
When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm. The alarm is then evaluated with the updated configuration.
putAlarm
in interface AmazonLightsail
putAlarmRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.NotFoundException
- Lightsail throws this exception when it cannot find a resource.public PutInstancePublicPortsResult putInstancePublicPorts(PutInstancePublicPortsRequest request)
Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the
instance through the ports, and the protocol. This action also closes all currently open ports that are not
included in the request. Include all of the ports and the protocols you want to open in your
PutInstancePublicPorts
request. Or use the OpenInstancePublicPorts
action to open ports
without closing currently open ports.
The PutInstancePublicPorts
action supports tag-based access control via resource tags applied to the
resource identified by instanceName
. For more information, see the Amazon Lightsail Developer Guide.
putInstancePublicPorts
in interface AmazonLightsail
putInstancePublicPortsRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public RebootInstanceResult rebootInstance(RebootInstanceRequest request)
Restarts a specific instance.
The reboot instance
operation supports tag-based access control via resource tags applied to the
resource identified by instance name
. For more information, see the Amazon Lightsail Developer Guide.
rebootInstance
in interface AmazonLightsail
rebootInstanceRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public RebootRelationalDatabaseResult rebootRelationalDatabase(RebootRelationalDatabaseRequest request)
Restarts a specific database in Amazon Lightsail.
The reboot relational database
operation supports tag-based access control via resource tags applied
to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.
rebootRelationalDatabase
in interface AmazonLightsail
rebootRelationalDatabaseRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public RegisterContainerImageResult registerContainerImage(RegisterContainerImageRequest request)
Registers a container image to your Amazon Lightsail container service.
This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide.
registerContainerImage
in interface AmazonLightsail
registerContainerImageRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public ReleaseStaticIpResult releaseStaticIp(ReleaseStaticIpRequest request)
Deletes a specific static IP from your account.
releaseStaticIp
in interface AmazonLightsail
releaseStaticIpRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public ResetDistributionCacheResult resetDistributionCache(ResetDistributionCacheRequest request)
Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution.
After resetting the cache, the next time a content request is made, your distribution pulls, serves, and caches it from the origin.
resetDistributionCache
in interface AmazonLightsail
resetDistributionCacheRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public SendContactMethodVerificationResult sendContactMethodVerification(SendContactMethodVerificationRequest request)
Sends a verification request to an email contact method to ensure it's owned by the requester. SMS contact methods don't need to be verified.
A contact method is used to send you notifications about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each Amazon Web Services Region. However, SMS text messaging is not supported in some Amazon Web Services Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notifications in Amazon Lightsail.
A verification request is sent to the contact method when you initially create it. Use this action to send another verification request if a previous verification request was deleted, or has expired.
Notifications are not sent to an email contact method until after it is verified, and confirmed as valid.
sendContactMethodVerification
in interface AmazonLightsail
sendContactMethodVerificationRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
OperationFailureException
- Lightsail throws this exception when an operation fails to execute.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.NotFoundException
- Lightsail throws this exception when it cannot find a resource.public SetIpAddressTypeResult setIpAddressType(SetIpAddressTypeRequest request)
Sets the IP address type for an Amazon Lightsail resource.
Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the specified resource. Alternately, you can use this action to disable dual-stack, and enable IPv4 only.
setIpAddressType
in interface AmazonLightsail
setIpAddressTypeRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public SetResourceAccessForBucketResult setResourceAccessForBucket(SetResourceAccessForBucketRequest request)
Sets the Amazon Lightsail resources that can access the specified Lightsail bucket.
Lightsail buckets currently support setting access for Lightsail instances in the same Amazon Web Services Region.
setResourceAccessForBucket
in interface AmazonLightsail
setResourceAccessForBucketRequest
- AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.ServiceException
- A general service exception.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public StartInstanceResult startInstance(StartInstanceRequest request)
Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the
reboot instance
operation.
When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.
The start instance
operation supports tag-based access control via resource tags applied to the
resource identified by instance name
. For more information, see the Amazon Lightsail Developer Guide.
startInstance
in interface AmazonLightsail
startInstanceRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public StartRelationalDatabaseResult startRelationalDatabase(StartRelationalDatabaseRequest request)
Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the
reboot relational database
operation.
The start relational database
operation supports tag-based access control via resource tags applied
to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.
startRelationalDatabase
in interface AmazonLightsail
startRelationalDatabaseRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public StopInstanceResult stopInstance(StopInstanceRequest request)
Stops a specific Amazon Lightsail instance that is currently running.
When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide.
The stop instance
operation supports tag-based access control via resource tags applied to the
resource identified by instance name
. For more information, see the Amazon Lightsail Developer Guide.
stopInstance
in interface AmazonLightsail
stopInstanceRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public StopRelationalDatabaseResult stopRelationalDatabase(StopRelationalDatabaseRequest request)
Stops a specific database that is currently running in Amazon Lightsail.
The stop relational database
operation supports tag-based access control via resource tags applied
to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.
stopRelationalDatabase
in interface AmazonLightsail
stopRelationalDatabaseRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public TagResourceResult tagResource(TagResourceRequest request)
Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the Amazon Lightsail Developer Guide.
The tag resource
operation supports tag-based access control via request tags and resource tags
applied to the resource identified by resource name
. For more information, see the Amazon Lightsail Developer Guide.
tagResource
in interface AmazonLightsail
tagResourceRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public TestAlarmResult testAlarm(TestAlarmRequest request)
Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification trigger is configured
for the specified alarm, the test also sends a notification to the notification protocol (Email
and/or SMS
) configured for the alarm.
An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail.
testAlarm
in interface AmazonLightsail
testAlarmRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
OperationFailureException
- Lightsail throws this exception when an operation fails to execute.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.NotFoundException
- Lightsail throws this exception when it cannot find a resource.public UnpeerVpcResult unpeerVpc(UnpeerVpcRequest request)
Unpeers the Lightsail VPC from the user's default VPC.
unpeerVpc
in interface AmazonLightsail
unpeerVpcRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public UntagResourceResult untagResource(UntagResourceRequest request)
Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.
The untag resource
operation supports tag-based access control via request tags and resource tags
applied to the resource identified by resource name
. For more information, see the Amazon Lightsail Developer Guide.
untagResource
in interface AmazonLightsail
untagResourceRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public UpdateBucketResult updateBucket(UpdateBucketRequest request)
Updates an existing Amazon Lightsail bucket.
Use this action to update the configuration of an existing bucket, such as versioning, public accessibility, and the Amazon Web Services accounts that can access the bucket.
updateBucket
in interface AmazonLightsail
updateBucketRequest
- AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.ServiceException
- A general service exception.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public UpdateBucketBundleResult updateBucketBundle(UpdateBucketBundleRequest request)
Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.
A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. You can update a
bucket's bundle only one time within a monthly AWS billing cycle. To determine if you can update a bucket's
bundle, use the GetBuckets action.
The ableToUpdateBundle
parameter in the response will indicate whether you can currently update a
bucket's bundle.
Update a bucket's bundle if it's consistently going over its storage space or data transfer quota, or if a bucket's usage is consistently in the lower range of its storage space or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might experience, we strongly recommend that you update a bucket's bundle only as a long-term strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle that will provide the bucket with ample storage space and data transfer for a long time to come.
updateBucketBundle
in interface AmazonLightsail
updateBucketBundleRequest
- AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.ServiceException
- A general service exception.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public UpdateContainerServiceResult updateContainerService(UpdateContainerServiceRequest request)
Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain names.
updateContainerService
in interface AmazonLightsail
updateContainerServiceRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public UpdateDistributionResult updateDistribution(UpdateDistributionRequest request)
Updates an existing Amazon Lightsail content delivery network (CDN) distribution.
Use this action to update the configuration of your existing distribution.
updateDistribution
in interface AmazonLightsail
updateDistributionRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public UpdateDistributionBundleResult updateDistributionBundle(UpdateDistributionBundleRequest request)
Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.
A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution.
Update your distribution's bundle if your distribution is going over its monthly network transfer quota and is incurring an overage fee.
You can update your distribution's bundle only one time within your monthly AWS billing cycle. To determine if
you can update your distribution's bundle, use the GetDistributions
action. The
ableToUpdateBundle
parameter in the result will indicate whether you can currently update your
distribution's bundle.
updateDistributionBundle
in interface AmazonLightsail
updateDistributionBundleRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public UpdateDomainEntryResult updateDomainEntry(UpdateDomainEntryRequest request)
Updates a domain recordset after it is created.
The update domain entry
operation supports tag-based access control via resource tags applied to the
resource identified by domain name
. For more information, see the Amazon Lightsail Developer Guide.
updateDomainEntry
in interface AmazonLightsail
updateDomainEntryRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public UpdateLoadBalancerAttributeResult updateLoadBalancerAttribute(UpdateLoadBalancerAttributeRequest request)
Updates the specified attribute for a load balancer. You can only update one attribute at a time.
The update load balancer attribute
operation supports tag-based access control via resource tags
applied to the resource identified by load balancer name
. For more information, see the Amazon Lightsail Developer Guide.
updateLoadBalancerAttribute
in interface AmazonLightsail
updateLoadBalancerAttributeRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public UpdateRelationalDatabaseResult updateRelationalDatabase(UpdateRelationalDatabaseRequest request)
Allows the update of one or more attributes of a database in Amazon Lightsail.
Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database's predefined maintenance window.
The update relational database
operation supports tag-based access control via resource tags applied
to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.
updateRelationalDatabase
in interface AmazonLightsail
updateRelationalDatabaseRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public UpdateRelationalDatabaseParametersResult updateRelationalDatabaseParameters(UpdateRelationalDatabaseParametersRequest request)
Allows the update of one or more parameters of a database in Amazon Lightsail.
Parameter updates don't cause outages; therefore, their application is not subject to the preferred maintenance
window. However, there are two ways in which parameter updates are applied: dynamic
or
pending-reboot
. Parameters marked with a dynamic
apply type are applied immediately.
Parameters marked with a pending-reboot
apply type are applied only after the database is rebooted
using the reboot relational database
operation.
The update relational database parameters
operation supports tag-based access control via resource
tags applied to the resource identified by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide.
updateRelationalDatabaseParameters
in interface AmazonLightsail
updateRelationalDatabaseParametersRequest
- ServiceException
- A general service exception.InvalidInputException
- Lightsail throws this exception when user input does not conform to the validation rules of an input
field.
Domain and distribution APIs are only available in the N. Virginia (us-east-1
) Amazon Web
Services Region. Please set your Amazon Web Services Region configuration to us-east-1
to
create, view, or edit these resources.
NotFoundException
- Lightsail throws this exception when it cannot find a resource.OperationFailureException
- Lightsail throws this exception when an operation fails to execute.AccessDeniedException
- Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to
access a resource.AccountSetupInProgressException
- Lightsail throws this exception when an account is still in the setup in progress state.UnauthenticatedException
- Lightsail throws this exception when the user has not been authenticated.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AmazonLightsail
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonLightsail
shutdown
in class AmazonWebServiceClient