Firehose module#
Index > Firehose
Auto-generated documentation for Firehose type annotations stubs module mypy-boto3-firehose.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy_boto3_builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.35.86' mypy_boto3_builder
- Select
boto3-stubs
AWS SDK. - Add
Firehose
service. - Use provided commands to install generated packages.
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
# FirehoseClient 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 schema.
# AmazonOpenSearchServerlessS3BackupModeType usage example
from mypy_boto3_firehose.literals import AmazonOpenSearchServerlessS3BackupModeType
def get_value() -> AmazonOpenSearchServerlessS3BackupModeType:
return "AllDocuments"
- AmazonOpenSearchServerlessS3BackupModeType
- AmazonopensearchserviceIndexRotationPeriodType
- AmazonopensearchserviceS3BackupModeType
- CompressionFormatType
- ConnectivityType
- ContentEncodingType
- DatabaseTypeType
- DefaultDocumentIdFormatType
- DeliveryStreamEncryptionStatusType
- DeliveryStreamFailureTypeType
- DeliveryStreamStatusType
- DeliveryStreamTypeType
- ElasticsearchIndexRotationPeriodType
- ElasticsearchS3BackupModeType
- HECEndpointTypeType
- HttpEndpointS3BackupModeType
- IcebergS3BackupModeType
- KeyTypeType
- NoEncryptionConfigType
- OrcCompressionType
- OrcFormatVersionType
- ParquetCompressionType
- ParquetWriterVersionType
- ProcessorParameterNameType
- ProcessorTypeType
- RedshiftS3BackupModeType
- S3BackupModeType
- SSLModeType
- SnapshotRequestedByType
- SnapshotStatusType
- SnowflakeDataLoadingOptionType
- SnowflakeS3BackupModeType
- SplunkS3BackupModeType
- FirehoseServiceName
- ServiceName
- ResourceServiceName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AmazonOpenSearchServerlessBufferingHintsTypeDef
- AmazonOpenSearchServerlessRetryOptionsTypeDef
- CloudWatchLoggingOptionsTypeDef
- VpcConfigurationTypeDef
- VpcConfigurationDescriptionTypeDef
- AmazonopensearchserviceBufferingHintsTypeDef
- AmazonopensearchserviceRetryOptionsTypeDef
- DocumentIdOptionsTypeDef
- AuthenticationConfigurationTypeDef
- BlobTypeDef
- BufferingHintsTypeDef
- CatalogConfigurationTypeDef
- CopyCommandTypeDef
- DeliveryStreamEncryptionConfigurationInputTypeDef
- KinesisStreamSourceConfigurationTypeDef
- TagTypeDef
- ResponseMetadataTypeDef
- SchemaConfigurationTypeDef
- DatabaseColumnListOutputTypeDef
- DatabaseColumnListTypeDef
- DatabaseListOutputTypeDef
- DatabaseListTypeDef
- FailureDescriptionTypeDef
- SecretsManagerConfigurationTypeDef
- DatabaseSourceVPCConfigurationTypeDef
- DatabaseTableListOutputTypeDef
- DatabaseTableListTypeDef
- DeleteDeliveryStreamInputRequestTypeDef
- DescribeDeliveryStreamInputRequestTypeDef
- HiveJsonSerDeOutputTypeDef
- OpenXJsonSerDeOutputTypeDef
- RetryOptionsTypeDef
- ElasticsearchBufferingHintsTypeDef
- ElasticsearchRetryOptionsTypeDef
- KMSEncryptionConfigTypeDef
- HiveJsonSerDeTypeDef
- HttpEndpointBufferingHintsTypeDef
- HttpEndpointCommonAttributeTypeDef
- HttpEndpointConfigurationTypeDef
- HttpEndpointDescriptionTypeDef
- HttpEndpointRetryOptionsTypeDef
- SchemaEvolutionConfigurationTypeDef
- TableCreationConfigurationTypeDef
- KinesisStreamSourceDescriptionTypeDef
- ListDeliveryStreamsInputRequestTypeDef
- ListTagsForDeliveryStreamInputRequestTypeDef
- TimestampTypeDef
- OpenXJsonSerDeTypeDef
- OrcSerDeOutputTypeDef
- OrcSerDeTypeDef
- ParquetSerDeTypeDef
- PartitionFieldTypeDef
- ProcessorParameterTypeDef
- PutRecordBatchResponseEntryTypeDef
- RedshiftRetryOptionsTypeDef
- SnowflakeBufferingHintsTypeDef
- SnowflakeRetryOptionsTypeDef
- SnowflakeRoleConfigurationTypeDef
- SnowflakeVpcConfigurationTypeDef
- SplunkBufferingHintsTypeDef
- SplunkRetryOptionsTypeDef
- StopDeliveryStreamEncryptionInputRequestTypeDef
- UntagDeliveryStreamInputRequestTypeDef
- MSKSourceDescriptionTypeDef
- RecordTypeDef
- StartDeliveryStreamEncryptionInputRequestTypeDef
- TagDeliveryStreamInputRequestTypeDef
- CreateDeliveryStreamOutputTypeDef
- ListDeliveryStreamsOutputTypeDef
- ListTagsForDeliveryStreamOutputTypeDef
- PutRecordOutputTypeDef
- DatabaseColumnListUnionTypeDef
- DatabaseListUnionTypeDef
- DatabaseSnapshotInfoTypeDef
- DeliveryStreamEncryptionConfigurationTypeDef
- DatabaseSourceAuthenticationConfigurationTypeDef
- DatabaseTableListUnionTypeDef
- DeserializerOutputTypeDef
- DynamicPartitioningConfigurationTypeDef
- EncryptionConfigurationTypeDef
- HiveJsonSerDeUnionTypeDef
- HttpEndpointRequestConfigurationOutputTypeDef
- HttpEndpointRequestConfigurationTypeDef
- MSKSourceConfigurationTypeDef
- OpenXJsonSerDeUnionTypeDef
- OrcSerDeUnionTypeDef
- SerializerOutputTypeDef
- PartitionSpecOutputTypeDef
- PartitionSpecTypeDef
- ProcessorOutputTypeDef
- ProcessorTypeDef
- PutRecordBatchOutputTypeDef
- PutRecordBatchInputRequestTypeDef
- PutRecordInputRequestTypeDef
- DatabaseSourceDescriptionTypeDef
- DatabaseSourceConfigurationTypeDef
- InputFormatConfigurationOutputTypeDef
- S3DestinationConfigurationTypeDef
- S3DestinationDescriptionTypeDef
- S3DestinationUpdateTypeDef
- HttpEndpointRequestConfigurationUnionTypeDef
- DeserializerTypeDef
- SerializerTypeDef
- OutputFormatConfigurationOutputTypeDef
- DestinationTableConfigurationOutputTypeDef
- PartitionSpecUnionTypeDef
- ProcessingConfigurationOutputTypeDef
- ProcessorUnionTypeDef
- SourceDescriptionTypeDef
- DeserializerUnionTypeDef
- SerializerUnionTypeDef
- DataFormatConversionConfigurationOutputTypeDef
- DestinationTableConfigurationTypeDef
- AmazonOpenSearchServerlessDestinationDescriptionTypeDef
- AmazonopensearchserviceDestinationDescriptionTypeDef
- ElasticsearchDestinationDescriptionTypeDef
- HttpEndpointDestinationDescriptionTypeDef
- IcebergDestinationDescriptionTypeDef
- RedshiftDestinationDescriptionTypeDef
- SnowflakeDestinationDescriptionTypeDef
- SplunkDestinationDescriptionTypeDef
- ProcessingConfigurationTypeDef
- InputFormatConfigurationTypeDef
- OutputFormatConfigurationTypeDef
- ExtendedS3DestinationDescriptionTypeDef
- DestinationTableConfigurationUnionTypeDef
- ProcessingConfigurationUnionTypeDef
- InputFormatConfigurationUnionTypeDef
- OutputFormatConfigurationUnionTypeDef
- DestinationDescriptionTypeDef
- AmazonOpenSearchServerlessDestinationConfigurationTypeDef
- AmazonOpenSearchServerlessDestinationUpdateTypeDef
- AmazonopensearchserviceDestinationConfigurationTypeDef
- AmazonopensearchserviceDestinationUpdateTypeDef
- ElasticsearchDestinationConfigurationTypeDef
- ElasticsearchDestinationUpdateTypeDef
- HttpEndpointDestinationConfigurationTypeDef
- HttpEndpointDestinationUpdateTypeDef
- IcebergDestinationConfigurationTypeDef
- IcebergDestinationUpdateTypeDef
- RedshiftDestinationConfigurationTypeDef
- RedshiftDestinationUpdateTypeDef
- SnowflakeDestinationConfigurationTypeDef
- SnowflakeDestinationUpdateTypeDef
- SplunkDestinationConfigurationTypeDef
- SplunkDestinationUpdateTypeDef
- DataFormatConversionConfigurationTypeDef
- DeliveryStreamDescriptionTypeDef
- DataFormatConversionConfigurationUnionTypeDef
- DescribeDeliveryStreamOutputTypeDef
- ExtendedS3DestinationConfigurationTypeDef
- ExtendedS3DestinationUpdateTypeDef
- CreateDeliveryStreamInputRequestTypeDef
- UpdateDestinationInputRequestTypeDef