Lightsail / Paginator / GetBlueprints

GetBlueprints#

class Lightsail.Paginator.GetBlueprints#

paginator = client.get_paginator('get_blueprints')

paginate(**kwargs)#

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

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) blueprints in the response of your request.
appCategory (string) –
Returns a list of blueprints that are specific to Lightsail for Research.

Warning
You must use this parameter to view Lightsail for Research blueprints.
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

{
    'blueprints': [
        {
            'blueprintId': 'string',
            'name': 'string',
            'group': 'string',
            'type': 'os'|'app',
            'description': 'string',
            'isActive': True|False,
            'minPower': 123,
            'version': 'string',
            'versionCode': 'string',
            'productUrl': 'string',
            'licenseUrl': 'string',
            'platform': 'LINUX_UNIX'|'WINDOWS',
            'appCategory': 'LfR'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- blueprints (list) –
  
  An array of key-value pairs that contains information about the available blueprints.
  - (dict) –
    
    Describes a blueprint (a virtual private server image).
    - blueprintId (string) –
      
      The ID for the virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0).
    - name (string) –
      
      The friendly name of the blueprint (e.g., Amazon Linux).
    - group (string) –
      
      The group name of the blueprint (e.g., amazon-linux).
    - type (string) –
      
      The type of the blueprint (e.g., os or app).
    - description (string) –
      
      The description of the blueprint.
    - isActive (boolean) –
      
      A Boolean value indicating whether the blueprint is active. Inactive blueprints are listed to support customers with existing instances but are not necessarily available for launch of new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.
    - minPower (integer) –
      
      The minimum bundle power required to run this blueprint. 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. 0 indicates that the blueprint runs on all instance sizes.
    - version (string) –
      
      The version number of the operating system, application, or stack (e.g., 2016.03.0).
    - versionCode (string) –
      
      The version code.
    - productUrl (string) –
      
      The product URL to learn more about the image or blueprint.
    - licenseUrl (string) –
      
      The end-user license agreement URL for the image or blueprint.
    - platform (string) –
      
      The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.
    - appCategory (string) –
      
      Virtual computer blueprints that are supported by Lightsail for Research.
      
      Warning
      This parameter only applies to Lightsail for Research resources.
- NextToken (string) –
  
  A token to resume pagination.