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