Skip to content

Snowball module

Index > Snowball

Auto-generated documentation for Snowball type annotations stubs module mypy-boto3-snowball.

How to install

VSCode extension

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

Click Modify and select boto3 common and Snowball.

From PyPI with pip

Install boto3-stubs for Snowball service.

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


# 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[snowball]'


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

How to uninstall

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

Usage

Code samples can be found in Examples.

SnowballClient

Type annotations and code completion for boto3.client("snowball") as SnowballClient boto3 documentation

Usage example
from boto3.session import Session

from mypy_boto3_snowball.client import SnowballClient

def get_client() -> SnowballClient:
    return Session().client("snowball")

Paginators

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

Usage example
from boto3.session import Session

from mypy_boto3_snowball.paginator import DescribeAddressesPaginator

def get_describe_addresses_paginator() -> DescribeAddressesPaginator:
    return Session().client("snowball").get_paginator("describe_addresses"))

Literals

Type annotations for literals used in methods and schemas.

Usage example
from mypy_boto3_snowball.literals import ClusterStateType

def get_value() -> ClusterStateType:
    return "AwaitingQuorum"

Typed dictionaries

Type annotations for typed dictionaries used in methods and schema.

Usage example
from mypy_boto3_snowball.type_defs import AddressTypeDef

def get_value() -> AddressTypeDef:
    return {
        "AddressId": ...,
    }