Skip to content

Lightsail module#

Index > Lightsail

Auto-generated documentation for Lightsail type annotations stubs module mypy-boto3-lightsail.

How to install#

You can generate type annotations for boto3 package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.36.26' mypy-boto3-builder
  2. Select boto3-stubs AWS SDK.
  3. Add Lightsail service.
  4. Use provided commands to install generated packages.

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and Lightsail.

From PyPI with pip#

Install boto3-stubs for Lightsail service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[lightsail]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[lightsail]'

# standalone installation
python -m pip install mypy-boto3-lightsail

How to uninstall#

python -m pip uninstall -y mypy-boto3-lightsail

Usage#

Code samples can be found in Examples.

LightsailClient#

Type annotations and code completion for boto3.client("lightsail") as LightsailClient boto3 documentation

# LightsailClient usage example

from boto3.session import Session

from mypy_boto3_lightsail.client import LightsailClient

def get_client() -> LightsailClient:
    return Session().client("lightsail")

Paginators#

Type annotations and code completion for paginators from boto3.client("lightsail").get_paginator("...").

# GetActiveNamesPaginator usage example

from boto3.session import Session

from mypy_boto3_lightsail.paginator import GetActiveNamesPaginator

def get_get_active_names_paginator() -> GetActiveNamesPaginator:
    return Session().client("lightsail").get_paginator("get_active_names"))

Literals#

Type annotations for literals used in methods and schema.

# AccessDirectionType usage example

from mypy_boto3_lightsail.literals import AccessDirectionType

def get_value() -> AccessDirectionType:
    return "inbound"

Type definitions#

Type annotations for type definitions used in methods and schema.