Firehose / Client / list_delivery_streams

list_delivery_streams#

Firehose.Client.list_delivery_streams(**kwargs)#

Lists your Firehose streams in alphabetical order of their names.

The number of Firehose streams might be too large to return using a single call to ListDeliveryStreams. You can limit the number of Firehose streams returned, using the Limit parameter. To determine whether there are more delivery streams to list, check the value of HasMoreDeliveryStreams in the output. If there are more Firehose streams to list, you can request them by calling this operation again and setting the ExclusiveStartDeliveryStreamName parameter to the name of the last Firehose stream returned in the last call.

See also: AWS API Documentation

Request Syntax

response = client.list_delivery_streams(
    Limit=123,
    DeliveryStreamType='DirectPut'|'KinesisStreamAsSource'|'MSKAsSource'|'DatabaseAsSource',
    ExclusiveStartDeliveryStreamName='string'
)
Parameters:

  • Limit (integer) – The maximum number of Firehose streams to list. The default value is 10.

  • DeliveryStreamType (string) –

    The Firehose stream type. This can be one of the following values:

    • DirectPut: Provider applications access the Firehose stream directly.

    • KinesisStreamAsSource: The Firehose stream uses a Kinesis data stream as a source.

    This parameter is optional. If this parameter is omitted, Firehose streams of all types are returned.

  • ExclusiveStartDeliveryStreamName (string) – The list of Firehose streams returned by this call to ListDeliveryStreams will start with the Firehose stream whose name comes alphabetically immediately after the name you specify in ExclusiveStartDeliveryStreamName.

Return type:

dict

Returns:

Response Syntax

{
    'DeliveryStreamNames': [
        'string',
    ],
    'HasMoreDeliveryStreams': True|False
}

Response Structure

  • (dict) –

    • DeliveryStreamNames (list) –

      The names of the Firehose streams.

      • (string) –

    • HasMoreDeliveryStreams (boolean) –

      Indicates whether there are more Firehose streams available to list.