Lightsail / Client / get_bundles

get_bundles#

Lightsail.Client.get_bundles(**kwargs)#

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.

Note

Bundles are referred to as instance plans in the Lightsail console.

See also: AWS API Documentation

Request Syntax

response = client.get_bundles(
    includeInactive=True|False,
    pageToken='string',
    appCategory='LfR'
)
Parameters:

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

  • pageToken (string) –

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

    To get a page token, perform an initial GetBundles 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 (string) –

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

    Warning

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

Return type:

dict

Returns:

Response Syntax

{
    'bundles': [
        {
            'price': ...,
            'cpuCount': 123,
            'diskSizeInGb': 123,
            'bundleId': 'string',
            'instanceType': 'string',
            'isActive': True|False,
            'name': 'string',
            'power': 123,
            'ramSizeInGb': ...,
            'transferPerMonthInGb': 123,
            'supportedPlatforms': [
                'LINUX_UNIX'|'WINDOWS',
            ],
            'supportedAppCategories': [
                'LfR',
            ],
            'publicIpv4AddressCount': 123
        },
    ],
    'nextPageToken': 'string'
}

Response Structure

  • (dict) –

    • bundles (list) –

      An array of key-value pairs that contains information about the available bundles.

      • (dict) –

        Describes a bundle, which is a set of specs describing your virtual private server (or instance).

        • price (float) –

          The price in US dollars ( 5.0) of the bundle.

        • cpuCount (integer) –

          The number of vCPUs included in the bundle ( 2).

        • diskSizeInGb (integer) –

          The size of the SSD ( 30).

        • bundleId (string) –

          The bundle ID ( micro_x_x).

        • instanceType (string) –

          The instance type ( micro).

        • isActive (boolean) –

          A Boolean value indicating whether the bundle is active.

        • name (string) –

          A friendly name for the bundle ( Micro).

        • power (integer) –

          A numeric value that represents the power of the bundle ( 500). You can use the bundle’s power value in conjunction with a blueprint’s minimum power value to determine whether the blueprint will run on the bundle. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500.

        • ramSizeInGb (float) –

          The amount of RAM in GB ( 2.0).

        • transferPerMonthInGb (integer) –

          The data transfer rate per month in GB ( 2000).

        • supportedPlatforms (list) –

          The operating system platform (Linux/Unix-based or Windows Server-based) that the bundle supports. You can only launch a WINDOWS bundle on a blueprint that supports the WINDOWS platform. LINUX_UNIX blueprints require a LINUX_UNIX bundle.

          • (string) –

        • supportedAppCategories (list) –

          Virtual computer blueprints that are supported by a Lightsail for Research bundle.

          Warning

          This parameter only applies to Lightsail for Research resources.

          • (string) –

        • publicIpv4AddressCount (integer) –

          An integer that indicates the public ipv4 address count included in the bundle, the value is either 0 or 1.

    • nextPageToken (string) –

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

      A next page token is not returned if there are no more results to display.

      To get the next page of results, perform another GetBundles request and specify the next page token using the pageToken parameter.

Exceptions