Data retrieval APIs for Amazon Lightsail
Amazon Lightsail provides the following APIs for data retrieval.
| Actions | Description | Access level |
|---|---|---|
| GetActiveNames | Get the names of all active (not deleted) resources | Read |
| GetAlarms | View information about the configured alarms | Read |
| GetAutoSnapshots | View the available automatic snapshots for an instance or disk | Read |
| GetBlueprints | Get a list of instance images, or blueprints. You can use a blueprint to create a new instance already running a specific operating system, as well as a pre-installed application or development stack. The software that runs on your instance depends on the blueprint you define when creating the instance | Read |
| GetBucketAccessKeys | Get the existing access key IDs for the specified Amazon Lightsail bucket | Read |
| GetBucketBundles | Get the bundles that can be applied to an Amazon Lightsail bucket | Read |
| GetBucketMetricData | Get the data points of a specific metric for an Amazon Lightsail bucket | Read |
| GetBuckets | Get information about one or more Amazon Lightsail buckets | Read |
| GetBundles | Get a list of instance bundles. You can use a bundle to create a new instance with a set of performance specifications, such as CPU count, disk size, RAM size, and network transfer allowance. The cost of your instance depends on the bundle you define when creating the instance | Read |
| GetCertificates | View information about one or more Amazon Lightsail SSL/TLS certificates | Read |
| GetCloudFormationStackRecords | Get information about all CloudFormation stacks used to create Amazon EC2 resources from exported Amazon Lightsail snapshots | Read |
| GetContactMethods | View information about the configured contact methods | Read |
| GetContainerAPIMetadata | View information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin | Read |
| GetContainerImages | View the container images that are registered to your Amazon Lightsail container service | Read |
| GetContainerLog | View the log events of a container of your Amazon Lightsail container service | Read |
| GetContainerServiceDeployments | View the deployments for your Amazon Lightsail container service | Read |
| GetContainerServiceMetricData | View the data points of a specific metric of your Amazon Lightsail container service | Read |
| GetContainerServicePowers | View the list of powers that can be specified for your Amazon Lightsail container services | Read |
| GetContainerServices | View information about one or more of your Amazon Lightsail container services | Read |
| GetCostEstimate | Get the information about the cost estimate for a specified resource | Read |
| GetDisk | Get information about a disk | Read |
| GetDiskSnapshot | Get information about a disk snapshot | Read |
| GetDiskSnapshots | Get information about all disk snapshots | Read |
| GetDisks | Get information about all disks | Read |
| GetDistributionBundles | View the list of bundles that can be applied to you Amazon Lightsail content delivery network (CDN) distributions | Read |
| GetDistributionLatestCacheReset | View the timestamp and status of the last cache reset of a specific Amazon Lightsail content delivery network (CDN) distribution | Read |
| GetDistributionMetricData | View the data points of a specific metric for an Amazon Lightsail content delivery network (CDN) distribution | Read |
| GetDistributions | View information about one or more of your Amazon Lightsail content delivery network (CDN) distributions | Read |
| GetDomain | Get DNS records for a domain resource | Read |
| GetDomains | Get DNS records for all domain resources | Read |
| GetExportSnapshotRecords | Get information about all records of exported Amazon Lightsail snapshots to Amazon EC2 | Read |
| GetInstance | Get information about an instance | Read |
| GetInstanceMetricData | Get the data points for the specified metric of an instance | Read |
| GetInstancePortStates | Get the port states of an instance | Read |
| GetInstanceSnapshot | Get information about an instance snapshot | Read |
| GetInstanceSnapshots | Get information about all instance snapshots | Read |
| GetInstanceState | Get the state of an instance | Read |
| GetInstances | Get information about all instances | Read |
| GetKeyPair | Get information about a key pair | Read |
| GetKeyPairs | Get information about all key pairs | Read |
| GetLoadBalancer | Get information about a load balancer | Read |
| GetLoadBalancerMetricData | Get the data points for the specified metric of a load balancer | Read |
| GetLoadBalancerTlsCertificates | Get information about a load balancer's TLS certificates | Read |
| GetLoadBalancerTlsPolicies | Get a list of TLS security policies that you can apply to Lightsail load balancers | Read |
| GetLoadBalancers | Get information about load balancers | Read |
| GetOperation | Get information about an operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on | Read |
| GetOperations | Get information about all operations. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on | Read |
| GetOperationsForResource | Get operations for a resource | Read |
| GetRegions | Get a list of all valid AWS Regions for Amazon Lightsail | Read |
| GetRelationalDatabase | Get information about a relational database | Read |
| GetRelationalDatabaseBlueprints | Get a list of relational database images, or blueprints. You can use a blueprint to create a new database running a specific database engine. The database engine that runs on your database depends on the blueprint you define when creating the relational database | Read |
| GetRelationalDatabaseBundles | Get a list of relational database bundles. You can use a bundle to create a new database with a set of performance specifications, such as CPU count, disk size, RAM size, network transfer allowance, and standard of high availability. The cost of your database depends on the bundle you define when creating the relational database | Read |
| GetRelationalDatabaseEvents | Get events for a relational database | Read |
| GetRelationalDatabaseLogEvents | Get events for the specified log stream of a relational database | Read |
| GetRelationalDatabaseLogStreams | Get the log streams available for a relational database | Read |
| GetRelationalDatabaseMetricData | Get the data points for the specified metric of a relational database | Read |
| GetRelationalDatabaseParameters | Get the parameters of a relational database | Read |
| GetRelationalDatabaseSnapshot | Get information about a relational database snapshot | Read |
| GetRelationalDatabaseSnapshots | Get information about all relational database snapshots | Read |
| GetRelationalDatabases | Get information about all relational databases | Read |
| GetSetupHistory | Get detailed information for setup requests that were run on the specified resource | Read |
| GetStaticIp | Get information about a static IP | Read |
| GetStaticIps | Get information about all static IPs | Read |
| IsVpcPeered | Get a boolean value indicating whether the Amazon Lightsail virtual private cloud (VPC) is peered | Read |
