Skip to content

PI module#

Index > PI

Auto-generated documentation for PI type annotations stubs module mypy-boto3-pi.

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

From PyPI with pip#

Install boto3-stubs for PI service.

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


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


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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

PIClient#

Type annotations and code completion for boto3.client("pi") as PIClient boto3 documentation

# PIClient usage example

from boto3.session import Session

from mypy_boto3_pi.client import PIClient

def get_client() -> PIClient:
    return Session().client("pi")

Literals#

Type annotations for literals used in methods and schemas.

# DetailStatusType usage example

from mypy_boto3_pi.literals import DetailStatusType

def get_value() -> DetailStatusType:
    return "AVAILABLE"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# DataPointTypeDef usage example

from mypy_boto3_pi.type_defs import DataPointTypeDef

def get_value() -> DataPointTypeDef:
    return {
        "Timestamp": ...,
        "Value": ...,
    }