Skip to main content

Type annotations for aiobotocore.Firehose 2.1.0 service generated by mypy-boto3-builder 6.4.2

Project description

mypy-boto3-firehose

PyPI - types-aiobotocore-firehose PyPI - Python Version Docs PyPI - Downloads

boto3.typed

Type annotations for boto3.Firehose 1.20.47 service compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.

Generated by mypy-boto3-builder 6.4.2.

More information can be found on boto3-stubs page and in types-aiobotocore-firehose docs

See how it helps to find and fix potential bugs:

boto3-stubs demo

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 types-aiobotocore for Firehose service.

python -m pip install types-aiobotocore[firehose]

Usage

VSCode

  • Install Python extension
  • Install Pylance extension
  • Set Pylance as your Python Language Server
  • Install types-aiobotocore[firehose] in your environment: python -m pip install 'types-aiobotocore[firehose]'

Both type checking and auto-complete should work for Firehose service. No explicit type annotations required, write your boto3 code as usual.

PyCharm

  • Install types-aiobotocore[firehose] in your environment: python -m pip install 'types-aiobotocore[firehose]'

Both type checking and auto-complete should work for Firehose service. No explicit type annotations required, write your aiobotocore code as usual. Auto-complete can be slow on big projects or if you have a lot of installed types-aiobotocore submodules.

Other IDEs

Not tested, but as long as your IDE supports mypy or pyright, everything should work.

mypy

  • Install mypy: python -m pip install mypy
  • Install types-aiobotocore[firehose] in your environment: python -m pip install 'types-aiobotocore[firehose]'
  • Run mypy as usual

Type checking should work for Firehose service. No explicit type annotations required, write your aiobotocore code as usual.

pyright

  • Install pyright: yarn global add pyright
  • Install types-aiobotocore[firehose] in your environment: python -m pip install 'types-aiobotocore[firehose]'
  • Optionally, you can install boto3-stubs to typings folder.

Type checking should work for Firehose service. No explicit type annotations required, write your aiobotocore code as usual.

Explicit type annotations

Client annotations

FirehoseClient provides annotations for session.create_client("firehose").

from aiobotocore.session import get_session

from types_aiobotocore_firehose import FirehoseClient

session = get_session()
with async session.create_client("firehose") as client:
    client: FirehoseClient
    # now client usage is checked by mypy and IDE should provide code auto-complete

Literals

types_aiobotocore_firehose.literals module contains literals extracted from shapes that can be used in user code for type checking.

from types_aiobotocore_firehose.literals import (
    AmazonopensearchserviceIndexRotationPeriodType,
    AmazonopensearchserviceS3BackupModeType,
    CompressionFormatType,
    ContentEncodingType,
    DeliveryStreamEncryptionStatusType,
    DeliveryStreamFailureTypeType,
    DeliveryStreamStatusType,
    DeliveryStreamTypeType,
    ElasticsearchIndexRotationPeriodType,
    ElasticsearchS3BackupModeType,
    HECEndpointTypeType,
    HttpEndpointS3BackupModeType,
    KeyTypeType,
    NoEncryptionConfigType,
    OrcCompressionType,
    OrcFormatVersionType,
    ParquetCompressionType,
    ParquetWriterVersionType,
    ProcessorParameterNameType,
    ProcessorTypeType,
    RedshiftS3BackupModeType,
    S3BackupModeType,
    SplunkS3BackupModeType,
    ServiceName,
)

def check_value(value: AmazonopensearchserviceIndexRotationPeriodType) -> bool:
    ...

Typed dictionaries

types_aiobotocore_firehose.type_defs module contains structures and shapes assembled to typed dictionaries for additional type checking.

from types_aiobotocore_firehose.type_defs import (
    AmazonopensearchserviceBufferingHintsTypeDef,
    AmazonopensearchserviceDestinationConfigurationTypeDef,
    AmazonopensearchserviceDestinationDescriptionTypeDef,
    AmazonopensearchserviceDestinationUpdateTypeDef,
    AmazonopensearchserviceRetryOptionsTypeDef,
    BufferingHintsTypeDef,
    CloudWatchLoggingOptionsTypeDef,
    CopyCommandTypeDef,
    CreateDeliveryStreamInputRequestTypeDef,
    CreateDeliveryStreamOutputTypeDef,
    DataFormatConversionConfigurationTypeDef,
    DeleteDeliveryStreamInputRequestTypeDef,
    DeliveryStreamDescriptionTypeDef,
    DeliveryStreamEncryptionConfigurationInputTypeDef,
    DeliveryStreamEncryptionConfigurationTypeDef,
    DescribeDeliveryStreamInputRequestTypeDef,
    DescribeDeliveryStreamOutputTypeDef,
    DeserializerTypeDef,
    DestinationDescriptionTypeDef,
    DynamicPartitioningConfigurationTypeDef,
    ElasticsearchBufferingHintsTypeDef,
    ElasticsearchDestinationConfigurationTypeDef,
    ElasticsearchDestinationDescriptionTypeDef,
    ElasticsearchDestinationUpdateTypeDef,
    ElasticsearchRetryOptionsTypeDef,
    EncryptionConfigurationTypeDef,
    ExtendedS3DestinationConfigurationTypeDef,
    ExtendedS3DestinationDescriptionTypeDef,
    ExtendedS3DestinationUpdateTypeDef,
    FailureDescriptionTypeDef,
    HiveJsonSerDeTypeDef,
    HttpEndpointBufferingHintsTypeDef,
    HttpEndpointCommonAttributeTypeDef,
    HttpEndpointConfigurationTypeDef,
    HttpEndpointDescriptionTypeDef,
    HttpEndpointDestinationConfigurationTypeDef,
    HttpEndpointDestinationDescriptionTypeDef,
    HttpEndpointDestinationUpdateTypeDef,
    HttpEndpointRequestConfigurationTypeDef,
    HttpEndpointRetryOptionsTypeDef,
    InputFormatConfigurationTypeDef,
    KMSEncryptionConfigTypeDef,
    KinesisStreamSourceConfigurationTypeDef,
    KinesisStreamSourceDescriptionTypeDef,
    ListDeliveryStreamsInputRequestTypeDef,
    ListDeliveryStreamsOutputTypeDef,
    ListTagsForDeliveryStreamInputRequestTypeDef,
    ListTagsForDeliveryStreamOutputTypeDef,
    OpenXJsonSerDeTypeDef,
    OrcSerDeTypeDef,
    OutputFormatConfigurationTypeDef,
    ParquetSerDeTypeDef,
    ProcessingConfigurationTypeDef,
    ProcessorParameterTypeDef,
    ProcessorTypeDef,
    PutRecordBatchInputRequestTypeDef,
    PutRecordBatchOutputTypeDef,
    PutRecordBatchResponseEntryTypeDef,
    PutRecordInputRequestTypeDef,
    PutRecordOutputTypeDef,
    RecordTypeDef,
    RedshiftDestinationConfigurationTypeDef,
    RedshiftDestinationDescriptionTypeDef,
    RedshiftDestinationUpdateTypeDef,
    RedshiftRetryOptionsTypeDef,
    ResponseMetadataTypeDef,
    RetryOptionsTypeDef,
    S3DestinationConfigurationTypeDef,
    S3DestinationDescriptionTypeDef,
    S3DestinationUpdateTypeDef,
    SchemaConfigurationTypeDef,
    SerializerTypeDef,
    SourceDescriptionTypeDef,
    SplunkDestinationConfigurationTypeDef,
    SplunkDestinationDescriptionTypeDef,
    SplunkDestinationUpdateTypeDef,
    SplunkRetryOptionsTypeDef,
    StartDeliveryStreamEncryptionInputRequestTypeDef,
    StopDeliveryStreamEncryptionInputRequestTypeDef,
    TagDeliveryStreamInputRequestTypeDef,
    TagTypeDef,
    UntagDeliveryStreamInputRequestTypeDef,
    UpdateDestinationInputRequestTypeDef,
    VpcConfigurationDescriptionTypeDef,
    VpcConfigurationTypeDef,
)

def get_structure() -> AmazonopensearchserviceBufferingHintsTypeDef:
    return {
      ...
    }

Versioning

types-aiobotocore-firehose version is the same as related boto3 version and follows PEP 440 format.

Documentation

All type annotations can be found in types-aiobotocore-firehose docs

Support and contributing

This package is auto-generated. Please reports any bugs or request new features in mypy-boto3-builder repository.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

types-aiobotocore-firehose-2.1.0.tar.gz (20.4 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file types-aiobotocore-firehose-2.1.0.tar.gz.

File metadata

  • Download URL: types-aiobotocore-firehose-2.1.0.tar.gz
  • Upload date:
  • Size: 20.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for types-aiobotocore-firehose-2.1.0.tar.gz
Algorithm Hash digest
SHA256 fb559e60ee1fe94c48c7766b8c8ed34a37997a98df46b662770a614c6e399ae6
MD5 d5b870fc4fc42340fe350b3216bf5265
BLAKE2b-256 1b218829458490697ef23ce50d2ab0915e1cfea9fb0d945c581db92255ad5f93

See more details on using hashes here.

File details

Details for the file types_aiobotocore_firehose-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: types_aiobotocore_firehose-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 25.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for types_aiobotocore_firehose-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4e5227245e8be54da7acef9c59799097d7dcb8b139ffdeef31ecbf8439958d41
MD5 aa0cf7ea935055749e27a51691006645
BLAKE2b-256 cc707866d5537a824f096099d769705a657798d2810b98ffc2ea8f06d04d7aec

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page