List Delivery Streams
firehose_list_delivery_streams | R Documentation |
Lists your delivery streams in alphabetical order of their names¶
Description¶
Lists your delivery streams in alphabetical order of their names.
The number of delivery streams might be too large to return using a
single call to list_delivery_streams
. You can limit the number of
delivery 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 delivery
streams to list, you can request them by calling this operation again
and setting the ExclusiveStartDeliveryStreamName
parameter to the name
of the last delivery stream returned in the last call.
Usage¶
Arguments¶
Limit
The maximum number of delivery streams to list. The default value is 10.
DeliveryStreamType
The delivery stream type. This can be one of the following values:
DirectPut
: Provider applications access the delivery stream directly.KinesisStreamAsSource
: The delivery stream uses a Kinesis data stream as a source.
This parameter is optional. If this parameter is omitted, delivery streams of all types are returned.
ExclusiveStartDeliveryStreamName
The list of delivery streams returned by this call to
list_delivery_streams
will start with the delivery stream whose name comes alphabetically immediately after the name you specify inExclusiveStartDeliveryStreamName
.
Value¶
A list with the following syntax: