ListDeliveryStreamsCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { FirehoseClient, ListDeliveryStreamsCommand } from "@aws-sdk/client-firehose"; // ES Modules import
// const { FirehoseClient, ListDeliveryStreamsCommand } = require("@aws-sdk/client-firehose"); // CommonJS import
const client = new FirehoseClient(config);
const input = { // ListDeliveryStreamsInput
  Limit: Number("int"),
  DeliveryStreamType: "DirectPut" || "KinesisStreamAsSource" || "MSKAsSource" || "DatabaseAsSource",
  ExclusiveStartDeliveryStreamName: "STRING_VALUE",
};
const command = new ListDeliveryStreamsCommand(input);
const response = await client.send(command);
// { // ListDeliveryStreamsOutput
//   DeliveryStreamNames: [ // DeliveryStreamNameList // required
//     "STRING_VALUE",
//   ],
//   HasMoreDeliveryStreams: true || false, // required
// };

ListDeliveryStreamsCommand Input

See ListDeliveryStreamsCommandInput for more details

Parameter
Type
Description
DeliveryStreamType
DeliveryStreamType | undefined

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 | undefined

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.

Limit
number | undefined

The maximum number of Firehose streams to list. The default value is 10.

ListDeliveryStreamsCommand Output

See ListDeliveryStreamsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
DeliveryStreamNames
Required
string[] | undefined

The names of the Firehose streams.

HasMoreDeliveryStreams
Required
boolean | undefined

Indicates whether there are more Firehose streams available to list.

Throws

Name
Fault
Details
FirehoseServiceException
Base exception class for all service exceptions from Firehose service.