Skip to content

FreeTier module#

Index > FreeTier

Auto-generated documentation for FreeTier type annotations stubs module mypy-boto3-freetier.

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 FreeTier.

From PyPI with pip#

Install boto3-stubs for FreeTier service.

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


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


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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

FreeTierClient#

Type annotations and code completion for boto3.client("freetier") as FreeTierClient boto3 documentation

# FreeTierClient usage example

from boto3.session import Session

from mypy_boto3_freetier.client import FreeTierClient

def get_client() -> FreeTierClient:
    return Session().client("freetier")

Paginators#

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

# GetFreeTierUsagePaginator usage example

from boto3.session import Session

from mypy_boto3_freetier.paginator import GetFreeTierUsagePaginator

def get_get_free_tier_usage_paginator() -> GetFreeTierUsagePaginator:
    return Session().client("freetier").get_paginator("get_free_tier_usage"))

Literals#

Type annotations for literals used in methods and schema.

# DimensionType usage example

from mypy_boto3_freetier.literals import DimensionType

def get_value() -> DimensionType:
    return "DESCRIPTION"

Type definitions#

Type annotations for type definitions used in methods and schema.