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,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

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 DeserializerTypeDef

S3DestinationConfigurationTypeDef#

# S3DestinationConfigurationTypeDef 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#

# S3DestinationDescriptionTypeDef 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#

# S3DestinationUpdateTypeDef 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#

# OutputFormatConfigurationTypeDef definition

class OutputFormatConfigurationTypeDef(TypedDict):
    Serializer: NotRequired[SerializerTypeDef],  # (1)
  1. See SerializerTypeDef

ProcessingConfigurationTypeDef#

# ProcessingConfigurationTypeDef definition

class ProcessingConfigurationTypeDef(TypedDict):
    Enabled: NotRequired[bool],
    Processors: NotRequired[Sequence[ProcessorTypeDef]],  # (1)
  1. See ProcessorTypeDef

DataFormatConversionConfigurationTypeDef#

# DataFormatConversionConfigurationTypeDef 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

AmazonOpenSearchServerlessDestinationConfigurationTypeDef#

# AmazonOpenSearchServerlessDestinationConfigurationTypeDef definition

class AmazonOpenSearchServerlessDestinationConfigurationTypeDef(TypedDict):
    RoleARN: str,
    IndexName: str,
    S3Configuration: S3DestinationConfigurationTypeDef,  # (4)
    CollectionEndpoint: NotRequired[str],
    BufferingHints: NotRequired[AmazonOpenSearchServerlessBufferingHintsTypeDef],  # (1)
    RetryOptions: NotRequired[AmazonOpenSearchServerlessRetryOptionsTypeDef],  # (2)
    S3BackupMode: NotRequired[AmazonOpenSearchServerlessS3BackupModeType],  # (3)
    ProcessingConfiguration: NotRequired[ProcessingConfigurationTypeDef],  # (5)
    CloudWatchLoggingOptions: NotRequired[CloudWatchLoggingOptionsTypeDef],  # (6)
    VpcConfiguration: NotRequired[VpcConfigurationTypeDef],  # (7)
  1. See AmazonOpenSearchServerlessBufferingHintsTypeDef
  2. See AmazonOpenSearchServerlessRetryOptionsTypeDef
  3. See AmazonOpenSearchServerlessS3BackupModeType
  4. See S3DestinationConfigurationTypeDef
  5. See ProcessingConfigurationTypeDef
  6. See CloudWatchLoggingOptionsTypeDef
  7. See VpcConfigurationTypeDef

AmazonOpenSearchServerlessDestinationDescriptionTypeDef#

# AmazonOpenSearchServerlessDestinationDescriptionTypeDef definition

class AmazonOpenSearchServerlessDestinationDescriptionTypeDef(TypedDict):
    RoleARN: NotRequired[str],
    CollectionEndpoint: NotRequired[str],
    IndexName: NotRequired[str],
    BufferingHints: NotRequired[AmazonOpenSearchServerlessBufferingHintsTypeDef],  # (1)
    RetryOptions: NotRequired[AmazonOpenSearchServerlessRetryOptionsTypeDef],  # (2)
    S3BackupMode: NotRequired[AmazonOpenSearchServerlessS3BackupModeType],  # (3)
    S3DestinationDescription: NotRequired[S3DestinationDescriptionTypeDef],  # (4)
    ProcessingConfiguration: NotRequired[ProcessingConfigurationTypeDef],  # (5)
    CloudWatchLoggingOptions: NotRequired[CloudWatchLoggingOptionsTypeDef],  # (6)
    VpcConfigurationDescription: NotRequired[VpcConfigurationDescriptionTypeDef],  # (7)
  1. See AmazonOpenSearchServerlessBufferingHintsTypeDef
  2. See AmazonOpenSearchServerlessRetryOptionsTypeDef
  3. See AmazonOpenSearchServerlessS3BackupModeType
  4. See S3DestinationDescriptionTypeDef
  5. See ProcessingConfigurationTypeDef
  6. See CloudWatchLoggingOptionsTypeDef
  7. See VpcConfigurationDescriptionTypeDef

AmazonOpenSearchServerlessDestinationUpdateTypeDef#

# AmazonOpenSearchServerlessDestinationUpdateTypeDef definition

class AmazonOpenSearchServerlessDestinationUpdateTypeDef(TypedDict):
    RoleARN: NotRequired[str],
    CollectionEndpoint: NotRequired[str],
    IndexName: NotRequired[str],
    BufferingHints: NotRequired[AmazonOpenSearchServerlessBufferingHintsTypeDef],  # (1)
    RetryOptions: NotRequired[AmazonOpenSearchServerlessRetryOptionsTypeDef],  # (2)
    S3Update: NotRequired[S3DestinationUpdateTypeDef],  # (3)
    ProcessingConfiguration: NotRequired[ProcessingConfigurationTypeDef],  # (4)
    CloudWatchLoggingOptions: NotRequired[CloudWatchLoggingOptionsTypeDef],  # (5)
  1. See AmazonOpenSearchServerlessBufferingHintsTypeDef
  2. See AmazonOpenSearchServerlessRetryOptionsTypeDef
  3. See S3DestinationUpdateTypeDef
  4. See ProcessingConfigurationTypeDef
  5. See CloudWatchLoggingOptionsTypeDef

AmazonopensearchserviceDestinationConfigurationTypeDef#

# AmazonopensearchserviceDestinationConfigurationTypeDef 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)
    DocumentIdOptions: NotRequired[DocumentIdOptionsTypeDef],  # (9)
  1. See AmazonopensearchserviceIndexRotationPeriodType
  2. See AmazonopensearchserviceBufferingHintsTypeDef
  3. See AmazonopensearchserviceRetryOptionsTypeDef
  4. See AmazonopensearchserviceS3BackupModeType
  5. See S3DestinationConfigurationTypeDef
  6. See ProcessingConfigurationTypeDef
  7. See CloudWatchLoggingOptionsTypeDef
  8. See VpcConfigurationTypeDef
  9. See DocumentIdOptionsTypeDef

AmazonopensearchserviceDestinationDescriptionTypeDef#

# AmazonopensearchserviceDestinationDescriptionTypeDef 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)
    DocumentIdOptions: NotRequired[DocumentIdOptionsTypeDef],  # (9)
  1. See AmazonopensearchserviceIndexRotationPeriodType
  2. See AmazonopensearchserviceBufferingHintsTypeDef
  3. See AmazonopensearchserviceRetryOptionsTypeDef
  4. See AmazonopensearchserviceS3BackupModeType
  5. See S3DestinationDescriptionTypeDef
  6. See ProcessingConfigurationTypeDef
  7. See CloudWatchLoggingOptionsTypeDef
  8. See VpcConfigurationDescriptionTypeDef
  9. See DocumentIdOptionsTypeDef

AmazonopensearchserviceDestinationUpdateTypeDef#

# AmazonopensearchserviceDestinationUpdateTypeDef 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)
    DocumentIdOptions: NotRequired[DocumentIdOptionsTypeDef],  # (7)
  1. See AmazonopensearchserviceIndexRotationPeriodType
  2. See AmazonopensearchserviceBufferingHintsTypeDef
  3. See AmazonopensearchserviceRetryOptionsTypeDef
  4. See S3DestinationUpdateTypeDef
  5. See ProcessingConfigurationTypeDef
  6. See CloudWatchLoggingOptionsTypeDef
  7. See DocumentIdOptionsTypeDef

ElasticsearchDestinationConfigurationTypeDef#

# ElasticsearchDestinationConfigurationTypeDef 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)
    DocumentIdOptions: NotRequired[DocumentIdOptionsTypeDef],  # (9)
  1. See ElasticsearchIndexRotationPeriodType
  2. See ElasticsearchBufferingHintsTypeDef
  3. See ElasticsearchRetryOptionsTypeDef
  4. See ElasticsearchS3BackupModeType
  5. See S3DestinationConfigurationTypeDef
  6. See ProcessingConfigurationTypeDef
  7. See CloudWatchLoggingOptionsTypeDef
  8. See VpcConfigurationTypeDef
  9. See DocumentIdOptionsTypeDef

ElasticsearchDestinationDescriptionTypeDef#

# ElasticsearchDestinationDescriptionTypeDef 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)
    DocumentIdOptions: NotRequired[DocumentIdOptionsTypeDef],  # (9)
  1. See ElasticsearchIndexRotationPeriodType
  2. See ElasticsearchBufferingHintsTypeDef
  3. See ElasticsearchRetryOptionsTypeDef
  4. See ElasticsearchS3BackupModeType
  5. See S3DestinationDescriptionTypeDef
  6. See ProcessingConfigurationTypeDef
  7. See CloudWatchLoggingOptionsTypeDef
  8. See VpcConfigurationDescriptionTypeDef
  9. See DocumentIdOptionsTypeDef

ElasticsearchDestinationUpdateTypeDef#

# ElasticsearchDestinationUpdateTypeDef 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)
    DocumentIdOptions: NotRequired[DocumentIdOptionsTypeDef],  # (7)
  1. See ElasticsearchIndexRotationPeriodType
  2. See ElasticsearchBufferingHintsTypeDef
  3. See ElasticsearchRetryOptionsTypeDef
  4. See S3DestinationUpdateTypeDef
  5. See ProcessingConfigurationTypeDef
  6. See CloudWatchLoggingOptionsTypeDef
  7. See DocumentIdOptionsTypeDef

HttpEndpointDestinationConfigurationTypeDef#

# HttpEndpointDestinationConfigurationTypeDef 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#

# HttpEndpointDestinationDescriptionTypeDef 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#

# HttpEndpointDestinationUpdateTypeDef 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#

# RedshiftDestinationConfigurationTypeDef 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#

# RedshiftDestinationDescriptionTypeDef 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#

# RedshiftDestinationUpdateTypeDef 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

SnowflakeDestinationConfigurationTypeDef#

# SnowflakeDestinationConfigurationTypeDef definition

class SnowflakeDestinationConfigurationTypeDef(TypedDict):
    AccountUrl: str,
    PrivateKey: str,
    User: str,
    Database: str,
    Schema: str,
    Table: str,
    RoleARN: str,
    S3Configuration: S3DestinationConfigurationTypeDef,  # (8)
    KeyPassphrase: NotRequired[str],
    SnowflakeRoleConfiguration: NotRequired[SnowflakeRoleConfigurationTypeDef],  # (1)
    DataLoadingOption: NotRequired[SnowflakeDataLoadingOptionType],  # (2)
    MetaDataColumnName: NotRequired[str],
    ContentColumnName: NotRequired[str],
    SnowflakeVpcConfiguration: NotRequired[SnowflakeVpcConfigurationTypeDef],  # (3)
    CloudWatchLoggingOptions: NotRequired[CloudWatchLoggingOptionsTypeDef],  # (4)
    ProcessingConfiguration: NotRequired[ProcessingConfigurationTypeDef],  # (5)
    RetryOptions: NotRequired[SnowflakeRetryOptionsTypeDef],  # (6)
    S3BackupMode: NotRequired[SnowflakeS3BackupModeType],  # (7)
  1. See SnowflakeRoleConfigurationTypeDef
  2. See SnowflakeDataLoadingOptionType
  3. See SnowflakeVpcConfigurationTypeDef
  4. See CloudWatchLoggingOptionsTypeDef
  5. See ProcessingConfigurationTypeDef
  6. See SnowflakeRetryOptionsTypeDef
  7. See SnowflakeS3BackupModeType
  8. See S3DestinationConfigurationTypeDef

SnowflakeDestinationDescriptionTypeDef#

# SnowflakeDestinationDescriptionTypeDef definition

class SnowflakeDestinationDescriptionTypeDef(TypedDict):
    AccountUrl: NotRequired[str],
    User: NotRequired[str],
    Database: NotRequired[str],
    Schema: NotRequired[str],
    Table: NotRequired[str],
    SnowflakeRoleConfiguration: NotRequired[SnowflakeRoleConfigurationTypeDef],  # (1)
    DataLoadingOption: NotRequired[SnowflakeDataLoadingOptionType],  # (2)
    MetaDataColumnName: NotRequired[str],
    ContentColumnName: NotRequired[str],
    SnowflakeVpcConfiguration: NotRequired[SnowflakeVpcConfigurationTypeDef],  # (3)
    CloudWatchLoggingOptions: NotRequired[CloudWatchLoggingOptionsTypeDef],  # (4)
    ProcessingConfiguration: NotRequired[ProcessingConfigurationTypeDef],  # (5)
    RoleARN: NotRequired[str],
    RetryOptions: NotRequired[SnowflakeRetryOptionsTypeDef],  # (6)
    S3BackupMode: NotRequired[SnowflakeS3BackupModeType],  # (7)
    S3DestinationDescription: NotRequired[S3DestinationDescriptionTypeDef],  # (8)
  1. See SnowflakeRoleConfigurationTypeDef
  2. See SnowflakeDataLoadingOptionType
  3. See SnowflakeVpcConfigurationTypeDef
  4. See CloudWatchLoggingOptionsTypeDef
  5. See ProcessingConfigurationTypeDef
  6. See SnowflakeRetryOptionsTypeDef
  7. See SnowflakeS3BackupModeType
  8. See S3DestinationDescriptionTypeDef

SnowflakeDestinationUpdateTypeDef#

# SnowflakeDestinationUpdateTypeDef definition

class SnowflakeDestinationUpdateTypeDef(TypedDict):
    AccountUrl: NotRequired[str],
    PrivateKey: NotRequired[str],
    KeyPassphrase: NotRequired[str],
    User: NotRequired[str],
    Database: NotRequired[str],
    Schema: NotRequired[str],
    Table: NotRequired[str],
    SnowflakeRoleConfiguration: NotRequired[SnowflakeRoleConfigurationTypeDef],  # (1)
    DataLoadingOption: NotRequired[SnowflakeDataLoadingOptionType],  # (2)
    MetaDataColumnName: NotRequired[str],
    ContentColumnName: NotRequired[str],
    CloudWatchLoggingOptions: NotRequired[CloudWatchLoggingOptionsTypeDef],  # (3)
    ProcessingConfiguration: NotRequired[ProcessingConfigurationTypeDef],  # (4)
    RoleARN: NotRequired[str],
    RetryOptions: NotRequired[SnowflakeRetryOptionsTypeDef],  # (5)
    S3BackupMode: NotRequired[SnowflakeS3BackupModeType],  # (6)
    S3Update: NotRequired[S3DestinationUpdateTypeDef],  # (7)
  1. See SnowflakeRoleConfigurationTypeDef
  2. See SnowflakeDataLoadingOptionType
  3. See CloudWatchLoggingOptionsTypeDef
  4. See ProcessingConfigurationTypeDef
  5. See SnowflakeRetryOptionsTypeDef
  6. See SnowflakeS3BackupModeType
  7. See S3DestinationUpdateTypeDef

SplunkDestinationConfigurationTypeDef#

# SplunkDestinationConfigurationTypeDef 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)
    BufferingHints: NotRequired[SplunkBufferingHintsTypeDef],  # (7)
  1. See HECEndpointTypeType
  2. See SplunkRetryOptionsTypeDef
  3. See SplunkS3BackupModeType
  4. See S3DestinationConfigurationTypeDef
  5. See ProcessingConfigurationTypeDef
  6. See CloudWatchLoggingOptionsTypeDef
  7. See SplunkBufferingHintsTypeDef

SplunkDestinationDescriptionTypeDef#

# SplunkDestinationDescriptionTypeDef 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)
    BufferingHints: NotRequired[SplunkBufferingHintsTypeDef],  # (7)
  1. See HECEndpointTypeType
  2. See SplunkRetryOptionsTypeDef
  3. See SplunkS3BackupModeType
  4. See S3DestinationDescriptionTypeDef
  5. See ProcessingConfigurationTypeDef
  6. See CloudWatchLoggingOptionsTypeDef
  7. See SplunkBufferingHintsTypeDef

SplunkDestinationUpdateTypeDef#

# SplunkDestinationUpdateTypeDef 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)
    BufferingHints: NotRequired[SplunkBufferingHintsTypeDef],  # (7)
  1. See HECEndpointTypeType
  2. See SplunkRetryOptionsTypeDef
  3. See SplunkS3BackupModeType
  4. See S3DestinationUpdateTypeDef
  5. See ProcessingConfigurationTypeDef
  6. See CloudWatchLoggingOptionsTypeDef
  7. See SplunkBufferingHintsTypeDef

ExtendedS3DestinationConfigurationTypeDef#

# ExtendedS3DestinationConfigurationTypeDef 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)
    FileExtension: NotRequired[str],
    CustomTimeZone: NotRequired[str],
  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#

# ExtendedS3DestinationDescriptionTypeDef 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)
    FileExtension: NotRequired[str],
    CustomTimeZone: NotRequired[str],
  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#

# ExtendedS3DestinationUpdateTypeDef 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)
    FileExtension: NotRequired[str],
    CustomTimeZone: NotRequired[str],
  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#

# CreateDeliveryStreamInputRequestTypeDef 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)
    AmazonOpenSearchServerlessDestinationConfiguration: NotRequired[AmazonOpenSearchServerlessDestinationConfigurationTypeDef],  # (12)
    MSKSourceConfiguration: NotRequired[MSKSourceConfigurationTypeDef],  # (13)
    SnowflakeDestinationConfiguration: NotRequired[SnowflakeDestinationConfigurationTypeDef],  # (14)
  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
  12. See AmazonOpenSearchServerlessDestinationConfigurationTypeDef
  13. See MSKSourceConfigurationTypeDef
  14. See SnowflakeDestinationConfigurationTypeDef

DestinationDescriptionTypeDef#

# DestinationDescriptionTypeDef 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)
    SnowflakeDestinationDescription: NotRequired[SnowflakeDestinationDescriptionTypeDef],  # (8)
    AmazonOpenSearchServerlessDestinationDescription: NotRequired[AmazonOpenSearchServerlessDestinationDescriptionTypeDef],  # (9)
  1. See S3DestinationDescriptionTypeDef
  2. See ExtendedS3DestinationDescriptionTypeDef
  3. See RedshiftDestinationDescriptionTypeDef
  4. See ElasticsearchDestinationDescriptionTypeDef
  5. See AmazonopensearchserviceDestinationDescriptionTypeDef
  6. See SplunkDestinationDescriptionTypeDef
  7. See HttpEndpointDestinationDescriptionTypeDef
  8. See SnowflakeDestinationDescriptionTypeDef
  9. See AmazonOpenSearchServerlessDestinationDescriptionTypeDef

UpdateDestinationInputRequestTypeDef#

# UpdateDestinationInputRequestTypeDef 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)
    AmazonOpenSearchServerlessDestinationUpdate: NotRequired[AmazonOpenSearchServerlessDestinationUpdateTypeDef],  # (8)
    SnowflakeDestinationUpdate: NotRequired[SnowflakeDestinationUpdateTypeDef],  # (9)
  1. See S3DestinationUpdateTypeDef
  2. See ExtendedS3DestinationUpdateTypeDef
  3. See RedshiftDestinationUpdateTypeDef
  4. See ElasticsearchDestinationUpdateTypeDef
  5. See AmazonopensearchserviceDestinationUpdateTypeDef
  6. See SplunkDestinationUpdateTypeDef
  7. See HttpEndpointDestinationUpdateTypeDef
  8. See AmazonOpenSearchServerlessDestinationUpdateTypeDef
  9. See SnowflakeDestinationUpdateTypeDef

DeliveryStreamDescriptionTypeDef#

# DeliveryStreamDescriptionTypeDef 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#

# DescribeDeliveryStreamOutputTypeDef definition

class DescribeDeliveryStreamOutputTypeDef(TypedDict):
    DeliveryStreamDescription: DeliveryStreamDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeliveryStreamDescriptionTypeDef
  2. See ResponseMetadataTypeDef