Examples

Index > Lightsail > Examples

Auto-generated documentation for Lightsail type annotations stubs module types-aiobotocore-lightsail.

Client

Implicit type annotations

Can be used with types-aioboto3[lightsail] package installed.

Write your Lightsail code as usual, type checking and code completion should work out of the box.

ClientPaginators

Client usage example

from aioboto3.session import Session


session = Session()

async with session.client("lightsail") as client:  # (1)
    result = await client.allocate_static_ip()  # (2)

1. client: LightsailClient
2. result: AllocateStaticIpResultTypeDef

Paginator usage example

from aioboto3.session import Session


session = Session()

async with session.client("lightsail") as client:  # (1)
    paginator = client.get_paginator("get_active_names")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)

1. client: LightsailClient
2. paginator: GetActiveNamesPaginator
3. item: GetActiveNamesResultTypeDef

Explicit type annotations

With types-aioboto3-lite[lightsail] or a standalone types_aiobotocore_lightsail package, you have to explicitly specify client: LightsailClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

ClientPaginators

Client usage example

from aioboto3.session import Session

from types_aiobotocore_lightsail.client import LightsailClient
from types_aiobotocore_lightsail.type_defs import AllocateStaticIpResultTypeDef
from types_aiobotocore_lightsail.type_defs import AllocateStaticIpRequestRequestTypeDef


session = Session()

client: LightsailClient
async with session.client("lightsail") as client:  # (1)
    kwargs: AllocateStaticIpRequestRequestTypeDef = {...}  # (2)
    result: AllocateStaticIpResultTypeDef = await client.allocate_static_ip(**kwargs)  # (3)

1. client: LightsailClient
2. kwargs: AllocateStaticIpRequestRequestTypeDef
3. result: AllocateStaticIpResultTypeDef

Paginator usage example

from aioboto3.session import Session

from types_aiobotocore_lightsail.client import LightsailClient
from types_aiobotocore_lightsail.paginator import GetActiveNamesPaginator
from types_aiobotocore_lightsail.type_defs import GetActiveNamesResultTypeDef


session = Session()

client: LightsailClient
async with session.client("lightsail") as client:  # (1)
    paginator: GetActiveNamesPaginator = client.get_paginator("get_active_names")  # (2)
    async for item in paginator.paginate(...):
        item: GetActiveNamesResultTypeDef
        print(item)  # (3)

1. client: LightsailClient
2. paginator: GetActiveNamesPaginator
3. item: GetActiveNamesResultTypeDef