Lightsail / Client / get_blueprints

get_blueprints#

Lightsail.Client.get_blueprints(**kwargs)#

Returns the list of available instance images, or blueprints. You can use a blueprint to create a new instance already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.

Note

Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.

See also: AWS API Documentation

Request Syntax

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

  • includeInactive (boolean) – A Boolean value that indicates whether to include inactive (unavailable) blueprints 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 GetBlueprints 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 blueprints that are specific to Lightsail for Research.

    Warning

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

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'
        },
    ],
    'nextPageToken': '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 ( app_wordpress_x_x or app_lamp_x_x).

        • name (string) –

          The friendly name of the blueprint ( Amazon Linux).

        • group (string) –

          The group name of the blueprint ( amazon-linux).

        • type (string) –

          The type of the blueprint ( 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 ( 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.

    • 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 GetBlueprints request and specify the next page token using the pageToken parameter.

Exceptions