Skip to content

FirehoseClient#

Index > Firehose > FirehoseClient

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

FirehoseClient#

Type annotations and code completion for boto3.client("firehose"). boto3 documentation

# FirehoseClient usage example

from boto3.session import Session
from mypy_boto3_firehose.client import FirehoseClient

def get_firehose_client() -> FirehoseClient:
    return Session().client("firehose")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("firehose").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("firehose")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.ConcurrentModificationException,
    client.exceptions.InvalidArgumentException,
    client.exceptions.InvalidKMSResourceException,
    client.exceptions.InvalidSourceException,
    client.exceptions.LimitExceededException,
    client.exceptions.ResourceInUseException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceUnavailableException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_firehose.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods#

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("firehose").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("firehose").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_delivery_stream#

Creates a Firehose stream.

Type annotations and code completion for boto3.client("firehose").create_delivery_stream method. boto3 documentation

# create_delivery_stream method definition

def create_delivery_stream(
    self,
    *,
    DeliveryStreamName: str,
    DeliveryStreamType: DeliveryStreamTypeType = ...,  # (1)
    KinesisStreamSourceConfiguration: KinesisStreamSourceConfigurationTypeDef = ...,  # (2)
    DeliveryStreamEncryptionConfigurationInput: DeliveryStreamEncryptionConfigurationInputTypeDef = ...,  # (3)
    S3DestinationConfiguration: S3DestinationConfigurationTypeDef = ...,  # (4)
    ExtendedS3DestinationConfiguration: ExtendedS3DestinationConfigurationTypeDef = ...,  # (5)
    RedshiftDestinationConfiguration: RedshiftDestinationConfigurationTypeDef = ...,  # (6)
    ElasticsearchDestinationConfiguration: ElasticsearchDestinationConfigurationTypeDef = ...,  # (7)
    AmazonopensearchserviceDestinationConfiguration: AmazonopensearchserviceDestinationConfigurationTypeDef = ...,  # (8)
    SplunkDestinationConfiguration: SplunkDestinationConfigurationTypeDef = ...,  # (9)
    HttpEndpointDestinationConfiguration: HttpEndpointDestinationConfigurationTypeDef = ...,  # (10)
    Tags: Sequence[TagTypeDef] = ...,  # (11)
    AmazonOpenSearchServerlessDestinationConfiguration: AmazonOpenSearchServerlessDestinationConfigurationTypeDef = ...,  # (12)
    MSKSourceConfiguration: MSKSourceConfigurationTypeDef = ...,  # (13)
    SnowflakeDestinationConfiguration: SnowflakeDestinationConfigurationTypeDef = ...,  # (14)
    IcebergDestinationConfiguration: IcebergDestinationConfigurationTypeDef = ...,  # (15)
    DatabaseSourceConfiguration: DatabaseSourceConfigurationTypeDef = ...,  # (16)
) -> CreateDeliveryStreamOutputTypeDef:  # (17)
    ...
  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
  15. See IcebergDestinationConfigurationTypeDef
  16. See DatabaseSourceConfigurationTypeDef
  17. See CreateDeliveryStreamOutputTypeDef 
# create_delivery_stream method usage example with argument unpacking

kwargs: CreateDeliveryStreamInputRequestTypeDef = {  # (1)
    "DeliveryStreamName": ...,
}

parent.create_delivery_stream(**kwargs)
  1. See CreateDeliveryStreamInputRequestTypeDef

delete_delivery_stream#

Deletes a Firehose stream and its data.

Type annotations and code completion for boto3.client("firehose").delete_delivery_stream method. boto3 documentation

# delete_delivery_stream method definition

def delete_delivery_stream(
    self,
    *,
    DeliveryStreamName: str,
    AllowForceDelete: bool = ...,
) -> Dict[str, Any]:
    ...
# delete_delivery_stream method usage example with argument unpacking

kwargs: DeleteDeliveryStreamInputRequestTypeDef = {  # (1)
    "DeliveryStreamName": ...,
}

parent.delete_delivery_stream(**kwargs)
  1. See DeleteDeliveryStreamInputRequestTypeDef

describe_delivery_stream#

Describes the specified Firehose stream and its status.

Type annotations and code completion for boto3.client("firehose").describe_delivery_stream method. boto3 documentation

# describe_delivery_stream method definition

def describe_delivery_stream(
    self,
    *,
    DeliveryStreamName: str,
    Limit: int = ...,
    ExclusiveStartDestinationId: str = ...,
) -> DescribeDeliveryStreamOutputTypeDef:  # (1)
    ...
  1. See DescribeDeliveryStreamOutputTypeDef 
# describe_delivery_stream method usage example with argument unpacking

kwargs: DescribeDeliveryStreamInputRequestTypeDef = {  # (1)
    "DeliveryStreamName": ...,
}

parent.describe_delivery_stream(**kwargs)
  1. See DescribeDeliveryStreamInputRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("firehose").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

list_delivery_streams#

Lists your Firehose streams in alphabetical order of their names.

Type annotations and code completion for boto3.client("firehose").list_delivery_streams method. boto3 documentation

# list_delivery_streams method definition

def list_delivery_streams(
    self,
    *,
    Limit: int = ...,
    DeliveryStreamType: DeliveryStreamTypeType = ...,  # (1)
    ExclusiveStartDeliveryStreamName: str = ...,
) -> ListDeliveryStreamsOutputTypeDef:  # (2)
    ...
  1. See DeliveryStreamTypeType
  2. See ListDeliveryStreamsOutputTypeDef 
# list_delivery_streams method usage example with argument unpacking

kwargs: ListDeliveryStreamsInputRequestTypeDef = {  # (1)
    "Limit": ...,
}

parent.list_delivery_streams(**kwargs)
  1. See ListDeliveryStreamsInputRequestTypeDef

list_tags_for_delivery_stream#

Lists the tags for the specified Firehose stream.

Type annotations and code completion for boto3.client("firehose").list_tags_for_delivery_stream method. boto3 documentation

# list_tags_for_delivery_stream method definition

def list_tags_for_delivery_stream(
    self,
    *,
    DeliveryStreamName: str,
    ExclusiveStartTagKey: str = ...,
    Limit: int = ...,
) -> ListTagsForDeliveryStreamOutputTypeDef:  # (1)
    ...
  1. See ListTagsForDeliveryStreamOutputTypeDef 
# list_tags_for_delivery_stream method usage example with argument unpacking

kwargs: ListTagsForDeliveryStreamInputRequestTypeDef = {  # (1)
    "DeliveryStreamName": ...,
}

parent.list_tags_for_delivery_stream(**kwargs)
  1. See ListTagsForDeliveryStreamInputRequestTypeDef

put_record#

Writes a single data record into an Firehose stream.

Type annotations and code completion for boto3.client("firehose").put_record method. boto3 documentation

# put_record method definition

def put_record(
    self,
    *,
    DeliveryStreamName: str,
    Record: RecordTypeDef,  # (1)
) -> PutRecordOutputTypeDef:  # (2)
    ...
  1. See RecordTypeDef
  2. See PutRecordOutputTypeDef 
# put_record method usage example with argument unpacking

kwargs: PutRecordInputRequestTypeDef = {  # (1)
    "DeliveryStreamName": ...,
    "Record": ...,
}

parent.put_record(**kwargs)
  1. See PutRecordInputRequestTypeDef

put_record_batch#

Writes multiple data records into a Firehose stream in a single call, which can achieve higher throughput per producer than when writing single records.

Type annotations and code completion for boto3.client("firehose").put_record_batch method. boto3 documentation

# put_record_batch method definition

def put_record_batch(
    self,
    *,
    DeliveryStreamName: str,
    Records: Sequence[RecordTypeDef],  # (1)
) -> PutRecordBatchOutputTypeDef:  # (2)
    ...
  1. See RecordTypeDef
  2. See PutRecordBatchOutputTypeDef 
# put_record_batch method usage example with argument unpacking

kwargs: PutRecordBatchInputRequestTypeDef = {  # (1)
    "DeliveryStreamName": ...,
    "Records": ...,
}

parent.put_record_batch(**kwargs)
  1. See PutRecordBatchInputRequestTypeDef

start_delivery_stream_encryption#

Enables server-side encryption (SSE) for the Firehose stream.

Type annotations and code completion for boto3.client("firehose").start_delivery_stream_encryption method. boto3 documentation

# start_delivery_stream_encryption method definition

def start_delivery_stream_encryption(
    self,
    *,
    DeliveryStreamName: str,
    DeliveryStreamEncryptionConfigurationInput: DeliveryStreamEncryptionConfigurationInputTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See DeliveryStreamEncryptionConfigurationInputTypeDef 
# start_delivery_stream_encryption method usage example with argument unpacking

kwargs: StartDeliveryStreamEncryptionInputRequestTypeDef = {  # (1)
    "DeliveryStreamName": ...,
}

parent.start_delivery_stream_encryption(**kwargs)
  1. See StartDeliveryStreamEncryptionInputRequestTypeDef

stop_delivery_stream_encryption#

Disables server-side encryption (SSE) for the Firehose stream.

Type annotations and code completion for boto3.client("firehose").stop_delivery_stream_encryption method. boto3 documentation

# stop_delivery_stream_encryption method definition

def stop_delivery_stream_encryption(
    self,
    *,
    DeliveryStreamName: str,
) -> Dict[str, Any]:
    ...
# stop_delivery_stream_encryption method usage example with argument unpacking

kwargs: StopDeliveryStreamEncryptionInputRequestTypeDef = {  # (1)
    "DeliveryStreamName": ...,
}

parent.stop_delivery_stream_encryption(**kwargs)
  1. See StopDeliveryStreamEncryptionInputRequestTypeDef

tag_delivery_stream#

Adds or updates tags for the specified Firehose stream.

Type annotations and code completion for boto3.client("firehose").tag_delivery_stream method. boto3 documentation

# tag_delivery_stream method definition

def tag_delivery_stream(
    self,
    *,
    DeliveryStreamName: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef 
# tag_delivery_stream method usage example with argument unpacking

kwargs: TagDeliveryStreamInputRequestTypeDef = {  # (1)
    "DeliveryStreamName": ...,
    "Tags": ...,
}

parent.tag_delivery_stream(**kwargs)
  1. See TagDeliveryStreamInputRequestTypeDef

untag_delivery_stream#

Removes tags from the specified Firehose stream.

Type annotations and code completion for boto3.client("firehose").untag_delivery_stream method. boto3 documentation

# untag_delivery_stream method definition

def untag_delivery_stream(
    self,
    *,
    DeliveryStreamName: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_delivery_stream method usage example with argument unpacking

kwargs: UntagDeliveryStreamInputRequestTypeDef = {  # (1)
    "DeliveryStreamName": ...,
    "TagKeys": ...,
}

parent.untag_delivery_stream(**kwargs)
  1. See UntagDeliveryStreamInputRequestTypeDef

update_destination#

Updates the specified destination of the specified Firehose stream.

Type annotations and code completion for boto3.client("firehose").update_destination method. boto3 documentation

# update_destination method definition

def update_destination(
    self,
    *,
    DeliveryStreamName: str,
    CurrentDeliveryStreamVersionId: str,
    DestinationId: str,
    S3DestinationUpdate: S3DestinationUpdateTypeDef = ...,  # (1)
    ExtendedS3DestinationUpdate: ExtendedS3DestinationUpdateTypeDef = ...,  # (2)
    RedshiftDestinationUpdate: RedshiftDestinationUpdateTypeDef = ...,  # (3)
    ElasticsearchDestinationUpdate: ElasticsearchDestinationUpdateTypeDef = ...,  # (4)
    AmazonopensearchserviceDestinationUpdate: AmazonopensearchserviceDestinationUpdateTypeDef = ...,  # (5)
    SplunkDestinationUpdate: SplunkDestinationUpdateTypeDef = ...,  # (6)
    HttpEndpointDestinationUpdate: HttpEndpointDestinationUpdateTypeDef = ...,  # (7)
    AmazonOpenSearchServerlessDestinationUpdate: AmazonOpenSearchServerlessDestinationUpdateTypeDef = ...,  # (8)
    SnowflakeDestinationUpdate: SnowflakeDestinationUpdateTypeDef = ...,  # (9)
    IcebergDestinationUpdate: IcebergDestinationUpdateTypeDef = ...,  # (10)
) -> Dict[str, Any]:
    ...
  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
  10. See IcebergDestinationUpdateTypeDef 
# update_destination method usage example with argument unpacking

kwargs: UpdateDestinationInputRequestTypeDef = {  # (1)
    "DeliveryStreamName": ...,
    "CurrentDeliveryStreamVersionId": ...,
    "DestinationId": ...,
}

parent.update_destination(**kwargs)
  1. See UpdateDestinationInputRequestTypeDef