Skip to content

Typed dictionaries

Index > Firehose > Typed dictionaries

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

AmazonopensearchserviceBufferingHintsTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import AmazonopensearchserviceBufferingHintsTypeDef

def get_value() -> AmazonopensearchserviceBufferingHintsTypeDef:
    return {
        "IntervalInSeconds": ...,
    }
Definition
class AmazonopensearchserviceBufferingHintsTypeDef(TypedDict):
    IntervalInSeconds: NotRequired[int],
    SizeInMBs: NotRequired[int],

AmazonopensearchserviceRetryOptionsTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import AmazonopensearchserviceRetryOptionsTypeDef

def get_value() -> AmazonopensearchserviceRetryOptionsTypeDef:
    return {
        "DurationInSeconds": ...,
    }
Definition
class AmazonopensearchserviceRetryOptionsTypeDef(TypedDict):
    DurationInSeconds: NotRequired[int],

CloudWatchLoggingOptionsTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import CloudWatchLoggingOptionsTypeDef

def get_value() -> CloudWatchLoggingOptionsTypeDef:
    return {
        "Enabled": ...,
    }
Definition
class CloudWatchLoggingOptionsTypeDef(TypedDict):
    Enabled: NotRequired[bool],
    LogGroupName: NotRequired[str],
    LogStreamName: NotRequired[str],

VpcConfigurationTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import VpcConfigurationTypeDef

def get_value() -> VpcConfigurationTypeDef:
    return {
        "SubnetIds": ...,
        "RoleARN": ...,
        "SecurityGroupIds": ...,
    }
Definition
class VpcConfigurationTypeDef(TypedDict):
    SubnetIds: Sequence[str],
    RoleARN: str,
    SecurityGroupIds: Sequence[str],

VpcConfigurationDescriptionTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import VpcConfigurationDescriptionTypeDef

def get_value() -> VpcConfigurationDescriptionTypeDef:
    return {
        "SubnetIds": ...,
        "RoleARN": ...,
        "SecurityGroupIds": ...,
        "VpcId": ...,
    }
Definition
class VpcConfigurationDescriptionTypeDef(TypedDict):
    SubnetIds: List[str],
    RoleARN: str,
    SecurityGroupIds: List[str],
    VpcId: str,

BufferingHintsTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import BufferingHintsTypeDef

def get_value() -> BufferingHintsTypeDef:
    return {
        "SizeInMBs": ...,
    }
Definition
class BufferingHintsTypeDef(TypedDict):
    SizeInMBs: NotRequired[int],
    IntervalInSeconds: NotRequired[int],

CopyCommandTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import CopyCommandTypeDef

def get_value() -> CopyCommandTypeDef:
    return {
        "DataTableName": ...,
    }
Definition
class CopyCommandTypeDef(TypedDict):
    DataTableName: str,
    DataTableColumns: NotRequired[str],
    CopyOptions: NotRequired[str],

DeliveryStreamEncryptionConfigurationInputTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import DeliveryStreamEncryptionConfigurationInputTypeDef

def get_value() -> DeliveryStreamEncryptionConfigurationInputTypeDef:
    return {
        "KeyType": ...,
    }
Definition
class DeliveryStreamEncryptionConfigurationInputTypeDef(TypedDict):
    KeyType: KeyTypeType,  # (1)
    KeyARN: NotRequired[str],
  1. See KeyTypeType

KinesisStreamSourceConfigurationTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import KinesisStreamSourceConfigurationTypeDef

def get_value() -> KinesisStreamSourceConfigurationTypeDef:
    return {
        "KinesisStreamARN": ...,
        "RoleARN": ...,
    }
Definition
class KinesisStreamSourceConfigurationTypeDef(TypedDict):
    KinesisStreamARN: str,
    RoleARN: str,

TagTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
    }
Definition
class TagTypeDef(TypedDict):
    Key: str,
    Value: NotRequired[str],

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
Definition
class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

SchemaConfigurationTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import SchemaConfigurationTypeDef

def get_value() -> SchemaConfigurationTypeDef:
    return {
        "RoleARN": ...,
    }
Definition
class SchemaConfigurationTypeDef(TypedDict):
    RoleARN: NotRequired[str],
    CatalogId: NotRequired[str],
    DatabaseName: NotRequired[str],
    TableName: NotRequired[str],
    Region: NotRequired[str],
    VersionId: NotRequired[str],

DeleteDeliveryStreamInputRequestTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import DeleteDeliveryStreamInputRequestTypeDef

def get_value() -> DeleteDeliveryStreamInputRequestTypeDef:
    return {
        "DeliveryStreamName": ...,
    }
Definition
class DeleteDeliveryStreamInputRequestTypeDef(TypedDict):
    DeliveryStreamName: str,
    AllowForceDelete: NotRequired[bool],

FailureDescriptionTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import FailureDescriptionTypeDef

def get_value() -> FailureDescriptionTypeDef:
    return {
        "Type": ...,
        "Details": ...,
    }
Definition
class FailureDescriptionTypeDef(TypedDict):
    Type: DeliveryStreamFailureTypeType,  # (1)
    Details: str,
  1. See DeliveryStreamFailureTypeType

DescribeDeliveryStreamInputRequestTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import DescribeDeliveryStreamInputRequestTypeDef

def get_value() -> DescribeDeliveryStreamInputRequestTypeDef:
    return {
        "DeliveryStreamName": ...,
    }
Definition
class DescribeDeliveryStreamInputRequestTypeDef(TypedDict):
    DeliveryStreamName: str,
    Limit: NotRequired[int],
    ExclusiveStartDestinationId: NotRequired[str],

HiveJsonSerDeTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import HiveJsonSerDeTypeDef

def get_value() -> HiveJsonSerDeTypeDef:
    return {
        "TimestampFormats": ...,
    }
Definition
class HiveJsonSerDeTypeDef(TypedDict):
    TimestampFormats: NotRequired[Sequence[str]],

OpenXJsonSerDeTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import OpenXJsonSerDeTypeDef

def get_value() -> OpenXJsonSerDeTypeDef:
    return {
        "ConvertDotsInJsonKeysToUnderscores": ...,
    }
Definition
class OpenXJsonSerDeTypeDef(TypedDict):
    ConvertDotsInJsonKeysToUnderscores: NotRequired[bool],
    CaseInsensitive: NotRequired[bool],
    ColumnToJsonKeyMappings: NotRequired[Mapping[str, str]],

RetryOptionsTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import RetryOptionsTypeDef

def get_value() -> RetryOptionsTypeDef:
    return {
        "DurationInSeconds": ...,
    }
Definition
class RetryOptionsTypeDef(TypedDict):
    DurationInSeconds: NotRequired[int],

ElasticsearchBufferingHintsTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import ElasticsearchBufferingHintsTypeDef

def get_value() -> ElasticsearchBufferingHintsTypeDef:
    return {
        "IntervalInSeconds": ...,
    }
Definition
class ElasticsearchBufferingHintsTypeDef(TypedDict):
    IntervalInSeconds: NotRequired[int],
    SizeInMBs: NotRequired[int],

ElasticsearchRetryOptionsTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import ElasticsearchRetryOptionsTypeDef

def get_value() -> ElasticsearchRetryOptionsTypeDef:
    return {
        "DurationInSeconds": ...,
    }
Definition
class ElasticsearchRetryOptionsTypeDef(TypedDict):
    DurationInSeconds: NotRequired[int],

KMSEncryptionConfigTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import KMSEncryptionConfigTypeDef

def get_value() -> KMSEncryptionConfigTypeDef:
    return {
        "AWSKMSKeyARN": ...,
    }
Definition
class KMSEncryptionConfigTypeDef(TypedDict):
    AWSKMSKeyARN: str,

HttpEndpointBufferingHintsTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import HttpEndpointBufferingHintsTypeDef

def get_value() -> HttpEndpointBufferingHintsTypeDef:
    return {
        "SizeInMBs": ...,
    }
Definition
class HttpEndpointBufferingHintsTypeDef(TypedDict):
    SizeInMBs: NotRequired[int],
    IntervalInSeconds: NotRequired[int],

HttpEndpointCommonAttributeTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import HttpEndpointCommonAttributeTypeDef

def get_value() -> HttpEndpointCommonAttributeTypeDef:
    return {
        "AttributeName": ...,
        "AttributeValue": ...,
    }
Definition
class HttpEndpointCommonAttributeTypeDef(TypedDict):
    AttributeName: str,
    AttributeValue: str,

HttpEndpointConfigurationTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import HttpEndpointConfigurationTypeDef

def get_value() -> HttpEndpointConfigurationTypeDef:
    return {
        "Url": ...,
    }
Definition
class HttpEndpointConfigurationTypeDef(TypedDict):
    Url: str,
    Name: NotRequired[str],
    AccessKey: NotRequired[str],

HttpEndpointDescriptionTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import HttpEndpointDescriptionTypeDef

def get_value() -> HttpEndpointDescriptionTypeDef:
    return {
        "Url": ...,
    }
Definition
class HttpEndpointDescriptionTypeDef(TypedDict):
    Url: NotRequired[str],
    Name: NotRequired[str],

HttpEndpointRetryOptionsTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import HttpEndpointRetryOptionsTypeDef

def get_value() -> HttpEndpointRetryOptionsTypeDef:
    return {
        "DurationInSeconds": ...,
    }
Definition
class HttpEndpointRetryOptionsTypeDef(TypedDict):
    DurationInSeconds: NotRequired[int],

KinesisStreamSourceDescriptionTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import KinesisStreamSourceDescriptionTypeDef

def get_value() -> KinesisStreamSourceDescriptionTypeDef:
    return {
        "KinesisStreamARN": ...,
    }
Definition
class KinesisStreamSourceDescriptionTypeDef(TypedDict):
    KinesisStreamARN: NotRequired[str],
    RoleARN: NotRequired[str],
    DeliveryStartTimestamp: NotRequired[datetime],

ListDeliveryStreamsInputRequestTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import ListDeliveryStreamsInputRequestTypeDef

def get_value() -> ListDeliveryStreamsInputRequestTypeDef:
    return {
        "Limit": ...,
    }
Definition
class ListDeliveryStreamsInputRequestTypeDef(TypedDict):
    Limit: NotRequired[int],
    DeliveryStreamType: NotRequired[DeliveryStreamTypeType],  # (1)
    ExclusiveStartDeliveryStreamName: NotRequired[str],
  1. See DeliveryStreamTypeType

ListTagsForDeliveryStreamInputRequestTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import ListTagsForDeliveryStreamInputRequestTypeDef

def get_value() -> ListTagsForDeliveryStreamInputRequestTypeDef:
    return {
        "DeliveryStreamName": ...,
    }
Definition
class ListTagsForDeliveryStreamInputRequestTypeDef(TypedDict):
    DeliveryStreamName: str,
    ExclusiveStartTagKey: NotRequired[str],
    Limit: NotRequired[int],

OrcSerDeTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import OrcSerDeTypeDef

def get_value() -> OrcSerDeTypeDef:
    return {
        "StripeSizeBytes": ...,
    }
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

Usage Example
from mypy_boto3_firehose.type_defs import ParquetSerDeTypeDef

def get_value() -> ParquetSerDeTypeDef:
    return {
        "BlockSizeBytes": ...,
    }
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

Usage Example
from mypy_boto3_firehose.type_defs import ProcessorParameterTypeDef

def get_value() -> ProcessorParameterTypeDef:
    return {
        "ParameterName": ...,
        "ParameterValue": ...,
    }
Definition
class ProcessorParameterTypeDef(TypedDict):
    ParameterName: ProcessorParameterNameType,  # (1)
    ParameterValue: str,
  1. See ProcessorParameterNameType

RecordTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import RecordTypeDef

def get_value() -> RecordTypeDef:
    return {
        "Data": ...,
    }
Definition
class RecordTypeDef(TypedDict):
    Data: Union[str, bytes, IO[Any], StreamingBody],

PutRecordBatchResponseEntryTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import PutRecordBatchResponseEntryTypeDef

def get_value() -> PutRecordBatchResponseEntryTypeDef:
    return {
        "RecordId": ...,
    }
Definition
class PutRecordBatchResponseEntryTypeDef(TypedDict):
    RecordId: NotRequired[str],
    ErrorCode: NotRequired[str],
    ErrorMessage: NotRequired[str],

RedshiftRetryOptionsTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import RedshiftRetryOptionsTypeDef

def get_value() -> RedshiftRetryOptionsTypeDef:
    return {
        "DurationInSeconds": ...,
    }
Definition
class RedshiftRetryOptionsTypeDef(TypedDict):
    DurationInSeconds: NotRequired[int],

SplunkRetryOptionsTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import SplunkRetryOptionsTypeDef

def get_value() -> SplunkRetryOptionsTypeDef:
    return {
        "DurationInSeconds": ...,
    }
Definition
class SplunkRetryOptionsTypeDef(TypedDict):
    DurationInSeconds: NotRequired[int],

StopDeliveryStreamEncryptionInputRequestTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import StopDeliveryStreamEncryptionInputRequestTypeDef

def get_value() -> StopDeliveryStreamEncryptionInputRequestTypeDef:
    return {
        "DeliveryStreamName": ...,
    }
Definition
class StopDeliveryStreamEncryptionInputRequestTypeDef(TypedDict):
    DeliveryStreamName: str,

UntagDeliveryStreamInputRequestTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import UntagDeliveryStreamInputRequestTypeDef

def get_value() -> UntagDeliveryStreamInputRequestTypeDef:
    return {
        "DeliveryStreamName": ...,
        "TagKeys": ...,
    }
Definition
class UntagDeliveryStreamInputRequestTypeDef(TypedDict):
    DeliveryStreamName: str,
    TagKeys: Sequence[str],

StartDeliveryStreamEncryptionInputRequestTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import StartDeliveryStreamEncryptionInputRequestTypeDef

def get_value() -> StartDeliveryStreamEncryptionInputRequestTypeDef:
    return {
        "DeliveryStreamName": ...,
    }
Definition
class StartDeliveryStreamEncryptionInputRequestTypeDef(TypedDict):
    DeliveryStreamName: str,
    DeliveryStreamEncryptionConfigurationInput: NotRequired[DeliveryStreamEncryptionConfigurationInputTypeDef],  # (1)
  1. See DeliveryStreamEncryptionConfigurationInputTypeDef

TagDeliveryStreamInputRequestTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import TagDeliveryStreamInputRequestTypeDef

def get_value() -> TagDeliveryStreamInputRequestTypeDef:
    return {
        "DeliveryStreamName": ...,
        "Tags": ...,
    }
Definition
class TagDeliveryStreamInputRequestTypeDef(TypedDict):
    DeliveryStreamName: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateDeliveryStreamOutputTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import CreateDeliveryStreamOutputTypeDef

def get_value() -> CreateDeliveryStreamOutputTypeDef:
    return {
        "DeliveryStreamARN": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateDeliveryStreamOutputTypeDef(TypedDict):
    DeliveryStreamARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListDeliveryStreamsOutputTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import ListDeliveryStreamsOutputTypeDef

def get_value() -> ListDeliveryStreamsOutputTypeDef:
    return {
        "DeliveryStreamNames": ...,
        "HasMoreDeliveryStreams": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListDeliveryStreamsOutputTypeDef(TypedDict):
    DeliveryStreamNames: List[str],
    HasMoreDeliveryStreams: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForDeliveryStreamOutputTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import ListTagsForDeliveryStreamOutputTypeDef

def get_value() -> ListTagsForDeliveryStreamOutputTypeDef:
    return {
        "Tags": ...,
        "HasMoreTags": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListTagsForDeliveryStreamOutputTypeDef(TypedDict):
    Tags: List[TagTypeDef],  # (1)
    HasMoreTags: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

PutRecordOutputTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import PutRecordOutputTypeDef

def get_value() -> PutRecordOutputTypeDef:
    return {
        "RecordId": ...,
        "Encrypted": ...,
        "ResponseMetadata": ...,
    }
Definition
class PutRecordOutputTypeDef(TypedDict):
    RecordId: str,
    Encrypted: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeliveryStreamEncryptionConfigurationTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import DeliveryStreamEncryptionConfigurationTypeDef

def get_value() -> DeliveryStreamEncryptionConfigurationTypeDef:
    return {
        "KeyARN": ...,
    }
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

Usage Example
from mypy_boto3_firehose.type_defs import DeserializerTypeDef

def get_value() -> DeserializerTypeDef:
    return {
        "OpenXJsonSerDe": ...,
    }
Definition
class DeserializerTypeDef(TypedDict):
    OpenXJsonSerDe: NotRequired[OpenXJsonSerDeTypeDef],  # (1)
    HiveJsonSerDe: NotRequired[HiveJsonSerDeTypeDef],  # (2)
  1. See OpenXJsonSerDeTypeDef
  2. See HiveJsonSerDeTypeDef

DynamicPartitioningConfigurationTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import DynamicPartitioningConfigurationTypeDef

def get_value() -> DynamicPartitioningConfigurationTypeDef:
    return {
        "RetryOptions": ...,
    }
Definition
class DynamicPartitioningConfigurationTypeDef(TypedDict):
    RetryOptions: NotRequired[RetryOptionsTypeDef],  # (1)
    Enabled: NotRequired[bool],
  1. See RetryOptionsTypeDef

EncryptionConfigurationTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import EncryptionConfigurationTypeDef

def get_value() -> EncryptionConfigurationTypeDef:
    return {
        "NoEncryptionConfig": ...,
    }
Definition
class EncryptionConfigurationTypeDef(TypedDict):
    NoEncryptionConfig: NotRequired[NoEncryptionConfigType],  # (1)
    KMSEncryptionConfig: NotRequired[KMSEncryptionConfigTypeDef],  # (2)
  1. See NoEncryptionConfigType
  2. See KMSEncryptionConfigTypeDef

HttpEndpointRequestConfigurationTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import HttpEndpointRequestConfigurationTypeDef

def get_value() -> HttpEndpointRequestConfigurationTypeDef:
    return {
        "ContentEncoding": ...,
    }
Definition
class HttpEndpointRequestConfigurationTypeDef(TypedDict):
    ContentEncoding: NotRequired[ContentEncodingType],  # (1)
    CommonAttributes: NotRequired[Sequence[HttpEndpointCommonAttributeTypeDef]],  # (2)
  1. See ContentEncodingType
  2. See HttpEndpointCommonAttributeTypeDef

SourceDescriptionTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import SourceDescriptionTypeDef

def get_value() -> SourceDescriptionTypeDef:
    return {
        "KinesisStreamSourceDescription": ...,
    }
Definition
class SourceDescriptionTypeDef(TypedDict):
    KinesisStreamSourceDescription: NotRequired[KinesisStreamSourceDescriptionTypeDef],  # (1)
  1. See KinesisStreamSourceDescriptionTypeDef

SerializerTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import SerializerTypeDef

def get_value() -> SerializerTypeDef:
    return {
        "ParquetSerDe": ...,
    }
Definition
class SerializerTypeDef(TypedDict):
    ParquetSerDe: NotRequired[ParquetSerDeTypeDef],  # (1)
    OrcSerDe: NotRequired[OrcSerDeTypeDef],  # (2)
  1. See ParquetSerDeTypeDef
  2. See OrcSerDeTypeDef

ProcessorTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import ProcessorTypeDef

def get_value() -> ProcessorTypeDef:
    return {
        "Type": ...,
    }
Definition
class ProcessorTypeDef(TypedDict):
    Type: ProcessorTypeType,  # (1)
    Parameters: NotRequired[Sequence[ProcessorParameterTypeDef]],  # (2)
  1. See ProcessorTypeType
  2. See ProcessorParameterTypeDef

PutRecordBatchInputRequestTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import PutRecordBatchInputRequestTypeDef

def get_value() -> PutRecordBatchInputRequestTypeDef:
    return {
        "DeliveryStreamName": ...,
        "Records": ...,
    }
Definition
class PutRecordBatchInputRequestTypeDef(TypedDict):
    DeliveryStreamName: str,
    Records: Sequence[RecordTypeDef],  # (1)
  1. See RecordTypeDef

PutRecordInputRequestTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import PutRecordInputRequestTypeDef

def get_value() -> PutRecordInputRequestTypeDef:
    return {
        "DeliveryStreamName": ...,
        "Record": ...,
    }
Definition
class PutRecordInputRequestTypeDef(TypedDict):
    DeliveryStreamName: str,
    Record: RecordTypeDef,  # (1)
  1. See RecordTypeDef

PutRecordBatchOutputTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import PutRecordBatchOutputTypeDef

def get_value() -> PutRecordBatchOutputTypeDef:
    return {
        "FailedPutCount": ...,
        "Encrypted": ...,
        "RequestResponses": ...,
        "ResponseMetadata": ...,
    }
Definition
class PutRecordBatchOutputTypeDef(TypedDict):
    FailedPutCount: int,
    Encrypted: bool,
    RequestResponses: List[PutRecordBatchResponseEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PutRecordBatchResponseEntryTypeDef
  2. See ResponseMetadataTypeDef

InputFormatConfigurationTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import InputFormatConfigurationTypeDef

def get_value() -> InputFormatConfigurationTypeDef:
    return {
        "Deserializer": ...,
    }
Definition
class InputFormatConfigurationTypeDef(TypedDict):
    Deserializer: NotRequired[DeserializerTypeDef],  # (1)
  1. See DeserializerTypeDef

S3DestinationConfigurationTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import S3DestinationConfigurationTypeDef

def get_value() -> S3DestinationConfigurationTypeDef:
    return {
        "RoleARN": ...,
        "BucketARN": ...,
    }
Definition
class S3DestinationConfigurationTypeDef(TypedDict):
    RoleARN: str,
    BucketARN: str,
    Prefix: NotRequired[str],
    ErrorOutputPrefix: NotRequired[str],
    BufferingHints: NotRequired[BufferingHintsTypeDef],  # (1)
    CompressionFormat: NotRequired[CompressionFormatType],  # (2)
    EncryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef],  # (3)
    CloudWatchLoggingOptions: NotRequired[CloudWatchLoggingOptionsTypeDef],  # (4)
  1. See BufferingHintsTypeDef
  2. See CompressionFormatType
  3. See EncryptionConfigurationTypeDef
  4. See CloudWatchLoggingOptionsTypeDef

S3DestinationDescriptionTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import S3DestinationDescriptionTypeDef

def get_value() -> S3DestinationDescriptionTypeDef:
    return {
        "RoleARN": ...,
        "BucketARN": ...,
        "BufferingHints": ...,
        "CompressionFormat": ...,
        "EncryptionConfiguration": ...,
    }
Definition
class S3DestinationDescriptionTypeDef(TypedDict):
    RoleARN: str,
    BucketARN: str,
    BufferingHints: BufferingHintsTypeDef,  # (1)
    CompressionFormat: CompressionFormatType,  # (2)
    EncryptionConfiguration: EncryptionConfigurationTypeDef,  # (3)
    Prefix: NotRequired[str],
    ErrorOutputPrefix: NotRequired[str],
    CloudWatchLoggingOptions: NotRequired[CloudWatchLoggingOptionsTypeDef],  # (4)
  1. See BufferingHintsTypeDef
  2. See CompressionFormatType
  3. See EncryptionConfigurationTypeDef
  4. See CloudWatchLoggingOptionsTypeDef

S3DestinationUpdateTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import S3DestinationUpdateTypeDef

def get_value() -> S3DestinationUpdateTypeDef:
    return {
        "RoleARN": ...,
    }
Definition
class S3DestinationUpdateTypeDef(TypedDict):
    RoleARN: NotRequired[str],
    BucketARN: NotRequired[str],
    Prefix: NotRequired[str],
    ErrorOutputPrefix: NotRequired[str],
    BufferingHints: NotRequired[BufferingHintsTypeDef],  # (1)
    CompressionFormat: NotRequired[CompressionFormatType],  # (2)
    EncryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef],  # (3)
    CloudWatchLoggingOptions: NotRequired[CloudWatchLoggingOptionsTypeDef],  # (4)
  1. See BufferingHintsTypeDef
  2. See CompressionFormatType
  3. See EncryptionConfigurationTypeDef
  4. See CloudWatchLoggingOptionsTypeDef

OutputFormatConfigurationTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import OutputFormatConfigurationTypeDef

def get_value() -> OutputFormatConfigurationTypeDef:
    return {
        "Serializer": ...,
    }
Definition
class OutputFormatConfigurationTypeDef(TypedDict):
    Serializer: NotRequired[SerializerTypeDef],  # (1)
  1. See SerializerTypeDef

ProcessingConfigurationTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import ProcessingConfigurationTypeDef

def get_value() -> ProcessingConfigurationTypeDef:
    return {
        "Enabled": ...,
    }
Definition
class ProcessingConfigurationTypeDef(TypedDict):
    Enabled: NotRequired[bool],
    Processors: NotRequired[Sequence[ProcessorTypeDef]],  # (1)
  1. See ProcessorTypeDef

DataFormatConversionConfigurationTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import DataFormatConversionConfigurationTypeDef

def get_value() -> DataFormatConversionConfigurationTypeDef:
    return {
        "SchemaConfiguration": ...,
    }
Definition
class DataFormatConversionConfigurationTypeDef(TypedDict):
    SchemaConfiguration: NotRequired[SchemaConfigurationTypeDef],  # (1)
    InputFormatConfiguration: NotRequired[InputFormatConfigurationTypeDef],  # (2)
    OutputFormatConfiguration: NotRequired[OutputFormatConfigurationTypeDef],  # (3)
    Enabled: NotRequired[bool],
  1. See SchemaConfigurationTypeDef
  2. See InputFormatConfigurationTypeDef
  3. See OutputFormatConfigurationTypeDef

AmazonopensearchserviceDestinationConfigurationTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import AmazonopensearchserviceDestinationConfigurationTypeDef

def get_value() -> AmazonopensearchserviceDestinationConfigurationTypeDef:
    return {
        "RoleARN": ...,
        "IndexName": ...,
        "S3Configuration": ...,
    }
Definition
class AmazonopensearchserviceDestinationConfigurationTypeDef(TypedDict):
    RoleARN: str,
    IndexName: str,
    S3Configuration: S3DestinationConfigurationTypeDef,  # (5)
    DomainARN: NotRequired[str],
    ClusterEndpoint: NotRequired[str],
    TypeName: NotRequired[str],
    IndexRotationPeriod: NotRequired[AmazonopensearchserviceIndexRotationPeriodType],  # (1)
    BufferingHints: NotRequired[AmazonopensearchserviceBufferingHintsTypeDef],  # (2)
    RetryOptions: NotRequired[AmazonopensearchserviceRetryOptionsTypeDef],  # (3)
    S3BackupMode: NotRequired[AmazonopensearchserviceS3BackupModeType],  # (4)
    ProcessingConfiguration: NotRequired[ProcessingConfigurationTypeDef],  # (6)
    CloudWatchLoggingOptions: NotRequired[CloudWatchLoggingOptionsTypeDef],  # (7)
    VpcConfiguration: NotRequired[VpcConfigurationTypeDef],  # (8)
  1. See AmazonopensearchserviceIndexRotationPeriodType
  2. See AmazonopensearchserviceBufferingHintsTypeDef
  3. See AmazonopensearchserviceRetryOptionsTypeDef
  4. See AmazonopensearchserviceS3BackupModeType
  5. See S3DestinationConfigurationTypeDef
  6. See ProcessingConfigurationTypeDef
  7. See CloudWatchLoggingOptionsTypeDef
  8. See VpcConfigurationTypeDef

AmazonopensearchserviceDestinationDescriptionTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import AmazonopensearchserviceDestinationDescriptionTypeDef

def get_value() -> AmazonopensearchserviceDestinationDescriptionTypeDef:
    return {
        "RoleARN": ...,
    }
Definition
class AmazonopensearchserviceDestinationDescriptionTypeDef(TypedDict):
    RoleARN: NotRequired[str],
    DomainARN: NotRequired[str],
    ClusterEndpoint: NotRequired[str],
    IndexName: NotRequired[str],
    TypeName: NotRequired[str],
    IndexRotationPeriod: NotRequired[AmazonopensearchserviceIndexRotationPeriodType],  # (1)
    BufferingHints: NotRequired[AmazonopensearchserviceBufferingHintsTypeDef],  # (2)
    RetryOptions: NotRequired[AmazonopensearchserviceRetryOptionsTypeDef],  # (3)
    S3BackupMode: NotRequired[AmazonopensearchserviceS3BackupModeType],  # (4)
    S3DestinationDescription: NotRequired[S3DestinationDescriptionTypeDef],  # (5)
    ProcessingConfiguration: NotRequired[ProcessingConfigurationTypeDef],  # (6)
    CloudWatchLoggingOptions: NotRequired[CloudWatchLoggingOptionsTypeDef],  # (7)
    VpcConfigurationDescription: NotRequired[VpcConfigurationDescriptionTypeDef],  # (8)
  1. See AmazonopensearchserviceIndexRotationPeriodType
  2. See AmazonopensearchserviceBufferingHintsTypeDef
  3. See AmazonopensearchserviceRetryOptionsTypeDef
  4. See AmazonopensearchserviceS3BackupModeType
  5. See S3DestinationDescriptionTypeDef
  6. See ProcessingConfigurationTypeDef
  7. See CloudWatchLoggingOptionsTypeDef
  8. See VpcConfigurationDescriptionTypeDef

AmazonopensearchserviceDestinationUpdateTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import AmazonopensearchserviceDestinationUpdateTypeDef

def get_value() -> AmazonopensearchserviceDestinationUpdateTypeDef:
    return {
        "RoleARN": ...,
    }
Definition
class AmazonopensearchserviceDestinationUpdateTypeDef(TypedDict):
    RoleARN: NotRequired[str],
    DomainARN: NotRequired[str],
    ClusterEndpoint: NotRequired[str],
    IndexName: NotRequired[str],
    TypeName: NotRequired[str],
    IndexRotationPeriod: NotRequired[AmazonopensearchserviceIndexRotationPeriodType],  # (1)
    BufferingHints: NotRequired[AmazonopensearchserviceBufferingHintsTypeDef],  # (2)
    RetryOptions: NotRequired[AmazonopensearchserviceRetryOptionsTypeDef],  # (3)
    S3Update: NotRequired[S3DestinationUpdateTypeDef],  # (4)
    ProcessingConfiguration: NotRequired[ProcessingConfigurationTypeDef],  # (5)
    CloudWatchLoggingOptions: NotRequired[CloudWatchLoggingOptionsTypeDef],  # (6)
  1. See AmazonopensearchserviceIndexRotationPeriodType
  2. See AmazonopensearchserviceBufferingHintsTypeDef
  3. See AmazonopensearchserviceRetryOptionsTypeDef
  4. See S3DestinationUpdateTypeDef
  5. See ProcessingConfigurationTypeDef
  6. See CloudWatchLoggingOptionsTypeDef

ElasticsearchDestinationConfigurationTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import ElasticsearchDestinationConfigurationTypeDef

def get_value() -> ElasticsearchDestinationConfigurationTypeDef:
    return {
        "RoleARN": ...,
        "IndexName": ...,
        "S3Configuration": ...,
    }
Definition
class ElasticsearchDestinationConfigurationTypeDef(TypedDict):
    RoleARN: str,
    IndexName: str,
    S3Configuration: S3DestinationConfigurationTypeDef,  # (5)
    DomainARN: NotRequired[str],
    ClusterEndpoint: NotRequired[str],
    TypeName: NotRequired[str],
    IndexRotationPeriod: NotRequired[ElasticsearchIndexRotationPeriodType],  # (1)
    BufferingHints: NotRequired[ElasticsearchBufferingHintsTypeDef],  # (2)
    RetryOptions: NotRequired[ElasticsearchRetryOptionsTypeDef],  # (3)
    S3BackupMode: NotRequired[ElasticsearchS3BackupModeType],  # (4)
    ProcessingConfiguration: NotRequired[ProcessingConfigurationTypeDef],  # (6)
    CloudWatchLoggingOptions: NotRequired[CloudWatchLoggingOptionsTypeDef],  # (7)
    VpcConfiguration: NotRequired[VpcConfigurationTypeDef],  # (8)
  1. See ElasticsearchIndexRotationPeriodType
  2. See ElasticsearchBufferingHintsTypeDef
  3. See ElasticsearchRetryOptionsTypeDef
  4. See ElasticsearchS3BackupModeType
  5. See S3DestinationConfigurationTypeDef
  6. See ProcessingConfigurationTypeDef
  7. See CloudWatchLoggingOptionsTypeDef
  8. See VpcConfigurationTypeDef

ElasticsearchDestinationDescriptionTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import ElasticsearchDestinationDescriptionTypeDef

def get_value() -> ElasticsearchDestinationDescriptionTypeDef:
    return {
        "RoleARN": ...,
    }
Definition
class ElasticsearchDestinationDescriptionTypeDef(TypedDict):
    RoleARN: NotRequired[str],
    DomainARN: NotRequired[str],
    ClusterEndpoint: NotRequired[str],
    IndexName: NotRequired[str],
    TypeName: NotRequired[str],
    IndexRotationPeriod: NotRequired[ElasticsearchIndexRotationPeriodType],  # (1)
    BufferingHints: NotRequired[ElasticsearchBufferingHintsTypeDef],  # (2)
    RetryOptions: NotRequired[ElasticsearchRetryOptionsTypeDef],  # (3)
    S3BackupMode: NotRequired[ElasticsearchS3BackupModeType],  # (4)
    S3DestinationDescription: NotRequired[S3DestinationDescriptionTypeDef],  # (5)
    ProcessingConfiguration: NotRequired[ProcessingConfigurationTypeDef],  # (6)
    CloudWatchLoggingOptions: NotRequired[CloudWatchLoggingOptionsTypeDef],  # (7)
    VpcConfigurationDescription: NotRequired[VpcConfigurationDescriptionTypeDef],  # (8)
  1. See ElasticsearchIndexRotationPeriodType
  2. See ElasticsearchBufferingHintsTypeDef
  3. See ElasticsearchRetryOptionsTypeDef
  4. See ElasticsearchS3BackupModeType
  5. See S3DestinationDescriptionTypeDef
  6. See ProcessingConfigurationTypeDef
  7. See CloudWatchLoggingOptionsTypeDef
  8. See VpcConfigurationDescriptionTypeDef

ElasticsearchDestinationUpdateTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import ElasticsearchDestinationUpdateTypeDef

def get_value() -> ElasticsearchDestinationUpdateTypeDef:
    return {
        "RoleARN": ...,
    }
Definition
class ElasticsearchDestinationUpdateTypeDef(TypedDict):
    RoleARN: NotRequired[str],
    DomainARN: NotRequired[str],
    ClusterEndpoint: NotRequired[str],
    IndexName: NotRequired[str],
    TypeName: NotRequired[str],
    IndexRotationPeriod: NotRequired[ElasticsearchIndexRotationPeriodType],  # (1)
    BufferingHints: NotRequired[ElasticsearchBufferingHintsTypeDef],  # (2)
    RetryOptions: NotRequired[ElasticsearchRetryOptionsTypeDef],  # (3)
    S3Update: NotRequired[S3DestinationUpdateTypeDef],  # (4)
    ProcessingConfiguration: NotRequired[ProcessingConfigurationTypeDef],  # (5)
    CloudWatchLoggingOptions: NotRequired[CloudWatchLoggingOptionsTypeDef],  # (6)
  1. See ElasticsearchIndexRotationPeriodType
  2. See ElasticsearchBufferingHintsTypeDef
  3. See ElasticsearchRetryOptionsTypeDef
  4. See S3DestinationUpdateTypeDef
  5. See ProcessingConfigurationTypeDef
  6. See CloudWatchLoggingOptionsTypeDef

HttpEndpointDestinationConfigurationTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import HttpEndpointDestinationConfigurationTypeDef

def get_value() -> HttpEndpointDestinationConfigurationTypeDef:
    return {
        "EndpointConfiguration": ...,
        "S3Configuration": ...,
    }
Definition
class HttpEndpointDestinationConfigurationTypeDef(TypedDict):
    EndpointConfiguration: HttpEndpointConfigurationTypeDef,  # (1)
    S3Configuration: S3DestinationConfigurationTypeDef,  # (8)
    BufferingHints: NotRequired[HttpEndpointBufferingHintsTypeDef],  # (2)
    CloudWatchLoggingOptions: NotRequired[CloudWatchLoggingOptionsTypeDef],  # (3)
    RequestConfiguration: NotRequired[HttpEndpointRequestConfigurationTypeDef],  # (4)
    ProcessingConfiguration: NotRequired[ProcessingConfigurationTypeDef],  # (5)
    RoleARN: NotRequired[str],
    RetryOptions: NotRequired[HttpEndpointRetryOptionsTypeDef],  # (6)
    S3BackupMode: NotRequired[HttpEndpointS3BackupModeType],  # (7)
  1. See HttpEndpointConfigurationTypeDef
  2. See HttpEndpointBufferingHintsTypeDef
  3. See CloudWatchLoggingOptionsTypeDef
  4. See HttpEndpointRequestConfigurationTypeDef
  5. See ProcessingConfigurationTypeDef
  6. See HttpEndpointRetryOptionsTypeDef
  7. See HttpEndpointS3BackupModeType
  8. See S3DestinationConfigurationTypeDef

HttpEndpointDestinationDescriptionTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import HttpEndpointDestinationDescriptionTypeDef

def get_value() -> HttpEndpointDestinationDescriptionTypeDef:
    return {
        "EndpointConfiguration": ...,
    }
Definition
class HttpEndpointDestinationDescriptionTypeDef(TypedDict):
    EndpointConfiguration: NotRequired[HttpEndpointDescriptionTypeDef],  # (1)
    BufferingHints: NotRequired[HttpEndpointBufferingHintsTypeDef],  # (2)
    CloudWatchLoggingOptions: NotRequired[CloudWatchLoggingOptionsTypeDef],  # (3)
    RequestConfiguration: NotRequired[HttpEndpointRequestConfigurationTypeDef],  # (4)
    ProcessingConfiguration: NotRequired[ProcessingConfigurationTypeDef],  # (5)
    RoleARN: NotRequired[str],
    RetryOptions: NotRequired[HttpEndpointRetryOptionsTypeDef],  # (6)
    S3BackupMode: NotRequired[HttpEndpointS3BackupModeType],  # (7)
    S3DestinationDescription: NotRequired[S3DestinationDescriptionTypeDef],  # (8)
  1. See HttpEndpointDescriptionTypeDef
  2. See HttpEndpointBufferingHintsTypeDef
  3. See CloudWatchLoggingOptionsTypeDef
  4. See HttpEndpointRequestConfigurationTypeDef
  5. See ProcessingConfigurationTypeDef
  6. See HttpEndpointRetryOptionsTypeDef
  7. See HttpEndpointS3BackupModeType
  8. See S3DestinationDescriptionTypeDef

HttpEndpointDestinationUpdateTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import HttpEndpointDestinationUpdateTypeDef

def get_value() -> HttpEndpointDestinationUpdateTypeDef:
    return {
        "EndpointConfiguration": ...,
    }
Definition
class HttpEndpointDestinationUpdateTypeDef(TypedDict):
    EndpointConfiguration: NotRequired[HttpEndpointConfigurationTypeDef],  # (1)
    BufferingHints: NotRequired[HttpEndpointBufferingHintsTypeDef],  # (2)
    CloudWatchLoggingOptions: NotRequired[CloudWatchLoggingOptionsTypeDef],  # (3)
    RequestConfiguration: NotRequired[HttpEndpointRequestConfigurationTypeDef],  # (4)
    ProcessingConfiguration: NotRequired[ProcessingConfigurationTypeDef],  # (5)
    RoleARN: NotRequired[str],
    RetryOptions: NotRequired[HttpEndpointRetryOptionsTypeDef],  # (6)
    S3BackupMode: NotRequired[HttpEndpointS3BackupModeType],  # (7)
    S3Update: NotRequired[S3DestinationUpdateTypeDef],  # (8)
  1. See HttpEndpointConfigurationTypeDef
  2. See HttpEndpointBufferingHintsTypeDef
  3. See CloudWatchLoggingOptionsTypeDef
  4. See HttpEndpointRequestConfigurationTypeDef
  5. See ProcessingConfigurationTypeDef
  6. See HttpEndpointRetryOptionsTypeDef
  7. See HttpEndpointS3BackupModeType
  8. See S3DestinationUpdateTypeDef

RedshiftDestinationConfigurationTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import RedshiftDestinationConfigurationTypeDef

def get_value() -> RedshiftDestinationConfigurationTypeDef:
    return {
        "RoleARN": ...,
        "ClusterJDBCURL": ...,
        "CopyCommand": ...,
        "Username": ...,
        "Password": ...,
        "S3Configuration": ...,
    }
Definition
class RedshiftDestinationConfigurationTypeDef(TypedDict):
    RoleARN: str,
    ClusterJDBCURL: str,
    CopyCommand: CopyCommandTypeDef,  # (1)
    Username: str,
    Password: str,
    S3Configuration: S3DestinationConfigurationTypeDef,  # (3)
    RetryOptions: NotRequired[RedshiftRetryOptionsTypeDef],  # (2)
    ProcessingConfiguration: NotRequired[ProcessingConfigurationTypeDef],  # (4)
    S3BackupMode: NotRequired[RedshiftS3BackupModeType],  # (5)
    S3BackupConfiguration: NotRequired[S3DestinationConfigurationTypeDef],  # (3)
    CloudWatchLoggingOptions: NotRequired[CloudWatchLoggingOptionsTypeDef],  # (7)
  1. See CopyCommandTypeDef
  2. See RedshiftRetryOptionsTypeDef
  3. See S3DestinationConfigurationTypeDef
  4. See ProcessingConfigurationTypeDef
  5. See RedshiftS3BackupModeType
  6. See S3DestinationConfigurationTypeDef
  7. See CloudWatchLoggingOptionsTypeDef

RedshiftDestinationDescriptionTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import RedshiftDestinationDescriptionTypeDef

def get_value() -> RedshiftDestinationDescriptionTypeDef:
    return {
        "RoleARN": ...,
        "ClusterJDBCURL": ...,
        "CopyCommand": ...,
        "Username": ...,
        "S3DestinationDescription": ...,
    }
Definition
class RedshiftDestinationDescriptionTypeDef(TypedDict):
    RoleARN: str,
    ClusterJDBCURL: str,
    CopyCommand: CopyCommandTypeDef,  # (1)
    Username: str,
    S3DestinationDescription: S3DestinationDescriptionTypeDef,  # (3)
    RetryOptions: NotRequired[RedshiftRetryOptionsTypeDef],  # (2)
    ProcessingConfiguration: NotRequired[ProcessingConfigurationTypeDef],  # (4)
    S3BackupMode: NotRequired[RedshiftS3BackupModeType],  # (5)
    S3BackupDescription: NotRequired[S3DestinationDescriptionTypeDef],  # (3)
    CloudWatchLoggingOptions: NotRequired[CloudWatchLoggingOptionsTypeDef],  # (7)
  1. See CopyCommandTypeDef
  2. See RedshiftRetryOptionsTypeDef
  3. See S3DestinationDescriptionTypeDef
  4. See ProcessingConfigurationTypeDef
  5. See RedshiftS3BackupModeType
  6. See S3DestinationDescriptionTypeDef
  7. See CloudWatchLoggingOptionsTypeDef

RedshiftDestinationUpdateTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import RedshiftDestinationUpdateTypeDef

def get_value() -> RedshiftDestinationUpdateTypeDef:
    return {
        "RoleARN": ...,
    }
Definition
class RedshiftDestinationUpdateTypeDef(TypedDict):
    RoleARN: NotRequired[str],
    ClusterJDBCURL: NotRequired[str],
    CopyCommand: NotRequired[CopyCommandTypeDef],  # (1)
    Username: NotRequired[str],
    Password: NotRequired[str],
    RetryOptions: NotRequired[RedshiftRetryOptionsTypeDef],  # (2)
    S3Update: NotRequired[S3DestinationUpdateTypeDef],  # (3)
    ProcessingConfiguration: NotRequired[ProcessingConfigurationTypeDef],  # (4)
    S3BackupMode: NotRequired[RedshiftS3BackupModeType],  # (5)
    S3BackupUpdate: NotRequired[S3DestinationUpdateTypeDef],  # (3)
    CloudWatchLoggingOptions: NotRequired[CloudWatchLoggingOptionsTypeDef],  # (7)
  1. See CopyCommandTypeDef
  2. See RedshiftRetryOptionsTypeDef
  3. See S3DestinationUpdateTypeDef
  4. See ProcessingConfigurationTypeDef
  5. See RedshiftS3BackupModeType
  6. See S3DestinationUpdateTypeDef
  7. See CloudWatchLoggingOptionsTypeDef

SplunkDestinationConfigurationTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import SplunkDestinationConfigurationTypeDef

def get_value() -> SplunkDestinationConfigurationTypeDef:
    return {
        "HECEndpoint": ...,
        "HECEndpointType": ...,
        "HECToken": ...,
        "S3Configuration": ...,
    }
Definition
class SplunkDestinationConfigurationTypeDef(TypedDict):
    HECEndpoint: str,
    HECEndpointType: HECEndpointTypeType,  # (1)
    HECToken: str,
    S3Configuration: S3DestinationConfigurationTypeDef,  # (4)
    HECAcknowledgmentTimeoutInSeconds: NotRequired[int],
    RetryOptions: NotRequired[SplunkRetryOptionsTypeDef],  # (2)
    S3BackupMode: NotRequired[SplunkS3BackupModeType],  # (3)
    ProcessingConfiguration: NotRequired[ProcessingConfigurationTypeDef],  # (5)
    CloudWatchLoggingOptions: NotRequired[CloudWatchLoggingOptionsTypeDef],  # (6)
  1. See HECEndpointTypeType
  2. See SplunkRetryOptionsTypeDef
  3. See SplunkS3BackupModeType
  4. See S3DestinationConfigurationTypeDef
  5. See ProcessingConfigurationTypeDef
  6. See CloudWatchLoggingOptionsTypeDef

SplunkDestinationDescriptionTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import SplunkDestinationDescriptionTypeDef

def get_value() -> SplunkDestinationDescriptionTypeDef:
    return {
        "HECEndpoint": ...,
    }
Definition
class SplunkDestinationDescriptionTypeDef(TypedDict):
    HECEndpoint: NotRequired[str],
    HECEndpointType: NotRequired[HECEndpointTypeType],  # (1)
    HECToken: NotRequired[str],
    HECAcknowledgmentTimeoutInSeconds: NotRequired[int],
    RetryOptions: NotRequired[SplunkRetryOptionsTypeDef],  # (2)
    S3BackupMode: NotRequired[SplunkS3BackupModeType],  # (3)
    S3DestinationDescription: NotRequired[S3DestinationDescriptionTypeDef],  # (4)
    ProcessingConfiguration: NotRequired[ProcessingConfigurationTypeDef],  # (5)
    CloudWatchLoggingOptions: NotRequired[CloudWatchLoggingOptionsTypeDef],  # (6)
  1. See HECEndpointTypeType
  2. See SplunkRetryOptionsTypeDef
  3. See SplunkS3BackupModeType
  4. See S3DestinationDescriptionTypeDef
  5. See ProcessingConfigurationTypeDef
  6. See CloudWatchLoggingOptionsTypeDef

SplunkDestinationUpdateTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import SplunkDestinationUpdateTypeDef

def get_value() -> SplunkDestinationUpdateTypeDef:
    return {
        "HECEndpoint": ...,
    }
Definition
class SplunkDestinationUpdateTypeDef(TypedDict):
    HECEndpoint: NotRequired[str],
    HECEndpointType: NotRequired[HECEndpointTypeType],  # (1)
    HECToken: NotRequired[str],
    HECAcknowledgmentTimeoutInSeconds: NotRequired[int],
    RetryOptions: NotRequired[SplunkRetryOptionsTypeDef],  # (2)
    S3BackupMode: NotRequired[SplunkS3BackupModeType],  # (3)
    S3Update: NotRequired[S3DestinationUpdateTypeDef],  # (4)
    ProcessingConfiguration: NotRequired[ProcessingConfigurationTypeDef],  # (5)
    CloudWatchLoggingOptions: NotRequired[CloudWatchLoggingOptionsTypeDef],  # (6)
  1. See HECEndpointTypeType
  2. See SplunkRetryOptionsTypeDef
  3. See SplunkS3BackupModeType
  4. See S3DestinationUpdateTypeDef
  5. See ProcessingConfigurationTypeDef
  6. See CloudWatchLoggingOptionsTypeDef

ExtendedS3DestinationConfigurationTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import ExtendedS3DestinationConfigurationTypeDef

def get_value() -> ExtendedS3DestinationConfigurationTypeDef:
    return {
        "RoleARN": ...,
        "BucketARN": ...,
    }
Definition
class ExtendedS3DestinationConfigurationTypeDef(TypedDict):
    RoleARN: str,
    BucketARN: str,
    Prefix: NotRequired[str],
    ErrorOutputPrefix: NotRequired[str],
    BufferingHints: NotRequired[BufferingHintsTypeDef],  # (1)
    CompressionFormat: NotRequired[CompressionFormatType],  # (2)
    EncryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef],  # (3)
    CloudWatchLoggingOptions: NotRequired[CloudWatchLoggingOptionsTypeDef],  # (4)
    ProcessingConfiguration: NotRequired[ProcessingConfigurationTypeDef],  # (5)
    S3BackupMode: NotRequired[S3BackupModeType],  # (6)
    S3BackupConfiguration: NotRequired[S3DestinationConfigurationTypeDef],  # (7)
    DataFormatConversionConfiguration: NotRequired[DataFormatConversionConfigurationTypeDef],  # (8)
    DynamicPartitioningConfiguration: NotRequired[DynamicPartitioningConfigurationTypeDef],  # (9)
  1. See BufferingHintsTypeDef
  2. See CompressionFormatType
  3. See EncryptionConfigurationTypeDef
  4. See CloudWatchLoggingOptionsTypeDef
  5. See ProcessingConfigurationTypeDef
  6. See S3BackupModeType
  7. See S3DestinationConfigurationTypeDef
  8. See DataFormatConversionConfigurationTypeDef
  9. See DynamicPartitioningConfigurationTypeDef

ExtendedS3DestinationDescriptionTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import ExtendedS3DestinationDescriptionTypeDef

def get_value() -> ExtendedS3DestinationDescriptionTypeDef:
    return {
        "RoleARN": ...,
        "BucketARN": ...,
        "BufferingHints": ...,
        "CompressionFormat": ...,
        "EncryptionConfiguration": ...,
    }
Definition
class ExtendedS3DestinationDescriptionTypeDef(TypedDict):
    RoleARN: str,
    BucketARN: str,
    BufferingHints: BufferingHintsTypeDef,  # (1)
    CompressionFormat: CompressionFormatType,  # (2)
    EncryptionConfiguration: EncryptionConfigurationTypeDef,  # (3)
    Prefix: NotRequired[str],
    ErrorOutputPrefix: NotRequired[str],
    CloudWatchLoggingOptions: NotRequired[CloudWatchLoggingOptionsTypeDef],  # (4)
    ProcessingConfiguration: NotRequired[ProcessingConfigurationTypeDef],  # (5)
    S3BackupMode: NotRequired[S3BackupModeType],  # (6)
    S3BackupDescription: NotRequired[S3DestinationDescriptionTypeDef],  # (7)
    DataFormatConversionConfiguration: NotRequired[DataFormatConversionConfigurationTypeDef],  # (8)
    DynamicPartitioningConfiguration: NotRequired[DynamicPartitioningConfigurationTypeDef],  # (9)
  1. See BufferingHintsTypeDef
  2. See CompressionFormatType
  3. See EncryptionConfigurationTypeDef
  4. See CloudWatchLoggingOptionsTypeDef
  5. See ProcessingConfigurationTypeDef
  6. See S3BackupModeType
  7. See S3DestinationDescriptionTypeDef
  8. See DataFormatConversionConfigurationTypeDef
  9. See DynamicPartitioningConfigurationTypeDef

ExtendedS3DestinationUpdateTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import ExtendedS3DestinationUpdateTypeDef

def get_value() -> ExtendedS3DestinationUpdateTypeDef:
    return {
        "RoleARN": ...,
    }
Definition
class ExtendedS3DestinationUpdateTypeDef(TypedDict):
    RoleARN: NotRequired[str],
    BucketARN: NotRequired[str],
    Prefix: NotRequired[str],
    ErrorOutputPrefix: NotRequired[str],
    BufferingHints: NotRequired[BufferingHintsTypeDef],  # (1)
    CompressionFormat: NotRequired[CompressionFormatType],  # (2)
    EncryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef],  # (3)
    CloudWatchLoggingOptions: NotRequired[CloudWatchLoggingOptionsTypeDef],  # (4)
    ProcessingConfiguration: NotRequired[ProcessingConfigurationTypeDef],  # (5)
    S3BackupMode: NotRequired[S3BackupModeType],  # (6)
    S3BackupUpdate: NotRequired[S3DestinationUpdateTypeDef],  # (7)
    DataFormatConversionConfiguration: NotRequired[DataFormatConversionConfigurationTypeDef],  # (8)
    DynamicPartitioningConfiguration: NotRequired[DynamicPartitioningConfigurationTypeDef],  # (9)
  1. See BufferingHintsTypeDef
  2. See CompressionFormatType
  3. See EncryptionConfigurationTypeDef
  4. See CloudWatchLoggingOptionsTypeDef
  5. See ProcessingConfigurationTypeDef
  6. See S3BackupModeType
  7. See S3DestinationUpdateTypeDef
  8. See DataFormatConversionConfigurationTypeDef
  9. See DynamicPartitioningConfigurationTypeDef

CreateDeliveryStreamInputRequestTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import CreateDeliveryStreamInputRequestTypeDef

def get_value() -> CreateDeliveryStreamInputRequestTypeDef:
    return {
        "DeliveryStreamName": ...,
    }
Definition
class CreateDeliveryStreamInputRequestTypeDef(TypedDict):
    DeliveryStreamName: str,
    DeliveryStreamType: NotRequired[DeliveryStreamTypeType],  # (1)
    KinesisStreamSourceConfiguration: NotRequired[KinesisStreamSourceConfigurationTypeDef],  # (2)
    DeliveryStreamEncryptionConfigurationInput: NotRequired[DeliveryStreamEncryptionConfigurationInputTypeDef],  # (3)
    S3DestinationConfiguration: NotRequired[S3DestinationConfigurationTypeDef],  # (4)
    ExtendedS3DestinationConfiguration: NotRequired[ExtendedS3DestinationConfigurationTypeDef],  # (5)
    RedshiftDestinationConfiguration: NotRequired[RedshiftDestinationConfigurationTypeDef],  # (6)
    ElasticsearchDestinationConfiguration: NotRequired[ElasticsearchDestinationConfigurationTypeDef],  # (7)
    AmazonopensearchserviceDestinationConfiguration: NotRequired[AmazonopensearchserviceDestinationConfigurationTypeDef],  # (8)
    SplunkDestinationConfiguration: NotRequired[SplunkDestinationConfigurationTypeDef],  # (9)
    HttpEndpointDestinationConfiguration: NotRequired[HttpEndpointDestinationConfigurationTypeDef],  # (10)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (11)
  1. See DeliveryStreamTypeType
  2. See KinesisStreamSourceConfigurationTypeDef
  3. See DeliveryStreamEncryptionConfigurationInputTypeDef
  4. See S3DestinationConfigurationTypeDef
  5. See ExtendedS3DestinationConfigurationTypeDef
  6. See RedshiftDestinationConfigurationTypeDef
  7. See ElasticsearchDestinationConfigurationTypeDef
  8. See AmazonopensearchserviceDestinationConfigurationTypeDef
  9. See SplunkDestinationConfigurationTypeDef
  10. See HttpEndpointDestinationConfigurationTypeDef
  11. See TagTypeDef

DestinationDescriptionTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import DestinationDescriptionTypeDef

def get_value() -> DestinationDescriptionTypeDef:
    return {
        "DestinationId": ...,
    }
Definition
class DestinationDescriptionTypeDef(TypedDict):
    DestinationId: str,
    S3DestinationDescription: NotRequired[S3DestinationDescriptionTypeDef],  # (1)
    ExtendedS3DestinationDescription: NotRequired[ExtendedS3DestinationDescriptionTypeDef],  # (2)
    RedshiftDestinationDescription: NotRequired[RedshiftDestinationDescriptionTypeDef],  # (3)
    ElasticsearchDestinationDescription: NotRequired[ElasticsearchDestinationDescriptionTypeDef],  # (4)
    AmazonopensearchserviceDestinationDescription: NotRequired[AmazonopensearchserviceDestinationDescriptionTypeDef],  # (5)
    SplunkDestinationDescription: NotRequired[SplunkDestinationDescriptionTypeDef],  # (6)
    HttpEndpointDestinationDescription: NotRequired[HttpEndpointDestinationDescriptionTypeDef],  # (7)
  1. See S3DestinationDescriptionTypeDef
  2. See ExtendedS3DestinationDescriptionTypeDef
  3. See RedshiftDestinationDescriptionTypeDef
  4. See ElasticsearchDestinationDescriptionTypeDef
  5. See AmazonopensearchserviceDestinationDescriptionTypeDef
  6. See SplunkDestinationDescriptionTypeDef
  7. See HttpEndpointDestinationDescriptionTypeDef

UpdateDestinationInputRequestTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import UpdateDestinationInputRequestTypeDef

def get_value() -> UpdateDestinationInputRequestTypeDef:
    return {
        "DeliveryStreamName": ...,
        "CurrentDeliveryStreamVersionId": ...,
        "DestinationId": ...,
    }
Definition
class UpdateDestinationInputRequestTypeDef(TypedDict):
    DeliveryStreamName: str,
    CurrentDeliveryStreamVersionId: str,
    DestinationId: str,
    S3DestinationUpdate: NotRequired[S3DestinationUpdateTypeDef],  # (1)
    ExtendedS3DestinationUpdate: NotRequired[ExtendedS3DestinationUpdateTypeDef],  # (2)
    RedshiftDestinationUpdate: NotRequired[RedshiftDestinationUpdateTypeDef],  # (3)
    ElasticsearchDestinationUpdate: NotRequired[ElasticsearchDestinationUpdateTypeDef],  # (4)
    AmazonopensearchserviceDestinationUpdate: NotRequired[AmazonopensearchserviceDestinationUpdateTypeDef],  # (5)
    SplunkDestinationUpdate: NotRequired[SplunkDestinationUpdateTypeDef],  # (6)
    HttpEndpointDestinationUpdate: NotRequired[HttpEndpointDestinationUpdateTypeDef],  # (7)
  1. See S3DestinationUpdateTypeDef
  2. See ExtendedS3DestinationUpdateTypeDef
  3. See RedshiftDestinationUpdateTypeDef
  4. See ElasticsearchDestinationUpdateTypeDef
  5. See AmazonopensearchserviceDestinationUpdateTypeDef
  6. See SplunkDestinationUpdateTypeDef
  7. See HttpEndpointDestinationUpdateTypeDef

DeliveryStreamDescriptionTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import DeliveryStreamDescriptionTypeDef

def get_value() -> DeliveryStreamDescriptionTypeDef:
    return {
        "DeliveryStreamName": ...,
        "DeliveryStreamARN": ...,
        "DeliveryStreamStatus": ...,
        "DeliveryStreamType": ...,
        "VersionId": ...,
        "Destinations": ...,
        "HasMoreDestinations": ...,
    }
Definition
class DeliveryStreamDescriptionTypeDef(TypedDict):
    DeliveryStreamName: str,
    DeliveryStreamARN: str,
    DeliveryStreamStatus: DeliveryStreamStatusType,  # (1)
    DeliveryStreamType: DeliveryStreamTypeType,  # (4)
    VersionId: str,
    Destinations: List[DestinationDescriptionTypeDef],  # (6)
    HasMoreDestinations: bool,
    FailureDescription: NotRequired[FailureDescriptionTypeDef],  # (2)
    DeliveryStreamEncryptionConfiguration: NotRequired[DeliveryStreamEncryptionConfigurationTypeDef],  # (3)
    CreateTimestamp: NotRequired[datetime],
    LastUpdateTimestamp: NotRequired[datetime],
    Source: NotRequired[SourceDescriptionTypeDef],  # (5)
  1. See DeliveryStreamStatusType
  2. See FailureDescriptionTypeDef
  3. See DeliveryStreamEncryptionConfigurationTypeDef
  4. See DeliveryStreamTypeType
  5. See SourceDescriptionTypeDef
  6. See DestinationDescriptionTypeDef

DescribeDeliveryStreamOutputTypeDef

Usage Example
from mypy_boto3_firehose.type_defs import DescribeDeliveryStreamOutputTypeDef

def get_value() -> DescribeDeliveryStreamOutputTypeDef:
    return {
        "DeliveryStreamDescription": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeDeliveryStreamOutputTypeDef(TypedDict):
    DeliveryStreamDescription: DeliveryStreamDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeliveryStreamDescriptionTypeDef
  2. See ResponseMetadataTypeDef