Skip to content

Type definitions#

Index > Firehose > Type definitions

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

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

AmazonOpenSearchServerlessBufferingHintsTypeDef#

# AmazonOpenSearchServerlessBufferingHintsTypeDef definition

class AmazonOpenSearchServerlessBufferingHintsTypeDef(TypedDict):
    IntervalInSeconds: NotRequired[int],
    SizeInMBs: NotRequired[int],

AmazonOpenSearchServerlessRetryOptionsTypeDef#

# AmazonOpenSearchServerlessRetryOptionsTypeDef definition

class AmazonOpenSearchServerlessRetryOptionsTypeDef(TypedDict):
    DurationInSeconds: NotRequired[int],

CloudWatchLoggingOptionsTypeDef#

# CloudWatchLoggingOptionsTypeDef definition

class CloudWatchLoggingOptionsTypeDef(TypedDict):
    Enabled: NotRequired[bool],
    LogGroupName: NotRequired[str],
    LogStreamName: NotRequired[str],

VpcConfigurationTypeDef#

# VpcConfigurationTypeDef definition

class VpcConfigurationTypeDef(TypedDict):
    SubnetIds: Sequence[str],
    RoleARN: str,
    SecurityGroupIds: Sequence[str],

VpcConfigurationDescriptionTypeDef#

# VpcConfigurationDescriptionTypeDef definition

class VpcConfigurationDescriptionTypeDef(TypedDict):
    SubnetIds: List[str],
    RoleARN: str,
    SecurityGroupIds: List[str],
    VpcId: str,

AmazonopensearchserviceBufferingHintsTypeDef#

# AmazonopensearchserviceBufferingHintsTypeDef definition

class AmazonopensearchserviceBufferingHintsTypeDef(TypedDict):
    IntervalInSeconds: NotRequired[int],
    SizeInMBs: NotRequired[int],

AmazonopensearchserviceRetryOptionsTypeDef#

# AmazonopensearchserviceRetryOptionsTypeDef definition

class AmazonopensearchserviceRetryOptionsTypeDef(TypedDict):
    DurationInSeconds: NotRequired[int],

DocumentIdOptionsTypeDef#

# DocumentIdOptionsTypeDef definition

class DocumentIdOptionsTypeDef(TypedDict):
    DefaultDocumentIdFormat: DefaultDocumentIdFormatType,  # (1)
  1. See DefaultDocumentIdFormatType

AuthenticationConfigurationTypeDef#

# AuthenticationConfigurationTypeDef definition

class AuthenticationConfigurationTypeDef(TypedDict):
    RoleARN: str,
    Connectivity: ConnectivityType,  # (1)
  1. See ConnectivityType

BufferingHintsTypeDef#

# BufferingHintsTypeDef definition

class BufferingHintsTypeDef(TypedDict):
    SizeInMBs: NotRequired[int],
    IntervalInSeconds: NotRequired[int],

CopyCommandTypeDef#

# CopyCommandTypeDef definition

class CopyCommandTypeDef(TypedDict):
    DataTableName: str,
    DataTableColumns: NotRequired[str],
    CopyOptions: NotRequired[str],

DeliveryStreamEncryptionConfigurationInputTypeDef#

# DeliveryStreamEncryptionConfigurationInputTypeDef definition

class DeliveryStreamEncryptionConfigurationInputTypeDef(TypedDict):
    KeyType: KeyTypeType,  # (1)
    KeyARN: NotRequired[str],
  1. See KeyTypeType

KinesisStreamSourceConfigurationTypeDef#

# KinesisStreamSourceConfigurationTypeDef definition

class KinesisStreamSourceConfigurationTypeDef(TypedDict):
    KinesisStreamARN: str,
    RoleARN: str,

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

SchemaConfigurationTypeDef#

# SchemaConfigurationTypeDef definition

class SchemaConfigurationTypeDef(TypedDict):
    RoleARN: NotRequired[str],
    CatalogId: NotRequired[str],
    DatabaseName: NotRequired[str],
    TableName: NotRequired[str],
    Region: NotRequired[str],
    VersionId: NotRequired[str],

DeleteDeliveryStreamInputRequestTypeDef#

# DeleteDeliveryStreamInputRequestTypeDef definition

class DeleteDeliveryStreamInputRequestTypeDef(TypedDict):
    DeliveryStreamName: str,
    AllowForceDelete: NotRequired[bool],

FailureDescriptionTypeDef#

# FailureDescriptionTypeDef definition

class FailureDescriptionTypeDef(TypedDict):
    Type: DeliveryStreamFailureTypeType,  # (1)
    Details: str,
  1. See DeliveryStreamFailureTypeType

DescribeDeliveryStreamInputRequestTypeDef#

# DescribeDeliveryStreamInputRequestTypeDef definition

class DescribeDeliveryStreamInputRequestTypeDef(TypedDict):
    DeliveryStreamName: str,
    Limit: NotRequired[int],
    ExclusiveStartDestinationId: NotRequired[str],

HiveJsonSerDeTypeDef#

# HiveJsonSerDeTypeDef definition

class HiveJsonSerDeTypeDef(TypedDict):
    TimestampFormats: NotRequired[Sequence[str]],

OpenXJsonSerDeTypeDef#

# OpenXJsonSerDeTypeDef definition

class OpenXJsonSerDeTypeDef(TypedDict):
    ConvertDotsInJsonKeysToUnderscores: NotRequired[bool],
    CaseInsensitive: NotRequired[bool],
    ColumnToJsonKeyMappings: NotRequired[Mapping[str, str]],

RetryOptionsTypeDef#

# RetryOptionsTypeDef definition

class RetryOptionsTypeDef(TypedDict):
    DurationInSeconds: NotRequired[int],

ElasticsearchBufferingHintsTypeDef#

# ElasticsearchBufferingHintsTypeDef definition

class ElasticsearchBufferingHintsTypeDef(TypedDict):
    IntervalInSeconds: NotRequired[int],
    SizeInMBs: NotRequired[int],

ElasticsearchRetryOptionsTypeDef#

# ElasticsearchRetryOptionsTypeDef definition

class ElasticsearchRetryOptionsTypeDef(TypedDict):
    DurationInSeconds: NotRequired[int],

KMSEncryptionConfigTypeDef#

# KMSEncryptionConfigTypeDef definition

class KMSEncryptionConfigTypeDef(TypedDict):
    AWSKMSKeyARN: str,

HttpEndpointBufferingHintsTypeDef#

# HttpEndpointBufferingHintsTypeDef definition

class HttpEndpointBufferingHintsTypeDef(TypedDict):
    SizeInMBs: NotRequired[int],
    IntervalInSeconds: NotRequired[int],

HttpEndpointCommonAttributeTypeDef#

# HttpEndpointCommonAttributeTypeDef definition

class HttpEndpointCommonAttributeTypeDef(TypedDict):
    AttributeName: str,
    AttributeValue: str,

HttpEndpointConfigurationTypeDef#

# HttpEndpointConfigurationTypeDef definition

class HttpEndpointConfigurationTypeDef(TypedDict):
    Url: str,
    Name: NotRequired[str],
    AccessKey: NotRequired[str],

HttpEndpointDescriptionTypeDef#

# HttpEndpointDescriptionTypeDef definition

class HttpEndpointDescriptionTypeDef(TypedDict):
    Url: NotRequired[str],
    Name: NotRequired[str],

HttpEndpointRetryOptionsTypeDef#

# HttpEndpointRetryOptionsTypeDef definition

class HttpEndpointRetryOptionsTypeDef(TypedDict):
    DurationInSeconds: NotRequired[int],

KinesisStreamSourceDescriptionTypeDef#

# KinesisStreamSourceDescriptionTypeDef definition

class KinesisStreamSourceDescriptionTypeDef(TypedDict):
    KinesisStreamARN: NotRequired[str],
    RoleARN: NotRequired[str],
    DeliveryStartTimestamp: NotRequired[datetime],

ListDeliveryStreamsInputRequestTypeDef#

# ListDeliveryStreamsInputRequestTypeDef definition

class ListDeliveryStreamsInputRequestTypeDef(TypedDict):
    Limit: NotRequired[int],
    DeliveryStreamType: NotRequired[DeliveryStreamTypeType],  # (1)
    ExclusiveStartDeliveryStreamName: NotRequired[str],
  1. See DeliveryStreamTypeType

ListTagsForDeliveryStreamInputRequestTypeDef#

# ListTagsForDeliveryStreamInputRequestTypeDef definition

class ListTagsForDeliveryStreamInputRequestTypeDef(TypedDict):
    DeliveryStreamName: str,
    ExclusiveStartTagKey: NotRequired[str],
    Limit: NotRequired[int],

OrcSerDeTypeDef#

# OrcSerDeTypeDef definition

class OrcSerDeTypeDef(TypedDict):
    StripeSizeBytes: NotRequired[int],
    BlockSizeBytes: NotRequired[int],
    RowIndexStride: NotRequired[int],
    EnablePadding: NotRequired[bool],
    PaddingTolerance: NotRequired[float],
    Compression: NotRequired[OrcCompressionType],  # (1)
    BloomFilterColumns: NotRequired[Sequence[str]],
    BloomFilterFalsePositiveProbability: NotRequired[float],
    DictionaryKeyThreshold: NotRequired[float],
    FormatVersion: NotRequired[OrcFormatVersionType],  # (2)
  1. See OrcCompressionType
  2. See OrcFormatVersionType

ParquetSerDeTypeDef#

# ParquetSerDeTypeDef definition

class ParquetSerDeTypeDef(TypedDict):
    BlockSizeBytes: NotRequired[int],
    PageSizeBytes: NotRequired[int],
    Compression: NotRequired[ParquetCompressionType],  # (1)
    EnableDictionaryCompression: NotRequired[bool],
    MaxPaddingBytes: NotRequired[int],
    WriterVersion: NotRequired[ParquetWriterVersionType],  # (2)
  1. See ParquetCompressionType
  2. See ParquetWriterVersionType

ProcessorParameterTypeDef#

# ProcessorParameterTypeDef definition

class ProcessorParameterTypeDef(TypedDict):
    ParameterName: ProcessorParameterNameType,  # (1)
    ParameterValue: str,
  1. See ProcessorParameterNameType

PutRecordBatchResponseEntryTypeDef#

# PutRecordBatchResponseEntryTypeDef definition

class PutRecordBatchResponseEntryTypeDef(TypedDict):
    RecordId: NotRequired[str],
    ErrorCode: NotRequired[str],
    ErrorMessage: NotRequired[str],

RedshiftRetryOptionsTypeDef#

# RedshiftRetryOptionsTypeDef definition

class RedshiftRetryOptionsTypeDef(TypedDict):
    DurationInSeconds: NotRequired[int],

SnowflakeRetryOptionsTypeDef#

# SnowflakeRetryOptionsTypeDef definition

class SnowflakeRetryOptionsTypeDef(TypedDict):
    DurationInSeconds: NotRequired[int],

SnowflakeRoleConfigurationTypeDef#

# SnowflakeRoleConfigurationTypeDef definition

class SnowflakeRoleConfigurationTypeDef(TypedDict):
    Enabled: NotRequired[bool],
    SnowflakeRole: NotRequired[str],

SnowflakeVpcConfigurationTypeDef#

# SnowflakeVpcConfigurationTypeDef definition

class SnowflakeVpcConfigurationTypeDef(TypedDict):
    PrivateLinkVpceId: str,

SplunkBufferingHintsTypeDef#

# SplunkBufferingHintsTypeDef definition

class SplunkBufferingHintsTypeDef(TypedDict):
    IntervalInSeconds: NotRequired[int],
    SizeInMBs: NotRequired[int],

SplunkRetryOptionsTypeDef#

# SplunkRetryOptionsTypeDef definition

class SplunkRetryOptionsTypeDef(TypedDict):
    DurationInSeconds: NotRequired[int],

StopDeliveryStreamEncryptionInputRequestTypeDef#

# StopDeliveryStreamEncryptionInputRequestTypeDef definition

class StopDeliveryStreamEncryptionInputRequestTypeDef(TypedDict):
    DeliveryStreamName: str,

UntagDeliveryStreamInputRequestTypeDef#

# UntagDeliveryStreamInputRequestTypeDef definition

class UntagDeliveryStreamInputRequestTypeDef(TypedDict):
    DeliveryStreamName: str,
    TagKeys: Sequence[str],

MSKSourceConfigurationTypeDef#

# MSKSourceConfigurationTypeDef definition

class MSKSourceConfigurationTypeDef(TypedDict):
    MSKClusterARN: str,
    TopicName: str,
    AuthenticationConfiguration: AuthenticationConfigurationTypeDef,  # (1)
  1. See AuthenticationConfigurationTypeDef

MSKSourceDescriptionTypeDef#

# MSKSourceDescriptionTypeDef definition

class MSKSourceDescriptionTypeDef(TypedDict):
    MSKClusterARN: NotRequired[str],
    TopicName: NotRequired[str],
    AuthenticationConfiguration: NotRequired[AuthenticationConfigurationTypeDef],  # (1)
    DeliveryStartTimestamp: NotRequired[datetime],
  1. See AuthenticationConfigurationTypeDef

RecordTypeDef#

# RecordTypeDef definition

class RecordTypeDef(TypedDict):
    Data: Union[str, bytes, IO[Any], StreamingBody],

StartDeliveryStreamEncryptionInputRequestTypeDef#

# StartDeliveryStreamEncryptionInputRequestTypeDef definition

class StartDeliveryStreamEncryptionInputRequestTypeDef(TypedDict):
    DeliveryStreamName: str,
    DeliveryStreamEncryptionConfigurationInput: NotRequired[DeliveryStreamEncryptionConfigurationInputTypeDef],  # (1)
  1. See DeliveryStreamEncryptionConfigurationInputTypeDef

TagDeliveryStreamInputRequestTypeDef#

# TagDeliveryStreamInputRequestTypeDef definition

class TagDeliveryStreamInputRequestTypeDef(TypedDict):
    DeliveryStreamName: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateDeliveryStreamOutputTypeDef#

# CreateDeliveryStreamOutputTypeDef definition

class CreateDeliveryStreamOutputTypeDef(TypedDict):
    DeliveryStreamARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListDeliveryStreamsOutputTypeDef#

# ListDeliveryStreamsOutputTypeDef definition

class ListDeliveryStreamsOutputTypeDef(TypedDict):
    DeliveryStreamNames: List[str],
    HasMoreDeliveryStreams: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForDeliveryStreamOutputTypeDef#

# ListTagsForDeliveryStreamOutputTypeDef definition

class ListTagsForDeliveryStreamOutputTypeDef(TypedDict):
    Tags: List[TagTypeDef],  # (1)
    HasMoreTags: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

PutRecordOutputTypeDef#

# PutRecordOutputTypeDef definition

class PutRecordOutputTypeDef(TypedDict):
    RecordId: str,
    Encrypted: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeliveryStreamEncryptionConfigurationTypeDef#

# DeliveryStreamEncryptionConfigurationTypeDef definition

class DeliveryStreamEncryptionConfigurationTypeDef(TypedDict):
    KeyARN: NotRequired[str],
    KeyType: NotRequired[KeyTypeType],  # (1)
    Status: NotRequired[DeliveryStreamEncryptionStatusType],  # (2)
    FailureDescription: NotRequired[FailureDescriptionTypeDef],  # (3)
  1. See KeyTypeType
  2. See DeliveryStreamEncryptionStatusType
  3. See FailureDescriptionTypeDef

DeserializerTypeDef#

# DeserializerTypeDef definition

class DeserializerTypeDef(TypedDict):
    OpenXJsonSerDe: NotRequired[OpenXJsonSerDeTypeDef],  # (1)
    HiveJsonSerDe: NotRequired[HiveJsonSerDeTypeDef],  # (2)
  1. See OpenXJsonSerDeTypeDef
  2. See HiveJsonSerDeTypeDef

DynamicPartitioningConfigurationTypeDef#

# DynamicPartitioningConfigurationTypeDef definition

class DynamicPartitioningConfigurationTypeDef(TypedDict):
    RetryOptions: NotRequired[RetryOptionsTypeDef],  # (1)
    Enabled: NotRequired[bool],
  1. See RetryOptionsTypeDef

EncryptionConfigurationTypeDef#

# EncryptionConfigurationTypeDef definition

class EncryptionConfigurationTypeDef(TypedDict):
    NoEncryptionConfig: NotRequired[NoEncryptionConfigType],  # (1)
    KMSEncryptionConfig: NotRequired[KMSEncryptionConfigTypeDef],  # (2)
  1. See NoEncryptionConfigType
  2. See KMSEncryptionConfigTypeDef

HttpEndpointRequestConfigurationTypeDef#

# HttpEndpointRequestConfigurationTypeDef definition

class HttpEndpointRequestConfigurationTypeDef(TypedDict):
    ContentEncoding: NotRequired[ContentEncodingType],  # (1)
    CommonAttributes: NotRequired[Sequence[HttpEndpointCommonAttributeTypeDef]],  # (2)
  1. See ContentEncodingType
  2. See HttpEndpointCommonAttributeTypeDef

SerializerTypeDef#

# SerializerTypeDef definition

class SerializerTypeDef(TypedDict):
    ParquetSerDe: NotRequired[ParquetSerDeTypeDef],  # (1)
    OrcSerDe: NotRequired[OrcSerDeTypeDef],  # (2)
  1. See ParquetSerDeTypeDef
  2. See OrcSerDeTypeDef

ProcessorTypeDef#

# ProcessorTypeDef definition

class ProcessorTypeDef(TypedDict):
    Type: ProcessorTypeType,  # (1)
    Parameters: NotRequired[Sequence[ProcessorParameterTypeDef]],  # (2)
  1. See ProcessorTypeType
  2. See ProcessorParameterTypeDef

PutRecordBatchOutputTypeDef#

# PutRecordBatchOutputTypeDef definition

class PutRecordBatchOutputTypeDef(TypedDict):
    FailedPutCount: int,
    Encrypted: bool,
    RequestResponses: List[PutRecordBatchResponseEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PutRecordBatchResponseEntryTypeDef
  2. See ResponseMetadataTypeDef

SourceDescriptionTypeDef#

# SourceDescriptionTypeDef definition

class SourceDescriptionTypeDef(TypedDict):
    KinesisStreamSourceDescription: NotRequired[KinesisStreamSourceDescriptionTypeDef],  # (1)
    MSKSourceDescription: NotRequired[MSKSourceDescriptionTypeDef],  # (2)
  1. See KinesisStreamSourceDescriptionTypeDef
  2. See MSKSourceDescriptionTypeDef

PutRecordBatchInputRequestTypeDef#

# PutRecordBatchInputRequestTypeDef definition

class PutRecordBatchInputRequestTypeDef(TypedDict):
    DeliveryStreamName: str,
    Records: Sequence[RecordTypeDef],  # (1)
  1. See RecordTypeDef

PutRecordInputRequestTypeDef#

# PutRecordInputRequestTypeDef definition

class PutRecordInputRequestTypeDef(TypedDict):
    DeliveryStreamName: str,
    Record: RecordTypeDef,  # (1)
  1. See RecordTypeDef

InputFormatConfigurationTypeDef#

# InputFormatConfigurationTypeDef definition

class InputFormatConfigurationTypeDef(TypedDict):
    Deserializer: NotRequired[DeserializerTypeDef],  # (1)
  1. See