Skip to content

Firehose module

Index > Firehose

Auto-generated documentation for Firehose type annotations stubs module mypy-boto3-firehose.

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

From PyPI with pip

Install boto3-stubs for Firehose service.

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


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


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

How to uninstall

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

Usage

Code samples can be found in Examples.

FirehoseClient

Type annotations and code completion for boto3.client("firehose") as FirehoseClient boto3 documentation

Usage example
from boto3.session import Session

from mypy_boto3_firehose.client import FirehoseClient

def get_client() -> FirehoseClient:
    return Session().client("firehose")

Literals

Type annotations for literals used in methods and schemas.

Usage example
from mypy_boto3_firehose.literals import AmazonopensearchserviceIndexRotationPeriodType

def get_value() -> AmazonopensearchserviceIndexRotationPeriodType:
    return "NoRotation"

Typed dictionaries

Type annotations for typed dictionaries used in methods and schema.

Usage example
from mypy_boto3_firehose.type_defs import AmazonopensearchserviceBufferingHintsTypeDef

def get_value() -> AmazonopensearchserviceBufferingHintsTypeDef:
    return {
        "IntervalInSeconds": ...,
    }