Get Bundles

lightsail_get_bundles

R Documentation

Returns the bundles that you can apply to an Amazon Lightsail instance when you create it¶

Description¶

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.

Usage¶

lightsail_get_bundles(includeInactive, pageToken, appCategory)

Arguments¶

includeInactive

A Boolean value that indicates whether to include inactive (unavailable) bundles in the response of your request.

pageToken

The token to advance to the next page of results from your request.

To get a page token, perform an initial get_bundles request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

appCategory

Returns a list of bundles that are specific to Lightsail for Research.

You must use this parameter to view Lightsail for Research bundles.

Value¶

A list with the following syntax:

list(
  bundles = list(
    list(
      price = 123.0,
      cpuCount = 123,
      diskSizeInGb = 123,
      bundleId = "string",
      instanceType = "string",
      isActive = TRUE|FALSE,
      name = "string",
      power = 123,
      ramSizeInGb = 123.0,
      transferPerMonthInGb = 123,
      supportedPlatforms = list(
        "LINUX_UNIX"|"WINDOWS"
      ),
      supportedAppCategories = list(
        "LfR"
      ),
      publicIpv4AddressCount = 123
    )
  ),
  nextPageToken = "string"
)

Request syntax¶

svc$get_bundles(
  includeInactive = TRUE|FALSE,
  pageToken = "string",
  appCategory = "LfR"
)