Lightsail / Paginator / GetBundles

GetBundles#

class Lightsail.Paginator.GetBundles#

paginator = client.get_paginator('get_bundles')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from Lightsail.Client.get_bundles().

Request Syntax

response_iterator = paginator.paginate(
    includeInactive=True|False,
    appCategory='LfR',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters:

includeInactive (boolean) – A Boolean value that indicates whether to include inactive (unavailable) bundles in the response of your 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.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

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
        },
    ],
    'NextToken': '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.
- NextToken (string) –
  
  A token to resume pagination.