Skip to content

EBS module#

Index > EBS

Auto-generated documentation for EBS type annotations stubs module mypy-boto3-ebs.

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

From PyPI with pip#

Install boto3-stubs for EBS service.

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


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


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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

EBSClient#

Type annotations and code completion for boto3.client("ebs") as EBSClient boto3 documentation

# EBSClient usage example

from boto3.session import Session

from mypy_boto3_ebs.client import EBSClient

def get_client() -> EBSClient:
    return Session().client("ebs")

Literals#

Type annotations for literals used in methods and schemas.

# ChecksumAggregationMethodType usage example

from mypy_boto3_ebs.literals import ChecksumAggregationMethodType

def get_value() -> ChecksumAggregationMethodType:
    return "LINEAR"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# BlockTypeDef usage example

from mypy_boto3_ebs.type_defs import BlockTypeDef

def get_value() -> BlockTypeDef:
    return {
        "BlockIndex": ...,
    }