Skip to content

Examples#

Index > Snowball > Examples

Auto-generated documentation for Snowball type annotations stubs module types-aiobotocore-snowball.

Client#

Implicit type annotations#

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

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

# SnowballClient usage example

from aioboto3.session import Session


session = Session()

async with session.client("snowball") as client:  # (1)
    result = await client.create_address()  # (2)
  1. client: SnowballClient
  2. result: CreateAddressResultTypeDef
# DescribeAddressesPaginator usage example

from aioboto3.session import Session


session = Session()

async with session.client("snowball") as client:  # (1)
    paginator = client.get_paginator("describe_addresses")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)
  1. client: SnowballClient
  2. paginator: DescribeAddressesPaginator
  3. item: DescribeAddressesResultTypeDef

Explicit type annotations#

With types-aioboto3-lite[snowball] or a standalone types_aiobotocore_snowball package, you have to explicitly specify client: SnowballClient 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.

# SnowballClient usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_snowball.client import SnowballClient
from types_aiobotocore_snowball.type_defs import CreateAddressResultTypeDef
from types_aiobotocore_snowball.type_defs import CreateAddressRequestRequestTypeDef


session = Session()

client: SnowballClient
async with session.client("snowball") as client:  # (1)
    kwargs: CreateAddressRequestRequestTypeDef = {...}  # (2)
    result: CreateAddressResultTypeDef = await client.create_address(**kwargs)  # (3)
  1. client: SnowballClient
  2. kwargs: CreateAddressRequestRequestTypeDef
  3. result: CreateAddressResultTypeDef
# DescribeAddressesPaginator usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_snowball.client import SnowballClient
from types_aiobotocore_snowball.paginator import DescribeAddressesPaginator
from types_aiobotocore_snowball.type_defs import DescribeAddressesResultTypeDef


session = Session()

client: SnowballClient
async with session.client("snowball") as client:  # (1)
    paginator: DescribeAddressesPaginator = client.get_paginator("describe_addresses")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeAddressesResultTypeDef
        print(item)  # (3)
  1. client: SnowballClient
  2. paginator: DescribeAddressesPaginator
  3. item: DescribeAddressesResultTypeDef