Amazon Lightsail for Research
actions
You can use the following API actions, which are part of the Lightsail API, to manage Amazon Lightsail for Research resources. Choose the name of the action to view more information about that action. For more information about Lightsail for Research, see the Amazon Lightsail for Research User Guide.
Lightsail for Research actions
-
AddOnRequest - Describes a request to enable, modify, or disable an add-on for an Amazon Lightsail or Lightsail for Research resource. Valid values are
AutoSnapshot | StopInstanceOnIdle
. -
CreateGUISessionAccessDetails - Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session.
-
GetCostEstimate - Retrieves information about the cost estimate for a specified resource.
-
StartGUISession - Initiates a Amazon DCV GUI session that’s used to access a virtual computer’s operating system or application. The session will be active for 1 hour. Use this action to resume the session after it expires.
-
StopGUISession - Terminates a web-based Amazon DCV GUI 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.
Virtual computer and instance actions
-
CreateInstances - Creates one or more virtual computers.
-
DeleteInstance - Deletes a virtual computer.
-
GetBlueprints - Returns the list of available virtual computer applications, or blueprints.
-
GetBundles - Returns the hardware bundles that you can apply to a virtual computer when you create it.
-
GetInstance - Returns information about a specific virtual computer or instance.
-
GetInstanceMetricData - Returns the data points for the specified virtual computer metric, given an virtual computer name.
-
GetInstances - Returns information about all Lightsail instances and Lightsail for Research virtual computers in the user's account.
-
GetInstanceState - Returns the state of a specific virtual computer or instance.
-
RebootInstance - Restarts a specific virtual computer.
-
StartInstance - Starts a specific virtual computer from a stopped state. To restart a virtual computer, use the
reboot instance
operation. -
StopInstance - Stops a specific virtual computer that is currently running.
-
UpdateInstanceMetadataOptions - Modifies the virtual computer metadata parameters on a running or stopped virtual computer.
Disk actions
-
AttachDisk - Attaches a block storage disk to a running or stopped virtual computer, and exposes it to the virtual computer with the specified disk name.
-
CreateDisk - Creates a block storage disk that can be attached to a virtual computer in the same AWS Region.
-
DeleteDisk - Deletes the specified block storage disk.
-
DetachDisk - Detaches a stopped block storage disk from a virtual computer.
-
GetDisk - Returns information about a specific block storage disk.
-
GetDisks - Returns information about all block storage disks in your AWS account and region.
Key pair actions
-
CreateKeyPair - Creates a custom SSH key pair that you can use with a Lightsail for Research virtual computer.
-
DeleteKeyPair - Deletes the specified key pair by removing the public key from Amazon Lightsail.
-
DownloadDefaultKeyPair - Downloads the regional Lightsail default key pair. This action also creates a Lightsail default key pair if a default key pair does not currently exist in the AWS Region.
-
GetInstanceAccessDetails - Returns temporary SSH keys you can use to connect to a specific virtual computer.
-
GetKeyPair - Returns information about a specific key pair.
-
GetKeyPairs - Returns information about all key pairs in the user's account.
-
ImportKeyPair - Imports the public SSH key from a specific key pair.
Networking actions
-
GetInstancePortStates - Returns the firewall port states for a specific virtual computer, the IP addresses allowed to connect to the virtual computer through the ports, and the protocol.
-
IsVpcPeered - Returns a Boolean value indicating whether your Lightsail VPC is peered.
-
OpenInstancePublicPorts - Opens ports for a specific virtual computer, and specifies the IP addresses allowed to connect to the virtual computer through the ports, and the protocol.
-
PutInstancePublicPorts - Opens ports for a specific virtual computer, and specifies the IP addresses allowed to connect to the virtual computer through the ports, and the protocol.
-
PeerVpc - Peers the Lightsail VPC with the user's default VPC.
-
SetIpAddressType - Sets the IP address type for a virtual computer.
-
UnpeerVpc - Unpeers the Lightsail VPC from the user's default VPC.
Snapshot actions
-
CopySnapshot - Copies a manual snapshot of an virtual computer or disk as another manual snapshot, or copies an automatic snapshot of an virtual computer or disk as a manual snapshot.
-
CreateDiskFromSnapshot - Creates a block storage disk from a manual or automatic snapshot of a disk.
-
CreateDiskSnapshot - Creates a snapshot of a block storage disk.
-
CreateInstancesFromSnapshot - Creates one or more new virtual computers from a manual or automatic snapshot of a virtual computer.
-
CreateInstanceSnapshot - Creates a snapshot of a specific virtual computer.
-
DeleteAutoSnapshot - Deletes an automatic snapshot of a virtual computer or disk.
-
DeleteDiskSnapshot - Deletes a specific snapshot of a disk.
-
DeleteInstanceSnapshot - Deletes a specific snapshot of a virtual computer.
-
ExportSnapshot - Exports a virtual computer or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2).
-
GetDiskSnapshot - Returns information about a specific block storage disk snapshot.
-
GetDiskSnapshots - Returns information about all block storage disk snapshots in your AWS account and region.
-
GetExportSnapshotRecords - Returns all export snapshot records created as a result of the export snapshot operation.
-
GetInstanceSnapshot - Returns information about a specific virtual computer snapshot.
-
GetInstanceSnapshots - Returns all virtual computer snapshots for the user's account.
Tag actions
-
TagResource - Adds one or more tags to the specified resource.
-
UntagResource - Deletes the specified set of tag keys and their values from the specified resource.
Additional resource actions
-
GetActiveNames - Returns the names of all active (not deleted) resources.
-
GetOperation - Returns information about a specific operation. Operations include events such as when you create a virtual computer, attach a disk, and so on.
-
GetOperations - 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. -
GetOperationsForResource - Gets operations for a specific resource, such as a virtual computer or a disk.
-
GetRegions - Returns a list of all valid AWS Regions for Lightsail. Use the
include availability zones
parameter to also return the Availability Zones in a region.